PhysX camera. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	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 UsdAttribute	GetAlwaysUpdateEnabledAttr () const
	When enabled, always update this camera whether it is the active camera or not. More...

PHYSXSCHEMA_API UsdAttribute	CreateAlwaysUpdateEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetAlwaysUpdateEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. 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 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 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 PhysxSchemaPhysxCameraAPI	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.

Definition at line 57 of file physxCameraAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxCameraAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxCameraAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxCameraAPI::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 physxCameraAPI.h.

PhysxSchemaPhysxCameraAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxCameraAPI on the prim held by schemaObj .

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

Definition at line 77 of file physxCameraAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxCameraAPI ( )

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

static

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

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

Returns: A valid PhysxSchemaPhysxCameraAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxCameraAPI 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 CreateAlwaysUpdateEnabledAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetAlwaysUpdateEnabledAttr(), 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 UsdRelationship CreatePhysxCameraSubjectRel ( ) const

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

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

static

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

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

*

PHYSXSCHEMA_API UsdAttribute GetAlwaysUpdateEnabledAttr ( ) const

When enabled, always update this camera whether it is the active camera or not.

This prevents cameras from slewing into position when switching to a new active camera. When disabled, only the active camera is updated, saving time.


Declaration	`bool alwaysUpdateEnabled = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

PHYSXSCHEMA_API UsdRelationship GetPhysxCameraSubjectRel ( ) const

Reference to the subject this camera is to track.

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 63 of file physxCameraAPI.h.

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

C:/g/19412595/omni/schema/source/physxSchema/physxCameraAPI.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