PhysxSchemaPhysxCameraFollowAPI Class Reference

PhysX camera that follows behind the subject as it moves. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	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...

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 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 bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
	Returns true if this single-apply API schema can be applied to the given prim. More...
static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given prim. More...

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

Protected Member Functions
PHYSXSCHEMA_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

PhysX camera that follows behind the subject as it moves.

Definition at line 57 of file physxCameraFollowAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxCameraFollowAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

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

Definition at line 69 of file physxCameraFollowAPI.h.

PhysxSchemaPhysxCameraFollowAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxCameraFollowAPI on the prim held by schemaObj .

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

Definition at line 77 of file physxCameraFollowAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxCameraFollowAPI ( )

virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotected

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowAPI Apply ( const UsdPrim &  prim )

static

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.

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.

See Also

UsdPrim::GetAppliedSchemas()

UsdPrim::HasAPI()

UsdPrim::CanApplyAPI()

UsdPrim::ApplyAPI()

UsdPrim::RemoveAPI()

static PHYSXSCHEMA_API bool CanApply ( const UsdPrim &  prim, std::string *  whyNot = nullptr  )

static

Returns true if this single-apply API schema can be applied to the given prim.

If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See Also

UsdPrim::GetAppliedSchemas()

UsdPrim::HasAPI()

UsdPrim::CanApplyAPI()

UsdPrim::ApplyAPI()

UsdPrim::RemoveAPI()

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

static PHYSXSCHEMA_API PhysxSchemaPhysxCameraFollowAPI Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a PhysxSchemaPhysxCameraFollowAPI holding the prim adhering to this schema at path on stage.

If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

*  PhysxSchemaPhysxCameraFollowAPI(stage->GetPrimAtPath(path));
*  

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

static PHYSXSCHEMA_API const TfTokenVector& GetSchemaAttributeNames ( bool  includeInherited = true )

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

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.

e.g. 600.0 cm/sec

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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

Member Data Documentation

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also

UsdSchemaKind

Definition at line 63 of file physxCameraFollowAPI.h.

---

The documentation for this class was generated from the following file:

• C:/g/19412595/omni/schema/source/physxSchema/physxCameraFollowAPI.h