PhysX camera that follows behind the subject's forward vector as it moves. More...

Inheritance diagram for PhysxSchemaPhysxCameraFollowLookAPI:

Public Member Functions
	PhysxSchemaPhysxCameraFollowLookAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxCameraFollowLookAPI on UsdPrim `prim` . More...

	PhysxSchemaPhysxCameraFollowLookAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxCameraFollowLookAPI on the prim held by `schemaObj` . More...

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxCameraFollowLookAPI ()
	Destructor. More...

PHYSXSCHEMA_API UsdAttribute	GetDownHillGroundAngleAttr () const
	The minimum pitch angle of the terrain used for a linear interpolation to adjust the pitch of the camera. More...

PHYSXSCHEMA_API UsdAttribute	CreateDownHillGroundAngleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDownHillGroundAngleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetDownHillGroundPitchAttr () const
	The minimum pitch angle of the camera used for a linear interpolation to adjust the pitch of the camera. More...

PHYSXSCHEMA_API UsdAttribute	CreateDownHillGroundPitchAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDownHillGroundPitchAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetUpHillGroundAngleAttr () const
	The maximum pitch angle of the terrain used for a linear interpolation to adjust the pitch of the camera. More...

PHYSXSCHEMA_API UsdAttribute	CreateUpHillGroundAngleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetUpHillGroundAngleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetUpHillGroundPitchAttr () const
	The maximum pitch angle of the camera used for a linear interpolation to adjust the pitch of the camera. More...

PHYSXSCHEMA_API UsdAttribute	CreateUpHillGroundPitchAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetUpHillGroundPitchAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetVelocityBlendTimeConstantAttr () const
	Filter time constant to blend between the look and velocity vectors, in seconds. More...

PHYSXSCHEMA_API UsdAttribute	CreateVelocityBlendTimeConstantAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetVelocityBlendTimeConstantAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetFollowReverseSpeedAttr () const
	The positive, maximum speed, when driving in reverse, used for a linear interpolation to compute the follow distance of the camera. More...

PHYSXSCHEMA_API UsdAttribute	CreateFollowReverseSpeedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFollowReverseSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetFollowReverseDistanceAttr () const
	The maximum distance, when driving in reverse, used for a linear interpolation to compute the follow distance of the camera. More...

PHYSXSCHEMA_API UsdAttribute	CreateFollowReverseDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFollowReverseDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Public Member Functions inherited from PhysxSchemaPhysxCameraFollowAPI
	PhysxSchemaPhysxCameraFollowAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxCameraFollowAPI on UsdPrim `prim` . More...

	PhysxSchemaPhysxCameraFollowAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxCameraFollowAPI on the prim held by `schemaObj` . More...

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxCameraFollowAPI ()
	Destructor. More...

PHYSXSCHEMA_API UsdAttribute	GetYawAngleAttr () const
	The yaw angle of the follow vector around the subject. More...

PHYSXSCHEMA_API UsdAttribute	CreateYawAngleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetYawAngleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetPitchAngleAttr () const
	The pitch angle of the follow vector around the subject. More...

PHYSXSCHEMA_API UsdAttribute	CreatePitchAngleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPitchAngleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetPitchAngleTimeConstantAttr () const
	Time constant to filter the pitch angle, in seconds. More...

PHYSXSCHEMA_API UsdAttribute	CreatePitchAngleTimeConstantAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPitchAngleTimeConstantAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSlowSpeedPitchAngleScaleAttr () const
	Scale of the camera pitch angle at slow speed. More...

PHYSXSCHEMA_API UsdAttribute	CreateSlowSpeedPitchAngleScaleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSlowSpeedPitchAngleScaleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetSlowPitchAngleSpeedAttr () const
	Scale of the camera pitch angle at slow speed. More...

PHYSXSCHEMA_API UsdAttribute	CreateSlowPitchAngleSpeedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSlowPitchAngleSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetVelocityNormalMinSpeedAttr () const
	The minimum speed, below which, the subject look vector must be used because the normalized velocity vector is too erratic. More...

PHYSXSCHEMA_API UsdAttribute	CreateVelocityNormalMinSpeedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetVelocityNormalMinSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetFollowMinSpeedAttr () const
	The minimum speed used for a linear interpolation to compute the follow distance of the camera. More...

PHYSXSCHEMA_API UsdAttribute	CreateFollowMinSpeedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFollowMinSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetFollowMinDistanceAttr () const
	The minimum distance used for a linear interpolation to compute the follow distance of the camera. More...

PHYSXSCHEMA_API UsdAttribute	CreateFollowMinDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFollowMinDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetFollowMaxSpeedAttr () const
	The maximum speed used for a linear interpolation to compute the follow distance of the camera. More...

PHYSXSCHEMA_API UsdAttribute	CreateFollowMaxSpeedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFollowMaxSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetFollowMaxDistanceAttr () const
	The maximum distance used for a linear interpolation to compute the follow distance of the camera. More...

PHYSXSCHEMA_API UsdAttribute	CreateFollowMaxDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFollowMaxDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetYawRateTimeConstantAttr () const
	Time constant to filter the subject yaw rate, in seconds. More...

