usdrt::PhysxSchemaPhysxCameraFollowAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxCameraFollowAPI.h

Functions

usdrt::PhysxSchemaPhysxCameraFollowAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysxCameraFollowAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateCameraPositionTimeConstantAttr: See GetCameraPositionTimeConstantAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateFollowMaxDistanceAttr: See GetFollowMaxDistanceAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateFollowMaxSpeedAttr: See GetFollowMaxSpeedAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateFollowMinDistanceAttr: See GetFollowMinDistanceAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateFollowMinSpeedAttr: See GetFollowMinSpeedAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateFollowTurnRateGainAttr: See GetFollowTurnRateGainAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateLookAheadMaxDistanceAttr: See GetLookAheadMaxDistanceAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateLookAheadMaxSpeedAttr: See GetLookAheadMaxSpeedAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateLookAheadMinDistanceAttr: See GetLookAheadMinDistanceAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateLookAheadMinSpeedAttr: See GetLookAheadMinSpeedAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateLookAheadTurnRateGainAttr: See GetLookAheadTurnRateGainAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateLookPositionHeightAttr: See GetLookPositionHeightAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateLookPositionTimeConstantAttr: See GetLookPositionTimeConstantAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreatePitchAngleAttr: See GetPitchAngleAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreatePitchAngleTimeConstantAttr: See GetPitchAngleTimeConstantAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreatePositionOffsetAttr: See GetPositionOffsetAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateSlowPitchAngleSpeedAttr: See GetSlowPitchAngleSpeedAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateSlowSpeedPitchAngleScaleAttr: See GetSlowSpeedPitchAngleScaleAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateVelocityNormalMinSpeedAttr: See GetVelocityNormalMinSpeedAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateYawAngleAttr: See GetYawAngleAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::CreateYawRateTimeConstantAttr: See GetYawRateTimeConstantAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetCameraPositionTimeConstantAttr: Filter time constant for the position of the camera for each axis, in seconds. e.g. (0.5 sec, 0.1 sec, 0.5 sec)
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetFollowMaxDistanceAttr: The maximum distance used for a linear interpolation to compute the follow distance of the camera. e.g. 1000.0 cm.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetFollowMaxSpeedAttr: The maximum speed used for a linear interpolation to compute the follow distance of the camera. e.g. 3000.0 cm/sec.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetFollowMinDistanceAttr: The minimum distance used for a linear interpolation to compute the follow distance of the camera. e.g. 1500.0 cm.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetFollowMinSpeedAttr: The minimum speed used for a linear interpolation to compute the follow distance of the camera. e.g. 300.0 cm/sec.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetFollowTurnRateGainAttr: A scale factor that multiplies the filtered yaw rate to yaw the camera position behind the subject. Can be any positive or negative number. e.g. 0.2.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetLookAheadMaxDistanceAttr: The maximum distance used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 500.0 cm.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetLookAheadMaxSpeedAttr: The maximum speed used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 2000.0 cm.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetLookAheadMinDistanceAttr: The minimum distance used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 0.0 cm.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetLookAheadMinSpeedAttr: The minimum speed used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 0.0 cm/sec.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetLookAheadTurnRateGainAttr: A scale factor that multiplies the filtered yaw rate to yaw the camera look point left or right. Can be any positive or negative number. e.g. 0.2.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetLookPositionHeightAttr: Distance to elevate the camera look point. e.g. 50.0 cm.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetLookPositionTimeConstantAttr: Filter time constant for the camera look point, in seconds. e.g. (0.2 sec, 0.5 sec, 0.2 sec)
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetPitchAngleAttr: The pitch angle of the follow vector around the subject. Zero is directly behind the subject. e.g. 15 degrees.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetPitchAngleTimeConstantAttr: Time constant to filter the pitch angle, in seconds. Used to pitch the camera up and down when driving up or down hills. e.g. 0.2 seconds.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetPositionOffsetAttr: Position offset from the subject center of mass from which the camera follow vector and look vector are computed. e.g. (0.0 cm, 10.0 cm, 0.0 cm)
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetSlowPitchAngleSpeedAttr: Scale of the camera pitch angle at slow speed. This lowers the camera behind the subject at slow speeds. e.g. 1000 cm/sec.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetSlowSpeedPitchAngleScaleAttr: Scale of the camera pitch angle at slow speed. This lowers the camera behind the subject at slow speeds. e.g. 0.5.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetVelocityNormalMinSpeedAttr: The minimum speed, below which, the subject look vector must be used because the normalized velocity vector is too erratic. e.g. 600.0 cm/sec.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetYawAngleAttr: The yaw angle of the follow vector around the subject. Zero is directly behind the subject. e.g. 0 degrees.
usdrt::PhysxSchemaPhysxCameraFollowAPI::GetYawRateTimeConstantAttr: Time constant to filter the subject yaw rate, in seconds. Use to look into turns. e.g. 0.2 sec.
usdrt::PhysxSchemaPhysxCameraFollowAPI::PhysxSchemaPhysxCameraFollowAPI: Construct a PhysxSchemaPhysxCameraFollowAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxCameraFollowAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::PhysxSchemaPhysxCameraFollowAPI::PhysxSchemaPhysxCameraFollowAPI: Construct a PhysxSchemaPhysxCameraFollowAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxCameraFollowAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxCameraFollowAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxCameraFollowAPI::~PhysxSchemaPhysxCameraFollowAPI: Destructor.

