usdrt::PhysxSchemaPhysxCameraFollowLookAPI

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

Functions

usdrt::PhysxSchemaPhysxCameraFollowLookAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysxCameraFollowLookAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::PhysxSchemaPhysxCameraFollowLookAPI::CreateDownHillGroundAngleAttr: See GetDownHillGroundAngleAttr() , 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::PhysxSchemaPhysxCameraFollowLookAPI::CreateDownHillGroundPitchAttr: See GetDownHillGroundPitchAttr() , 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::PhysxSchemaPhysxCameraFollowLookAPI::CreateFollowReverseDistanceAttr: See GetFollowReverseDistanceAttr() , 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::PhysxSchemaPhysxCameraFollowLookAPI::CreateFollowReverseSpeedAttr: See GetFollowReverseSpeedAttr() , 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::PhysxSchemaPhysxCameraFollowLookAPI::CreateUpHillGroundAngleAttr: See GetUpHillGroundAngleAttr() , 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::PhysxSchemaPhysxCameraFollowLookAPI::CreateUpHillGroundPitchAttr: See GetUpHillGroundPitchAttr() , 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::PhysxSchemaPhysxCameraFollowLookAPI::CreateVelocityBlendTimeConstantAttr: See GetVelocityBlendTimeConstantAttr() , 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::PhysxSchemaPhysxCameraFollowLookAPI::GetDownHillGroundAngleAttr: The minimum pitch angle of the terrain used for a linear interpolation to adjust the pitch of the camera. e.g. -45.0 degrees.
usdrt::PhysxSchemaPhysxCameraFollowLookAPI::GetDownHillGroundPitchAttr: The minimum pitch angle of the camera used for a linear interpolation to adjust the pitch of the camera. e.g. 10.0 degrees.
usdrt::PhysxSchemaPhysxCameraFollowLookAPI::GetFollowReverseDistanceAttr: The maximum distance, when driving in reverse, used for a linear interpolation to compute the follow distance of the camera. e.g. 3000.0 cm.
usdrt::PhysxSchemaPhysxCameraFollowLookAPI::GetFollowReverseSpeedAttr: The positive, maximum speed, when driving in reverse, used for a linear interpolation to compute the follow distance of the camera. e.g. 1500.0 cm/sec.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxCameraFollowLookAPI::GetUpHillGroundAngleAttr: The maximum pitch angle of the terrain used for a linear interpolation to adjust the pitch of the camera. e.g. 45.0 degrees.
usdrt::PhysxSchemaPhysxCameraFollowLookAPI::GetUpHillGroundPitchAttr: The maximum pitch angle of the camera used for a linear interpolation to adjust the pitch of the camera. e.g. 10.0 degrees.
usdrt::PhysxSchemaPhysxCameraFollowLookAPI::GetVelocityBlendTimeConstantAttr: Filter time constant to blend between the look and velocity vectors, in seconds. e.g. 0.1 seconds.
usdrt::PhysxSchemaPhysxCameraFollowLookAPI::PhysxSchemaPhysxCameraFollowLookAPI: Construct a PhysxSchemaPhysxCameraFollowLookAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxCameraFollowLookAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::PhysxSchemaPhysxCameraFollowLookAPI::PhysxSchemaPhysxCameraFollowLookAPI: Construct a PhysxSchemaPhysxCameraFollowLookAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxCameraFollowLookAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxCameraFollowLookAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxCameraFollowLookAPI::~PhysxSchemaPhysxCameraFollowLookAPI: Destructor.

Variables

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

class PhysxSchemaPhysxCameraFollowLookAPI : public usdrt::UsdAPISchemaBase 

PhysX camera that follows behind the subject’s forward vector as it moves. Assumes the subject is always upright and does not roll.

Public Functions

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

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

inline virtual ~PhysxSchemaPhysxCameraFollowLookAPI(): 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 GetDownHillGroundAngleAttr() const

The minimum pitch angle of the terrain used for a linear interpolation to adjust the pitch of the camera. e.g. -45.0 degrees.


Declaration	`float physxFollowLookCamera:downHillGroundAngle`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateDownHillGroundAngleAttr() const: See GetDownHillGroundAngleAttr(), 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 GetDownHillGroundPitchAttr() const

The minimum pitch angle of the camera used for a linear interpolation to adjust the pitch of the camera. e.g. 10.0 degrees.


Declaration	`float physxFollowLookCamera:downHillGroundPitch`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateDownHillGroundPitchAttr() const: See GetDownHillGroundPitchAttr(), 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 GetUpHillGroundAngleAttr() const

The maximum pitch angle of the terrain used for a linear interpolation to adjust the pitch of the camera. e.g. 45.0 degrees.


Declaration	`float physxFollowLookCamera:upHillGroundAngle`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateUpHillGroundAngleAttr() const: See GetUpHillGroundAngleAttr(), 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 GetUpHillGroundPitchAttr() const

The maximum pitch angle of the camera used for a linear interpolation to adjust the pitch of the camera. e.g. 10.0 degrees.


Declaration	`float physxFollowLookCamera:upHillGroundPitch`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateUpHillGroundPitchAttr() const: See GetUpHillGroundPitchAttr(), 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 GetVelocityBlendTimeConstantAttr() const

Filter time constant to blend between the look and velocity vectors, in seconds. e.g. 0.1 seconds.


Declaration	`float physxFollowLookCamera:velocityBlendTimeConstant`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateVelocityBlendTimeConstantAttr() const: See GetVelocityBlendTimeConstantAttr(), 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 GetFollowReverseSpeedAttr() const

The positive, maximum speed, when driving in reverse, used for a linear interpolation to compute the follow distance of the camera. e.g. 1500.0 cm/sec.


Declaration	`float physxFollowLookCamera:followReverseSpeed`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateFollowReverseSpeedAttr() const: See GetFollowReverseSpeedAttr(), 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 GetFollowReverseDistanceAttr() const

The maximum distance, when driving in reverse, used for a linear interpolation to compute the follow distance of the camera. e.g. 3000.0 cm.


Declaration	`float physxFollowLookCamera:followReverseDistance`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateFollowReverseDistanceAttr() const: See GetFollowReverseDistanceAttr(), 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 PhysxSchemaPhysxCameraFollowLookAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxCameraFollowLookAPI” 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 PhysxSchemaPhysxCameraFollowLookAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxCameraFollowLookAPI 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.