All Classes Files Functions Variables Pages
PhysxSchemaPhysxTriggerAPI Class Reference

PhysX trigger. More...

Inherits UsdAPISchemaBase.

Public Member Functions

 PhysxSchemaPhysxTriggerAPI (const UsdPrim &prim=UsdPrim())
 Construct a PhysxSchemaPhysxTriggerAPI on UsdPrim prim . More...
 
 PhysxSchemaPhysxTriggerAPI (const UsdSchemaBase &schemaObj)
 Construct a PhysxSchemaPhysxTriggerAPI on the prim held by schemaObj . More...
 
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxTriggerAPI ()
 Destructor. More...
 
PHYSXSCHEMA_API UsdAttribute GetEnterScriptTypeAttr () const
 Enter script type. More...
 
PHYSXSCHEMA_API UsdAttribute CreateEnterScriptTypeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetEnterScriptTypeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
PHYSXSCHEMA_API UsdAttribute GetLeaveScriptTypeAttr () const
 Leave script type. More...
 
PHYSXSCHEMA_API UsdAttribute CreateLeaveScriptTypeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetLeaveScriptTypeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
PHYSXSCHEMA_API UsdAttribute GetOnEnterScriptAttr () const
 Enter script. More...
 
PHYSXSCHEMA_API UsdAttribute CreateOnEnterScriptAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetOnEnterScriptAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
PHYSXSCHEMA_API UsdAttribute GetOnLeaveScriptAttr () const
 Leave script. More...
 
PHYSXSCHEMA_API UsdAttribute CreateOnLeaveScriptAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetOnLeaveScriptAttr(), 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
PhysxSchemaPhysxTriggerAPI 
Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a PhysxSchemaPhysxTriggerAPI 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
PhysxSchemaPhysxTriggerAPI 
Apply (const UsdPrim &prim)
 Applies this single-apply API schema to the given prim. More...
 
static PHYSXSCHEMA_API bool UnapplyAPISchema (UsdPrim &prim, bool removeAttributes=true)
 

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

Definition at line 62 of file physxTriggerAPI.h.

Constructor & Destructor Documentation

PhysxSchemaPhysxTriggerAPI ( const UsdPrim &  prim = UsdPrim())
inlineexplicit

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

Definition at line 74 of file physxTriggerAPI.h.

PhysxSchemaPhysxTriggerAPI ( const UsdSchemaBase &  schemaObj)
inlineexplicit

Construct a PhysxSchemaPhysxTriggerAPI on the prim held by schemaObj .

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

Definition at line 82 of file physxTriggerAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxTriggerAPI ( )
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 PhysxSchemaPhysxTriggerAPI Apply ( const UsdPrim &  prim)
static

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.

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.
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 CreateEnterScriptTypeAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetEnterScriptTypeAttr(), 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 CreateLeaveScriptTypeAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetLeaveScriptTypeAttr(), 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 CreateOnEnterScriptAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetOnEnterScriptAttr(), 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 CreateOnLeaveScriptAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetOnLeaveScriptAttr(), 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 PhysxSchemaPhysxTriggerAPI Get ( const UsdStagePtr &  stage,
const SdfPath &  path 
)
static

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

* PhysxSchemaPhysxTriggerAPI(stage->GetPrimAtPath(path));
*
PHYSXSCHEMA_API UsdAttribute GetEnterScriptTypeAttr ( ) const

Enter script type.

Script file tries to find a file on disc and execute.

Declaration uniform token physxTrigger:enterScriptType = "scriptFile"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Variability SdfVariabilityUniform
Allowed Values scriptFile
PHYSXSCHEMA_API UsdAttribute GetLeaveScriptTypeAttr ( ) const

Leave script type.

Script file tries to find a file on disc and execute.

Declaration uniform token physxTrigger:leaveScriptType = "scriptFile"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Variability SdfVariabilityUniform
Allowed Values scriptFile
PHYSXSCHEMA_API UsdAttribute GetOnEnterScriptAttr ( ) const

Enter script.

Declaration uniform token physxTrigger:onEnterScript
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Variability SdfVariabilityUniform
PHYSXSCHEMA_API UsdAttribute GetOnLeaveScriptAttr ( ) const

Leave script.

Declaration uniform token physxTrigger:onLeaveScript
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Variability SdfVariabilityUniform
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 68 of file physxTriggerAPI.h.


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