usdrt::PhysxSchemaPhysxCameraAPI

Defined in usdrt/scenegraph/usd/physxSchema/physxCameraAPI.h

Functions

usdrt::PhysxSchemaPhysxCameraAPI::Apply: 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.
usdrt::PhysxSchemaPhysxCameraAPI::CreateAlwaysUpdateEnabledAttr: See GetAlwaysUpdateEnabledAttr() , and also Create vs Get Property Methods 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 .
usdrt::PhysxSchemaPhysxCameraAPI::CreatePhysxCameraSubjectRel: See GetPhysxCameraSubjectRel() , and also Create vs Get Property Methods for when to use Get vs Create.
usdrt::PhysxSchemaPhysxCameraAPI::GetAlwaysUpdateEnabledAttr: 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.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::PhysxSchemaPhysxCameraAPI::GetPhysxCameraSubjectRel: Reference to the subject this camera is to track.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxCameraAPI::PhysxSchemaPhysxCameraAPI: Construct a PhysxSchemaPhysxCameraAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxCameraAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::PhysxSchemaPhysxCameraAPI::PhysxSchemaPhysxCameraAPI: 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 .
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxCameraAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxCameraAPI::~PhysxSchemaPhysxCameraAPI: Destructor.

Variables

usdrt::PhysxSchemaPhysxCameraAPI::schemaType: Compile time constant representing what kind of schema this class is.

class PhysxSchemaPhysxCameraAPI : public usdrt::UsdAPISchemaBase 

PhysX camera.

Public Functions

inline explicit PhysxSchemaPhysxCameraAPI(const UsdPrim &prim = UsdPrim()): 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.

inline explicit PhysxSchemaPhysxCameraAPI(const UsdSchemaBase &schemaObj): Construct a PhysxSchemaPhysxCameraAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxCameraAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxCameraAPI(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline 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

inline UsdAttribute CreateAlwaysUpdateEnabledAttr() const: See GetAlwaysUpdateEnabledAttr(), and also Create vs Get Property Methods 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.

inline UsdRelationship GetPhysxCameraSubjectRel() const: Reference to the subject this camera is to track.

inline UsdRelationship CreatePhysxCameraSubjectRel() const: See GetPhysxCameraSubjectRel(), and also Create vs Get Property Methods for when to use Get vs Create.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline PhysxSchemaPhysxCameraAPI Apply(const UsdPrim &prim)

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.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI 

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

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.