Variables

usdrt::PhysxSchemaPhysxCameraFollowAPI::schemaType: Compile time constant representing what kind of schema this class is.

class PhysxSchemaPhysxCameraFollowAPI : public usdrt::UsdAPISchemaBase 

PhysX camera that follows behind the subject as it moves.

Public Functions

inline explicit PhysxSchemaPhysxCameraFollowAPI(const UsdPrim &prim = UsdPrim()): Construct a PhysxSchemaPhysxCameraFollowAPI on UsdPrim prim. Equivalent to PhysxSchemaPhysxCameraFollowAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxCameraFollowAPI(const UsdSchemaBase &schemaObj): Construct a PhysxSchemaPhysxCameraFollowAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxCameraFollowAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxCameraFollowAPI(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline UsdAttribute GetYawAngleAttr() const

The yaw angle of the follow vector around the subject. Zero is directly behind the subject. e.g. 0 degrees.


Declaration	`float physxFollowCamera:yawAngle`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateYawAngleAttr() const: See GetYawAngleAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetPitchAngleAttr() const

The pitch angle of the follow vector around the subject. Zero is directly behind the subject. e.g. 15 degrees.


Declaration	`float physxFollowCamera:pitchAngle`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreatePitchAngleAttr() const: See GetPitchAngleAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetPitchAngleTimeConstantAttr() const

Time constant to filter the pitch angle, in seconds. Used to pitch the camera up and down when driving up or down hills. e.g. 0.2 seconds.


Declaration	`float physxFollowCamera:pitchAngleTimeConstant`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreatePitchAngleTimeConstantAttr() const: See GetPitchAngleTimeConstantAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetSlowSpeedPitchAngleScaleAttr() const

Scale of the camera pitch angle at slow speed. This lowers the camera behind the subject at slow speeds. e.g. 0.5.


Declaration	`float physxFollowCamera:slowSpeedPitchAngleScale`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateSlowSpeedPitchAngleScaleAttr() const: See GetSlowSpeedPitchAngleScaleAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetSlowPitchAngleSpeedAttr() const

Scale of the camera pitch angle at slow speed. This lowers the camera behind the subject at slow speeds. e.g. 1000 cm/sec.


Declaration	`float physxFollowCamera:slowPitchAngleSpeed`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateSlowPitchAngleSpeedAttr() const: See GetSlowPitchAngleSpeedAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetVelocityNormalMinSpeedAttr() const

The minimum speed, below which, the subject look vector must be used because the normalized velocity vector is too erratic. e.g. 600.0 cm/sec.


Declaration	`float physxFollowCamera:velocityNormalMinSpeed`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateVelocityNormalMinSpeedAttr() const: See GetVelocityNormalMinSpeedAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetFollowMinSpeedAttr() const

The minimum speed used for a linear interpolation to compute the follow distance of the camera. e.g. 300.0 cm/sec.


Declaration	`float physxFollowCamera:followMinSpeed`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateFollowMinSpeedAttr() const: See GetFollowMinSpeedAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetFollowMinDistanceAttr() const

The minimum distance used for a linear interpolation to compute the follow distance of the camera. e.g. 1500.0 cm.


Declaration	`float physxFollowCamera:followMinDistance`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateFollowMinDistanceAttr() const: See GetFollowMinDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetFollowMaxSpeedAttr() const

The maximum speed used for a linear interpolation to compute the follow distance of the camera. e.g. 3000.0 cm/sec.


Declaration	`float physxFollowCamera:followMaxSpeed`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateFollowMaxSpeedAttr() const: See GetFollowMaxSpeedAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetFollowMaxDistanceAttr() const

The maximum distance used for a linear interpolation to compute the follow distance of the camera. e.g. 1000.0 cm.


Declaration	`float physxFollowCamera:followMaxDistance`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateFollowMaxDistanceAttr() const: See GetFollowMaxDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetYawRateTimeConstantAttr() const

Time constant to filter the subject yaw rate, in seconds. Use to look into turns. e.g. 0.2 sec.


Declaration	`float physxFollowCamera:yawRateTimeConstant`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateYawRateTimeConstantAttr() const: See GetYawRateTimeConstantAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetFollowTurnRateGainAttr() const

A scale factor that multiplies the filtered yaw rate to yaw the camera position behind the subject. Can be any positive or negative number. e.g. 0.2.


Declaration	`float physxFollowCamera:followTurnRateGain`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateFollowTurnRateGainAttr() const: See GetFollowTurnRateGainAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetCameraPositionTimeConstantAttr() const

Filter time constant for the position of the camera for each axis, in seconds. e.g. (0.5 sec, 0.1 sec, 0.5 sec)


Declaration	`float3 physxFollowCamera:cameraPositionTimeConstant`
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Float3

inline UsdAttribute CreateCameraPositionTimeConstantAttr() const: See GetCameraPositionTimeConstantAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetPositionOffsetAttr() const

Position offset from the subject center of mass from which the camera follow vector and look vector are computed. e.g. (0.0 cm, 10.0 cm, 0.0 cm)


Declaration	`float3 physxFollowCamera:positionOffset`
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Float3

inline UsdAttribute CreatePositionOffsetAttr() const: See GetPositionOffsetAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetLookAheadMinSpeedAttr() const

The minimum speed used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 0.0 cm/sec.


Declaration	`float physxFollowCamera:lookAheadMinSpeed`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateLookAheadMinSpeedAttr() const: See GetLookAheadMinSpeedAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetLookAheadMinDistanceAttr() const

The minimum distance used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 0.0 cm.


Declaration	`float physxFollowCamera:lookAheadMinDistance`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateLookAheadMinDistanceAttr() const: See GetLookAheadMinDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetLookAheadMaxSpeedAttr() const

The maximum speed used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 2000.0 cm.


Declaration	`float physxFollowCamera:lookAheadMaxSpeed`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateLookAheadMaxSpeedAttr() const: See GetLookAheadMaxSpeedAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetLookAheadMaxDistanceAttr() const

The maximum distance used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 500.0 cm.


Declaration	`float physxFollowFollowCamera:lookAheadMaxDistance`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateLookAheadMaxDistanceAttr() const: See GetLookAheadMaxDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetLookAheadTurnRateGainAttr() const

A scale factor that multiplies the filtered yaw rate to yaw the camera look point left or right. Can be any positive or negative number. e.g. 0.2.


Declaration	`float physxFollowCamera:lookAheadTurnRateGain`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateLookAheadTurnRateGainAttr() const: See GetLookAheadTurnRateGainAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetLookPositionHeightAttr() const

Distance to elevate the camera look point. e.g. 50.0 cm.


Declaration	`float physxFollowCamera:lookPositionHeight`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateLookPositionHeightAttr() const: See GetLookPositionHeightAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetLookPositionTimeConstantAttr() const

Filter time constant for the camera look point, in seconds. e.g. (0.2 sec, 0.5 sec, 0.2 sec)


Declaration	`float3 physxFollowCamera:lookPositionTimeConstant`
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Float3

inline UsdAttribute CreateLookPositionTimeConstantAttr() const: See GetLookPositionTimeConstantAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline PhysxSchemaPhysxCameraFollowAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxCameraFollowAPI” to the token-valued, listOp metadata apiSchemas on the prim.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns: A valid PhysxSchemaPhysxCameraFollowAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxCameraFollowAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI 

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.