PhysX camera that follows behind the subject's velocity vector as it moves, which allows the subject to roll and tumble. More...

Inherits UsdAPISchemaBase.

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

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

virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxCameraFollowVelocityAPI ()
	Destructor. 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 PhysxSchemaPhysxCameraFollowVelocityAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxCameraFollowVelocityAPI 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 PhysxSchemaPhysxCameraFollowVelocityAPI	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 velocity vector as it moves, which allows the subject to roll and tumble.

Definition at line 56 of file physxCameraFollowVelocityAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxCameraFollowVelocityAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxCameraFollowVelocityAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxCameraFollowVelocityAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 68 of file physxCameraFollowVelocityAPI.h.

PhysxSchemaPhysxCameraFollowVelocityAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxCameraFollowVelocityAPI on the prim held by schemaObj .

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

Definition at line 76 of file physxCameraFollowVelocityAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxCameraFollowVelocityAPI ( )

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 PhysxSchemaPhysxCameraFollowVelocityAPI Apply ( const UsdPrim & prim )

static

Applies this single-apply API schema to the given prim.

This information is stored by adding "PhysxCameraFollowVelocityAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns: A valid PhysxSchemaPhysxCameraFollowVelocityAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxCameraFollowVelocityAPI 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()

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

static

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

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

*

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.

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 62 of file physxCameraFollowVelocityAPI.h.

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

C:/g/19412595/omni/schema/source/physxSchema/physxCameraFollowVelocityAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation