PhysxSchemaPhysxCameraFollowLookAPI Class Reference

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

Inherits UsdAPISchemaBase.

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...

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 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 PhysxSchemaPhysxCameraFollowLookAPI	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'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 UsdSchemaKind _GetSchemaKind ( ) const

overrideprotected

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

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::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 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.

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 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.

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 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.

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 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.

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 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.

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 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.

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 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.

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 PhysxSchemaPhysxCameraFollowLookAPI Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a PhysxSchemaPhysxCameraFollowLookAPI 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:

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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

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.

e.g. 3000.0 cm

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

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.

e.g. 1500.0 cm/sec

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

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 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

PHYSXSCHEMA_API 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

PHYSXSCHEMA_API 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

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 physxCameraFollowLookAPI.h.

---

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

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