usdrt::PhysxSchemaPhysxTriggerAPI

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

Functions

usdrt::PhysxSchemaPhysxTriggerAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "PhysxTriggerAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::PhysxSchemaPhysxTriggerAPI::CreateEnterScriptTypeAttr: See GetEnterScriptTypeAttr() , 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::PhysxSchemaPhysxTriggerAPI::CreateLeaveScriptTypeAttr: See GetLeaveScriptTypeAttr() , 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::PhysxSchemaPhysxTriggerAPI::CreateOnEnterScriptAttr: See GetOnEnterScriptAttr() , 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::PhysxSchemaPhysxTriggerAPI::CreateOnLeaveScriptAttr: See GetOnLeaveScriptAttr() , 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::PhysxSchemaPhysxTriggerAPI::GetEnterScriptTypeAttr: Enter script type. Script file tries to find a file on disc and execute. Script buffer does execute the provided script string directly.
usdrt::PhysxSchemaPhysxTriggerAPI::GetLeaveScriptTypeAttr: Leave script type. Script file tries to find a file on disc and execute. Script buffer does execute the provided script string directly.
usdrt::PhysxSchemaPhysxTriggerAPI::GetOnEnterScriptAttr: Enter script.
usdrt::PhysxSchemaPhysxTriggerAPI::GetOnLeaveScriptAttr: Leave script.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::PhysxSchemaPhysxTriggerAPI::PhysxSchemaPhysxTriggerAPI: Construct a PhysxSchemaPhysxTriggerAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxTriggerAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::PhysxSchemaPhysxTriggerAPI::PhysxSchemaPhysxTriggerAPI: Construct a PhysxSchemaPhysxTriggerAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxTriggerAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::PhysxSchemaPhysxTriggerAPI::operator bool: Boolean operator.
usdrt::PhysxSchemaPhysxTriggerAPI::~PhysxSchemaPhysxTriggerAPI: Destructor.

Variables

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

class PhysxSchemaPhysxTriggerAPI : public usdrt::UsdAPISchemaBase 

PhysX trigger For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in PhysxSchemaTokens. So to set an attribute to the value “rightHanded”, use PhysxSchemaTokens->rightHanded as the value.

Public Functions

inline explicit PhysxSchemaPhysxTriggerAPI(const UsdPrim &prim = UsdPrim()): Construct a PhysxSchemaPhysxTriggerAPI on UsdPrim prim. Equivalent to PhysxSchemaPhysxTriggerAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

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

inline virtual ~PhysxSchemaPhysxTriggerAPI(): 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 GetEnterScriptTypeAttr() const

Enter script type. Script file tries to find a file on disc and execute. Script buffer does execute the provided script string directly.


Declaration	`uniform token physxTrigger:enterScriptType = "scriptFile"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	scriptFile, scriptBuffer

inline UsdAttribute CreateEnterScriptTypeAttr() const: See GetEnterScriptTypeAttr(), 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 UsdAttribute GetLeaveScriptTypeAttr() const

Leave script type. Script file tries to find a file on disc and execute. Script buffer does execute the provided script string directly.


Declaration	`uniform token physxTrigger:leaveScriptType = "scriptFile"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	scriptFile, scriptBuffer

inline UsdAttribute CreateLeaveScriptTypeAttr() const: See GetLeaveScriptTypeAttr(), 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 UsdAttribute GetOnEnterScriptAttr() const

Enter script.


Declaration	`uniform token physxTrigger:onEnterScript`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform

inline UsdAttribute CreateOnEnterScriptAttr() const: See GetOnEnterScriptAttr(), 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 UsdAttribute GetOnLeaveScriptAttr() const

Leave script.


Declaration	`uniform token physxTrigger:onLeaveScript`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform

inline UsdAttribute CreateOnLeaveScriptAttr() const: See GetOnLeaveScriptAttr(), 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.

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

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxTriggerAPI” 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 PhysxSchemaPhysxTriggerAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxTriggerAPI 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.