PHYSXSCHEMA_API UsdAttribute	CreateYawRateTimeConstantAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetYawRateTimeConstantAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetFollowTurnRateGainAttr () const
	A scale factor that multiplies the filtered yaw rate to yaw the camera position behind the subject. More...

PHYSXSCHEMA_API UsdAttribute	CreateFollowTurnRateGainAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetFollowTurnRateGainAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetCameraPositionTimeConstantAttr () const
	Filter time constant for the position of the camera for each axis, in seconds. More...

PHYSXSCHEMA_API UsdAttribute	CreateCameraPositionTimeConstantAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCameraPositionTimeConstantAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetPositionOffsetAttr () const
	Position offset from the subject center of mass from which the camera follow vector and look vector are computed. More...

PHYSXSCHEMA_API UsdAttribute	CreatePositionOffsetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPositionOffsetAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetLookAheadMinSpeedAttr () const
	The minimum speed used for a linear interpolation to compute the look ahead distance of the camera look point. More...

PHYSXSCHEMA_API UsdAttribute	CreateLookAheadMinSpeedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLookAheadMinSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetLookAheadMinDistanceAttr () const
	The minimum distance used for a linear interpolation to compute the look ahead distance of the camera look point. More...

PHYSXSCHEMA_API UsdAttribute	CreateLookAheadMinDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLookAheadMinDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetLookAheadMaxSpeedAttr () const
	The maximum speed used for a linear interpolation to compute the look ahead distance of the camera look point. More...

PHYSXSCHEMA_API UsdAttribute	CreateLookAheadMaxSpeedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLookAheadMaxSpeedAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetLookAheadMaxDistanceAttr () const
	The maximum distance used for a linear interpolation to compute the look ahead distance of the camera look point. More...

PHYSXSCHEMA_API UsdAttribute	CreateLookAheadMaxDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLookAheadMaxDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetLookAheadTurnRateGainAttr () const
	A scale factor that multiplies the filtered yaw rate to yaw the camera look point left or right. More...

PHYSXSCHEMA_API UsdAttribute	CreateLookAheadTurnRateGainAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLookAheadTurnRateGainAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetLookPositionHeightAttr () const
	Distance to elevate the camera look point. More...

PHYSXSCHEMA_API UsdAttribute	CreateLookPositionHeightAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLookPositionHeightAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

PHYSXSCHEMA_API UsdAttribute	GetLookPositionTimeConstantAttr () const
	Filter time constant for the camera look point, in seconds. More...

PHYSXSCHEMA_API UsdAttribute	CreateLookPositionTimeConstantAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLookPositionTimeConstantAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Public Member Functions inherited from PhysxSchemaPhysxCameraAPI
	PhysxSchemaPhysxCameraAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxCameraAPI on UsdPrim `prim` . More...

	PhysxSchemaPhysxCameraAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxCameraAPI on the prim held by `schemaObj` . More...

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxCameraAPI ()
	Destructor. More...

PHYSXSCHEMA_API UsdRelationship	GetPhysxCameraSubjectRel () const
	Reference to the subject this camera is to track. More...

PHYSXSCHEMA_API UsdRelationship	CreatePhysxCameraSubjectRel () const
	See GetPhysxCameraSubjectRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Static Public Member Functions
static PHYSXSCHEMA_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowLookAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxCameraFollowLookAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowLookAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

Static Public Member Functions inherited from PhysxSchemaPhysxCameraFollowAPI
static PHYSXSCHEMA_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxCameraFollowAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

Static Public Member Functions inherited from PhysxSchemaPhysxCameraAPI
static PHYSXSCHEMA_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxCameraAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxCameraAPI holding the prim adhering to this schema at `path` on `stage`. More...

static PHYSXSCHEMA_API PhysxSchemaPhysxCameraAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`. More...

Static Public Attributes
static const UsdSchemaType	schemaType = UsdSchemaType::SingleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Static Public Attributes inherited from PhysxSchemaPhysxCameraFollowAPI
static const UsdSchemaType	schemaType = UsdSchemaType::SingleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Static Public Attributes inherited from PhysxSchemaPhysxCameraAPI
static const UsdSchemaType	schemaType = UsdSchemaType::SingleApplyAPI
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
PHYSXSCHEMA_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Protected Member Functions inherited from PhysxSchemaPhysxCameraFollowAPI
PHYSXSCHEMA_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Protected Member Functions inherited from PhysxSchemaPhysxCameraAPI
PHYSXSCHEMA_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

PhysX camera that follows behind the subject's forward vector as it moves.

Assumes the subject is always upright and does not roll.

Definition at line 57 of file physxCameraFollowLookAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxCameraFollowLookAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

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

Definition at line 69 of file physxCameraFollowLookAPI.h.

PhysxSchemaPhysxCameraFollowLookAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxCameraFollowLookAPI on the prim held by schemaObj .

Should be preferred over PhysxSchemaPhysxCameraFollowLookAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 77 of file physxCameraFollowLookAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxCameraFollowLookAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType ( ) const

overrideprotected

Returns the type of schema this class belongs to.

See Also: UsdSchemaType

static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowLookAPI Apply ( const UsdPrim & prim )

static

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.

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.

See Also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

PHYSXSCHEMA_API UsdAttribute CreateDownHillGroundAngleAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetDownHillGroundAngleAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create.