All Classes Files Functions Variables Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
PhysxSchemaPhysxVehicleContextAPI Class Reference

PhysX vehicles general settings. More...

Inherits UsdAPISchemaBase.

Public Member Functions

 PhysxSchemaPhysxVehicleContextAPI (const UsdPrim &prim=UsdPrim())
 Construct a PhysxSchemaPhysxVehicleContextAPI on UsdPrim prim . More...
 
 PhysxSchemaPhysxVehicleContextAPI (const UsdSchemaBase &schemaObj)
 Construct a PhysxSchemaPhysxVehicleContextAPI on the prim held by schemaObj . More...
 
virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleContextAPI ()
 Destructor. More...
 
PHYSXSCHEMA_API UsdAttribute GetUpdateModeAttr () const
 The dynamics of the vehicle simulation can get applied to the PhysX rigid body by either applying an acceleration or by using a velocity delta. More...
 
PHYSXSCHEMA_API UsdAttribute CreateUpdateModeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetUpdateModeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
PHYSXSCHEMA_API UsdAttribute GetUpAxisAttr () const
 Deprecated. More...
 
PHYSXSCHEMA_API UsdAttribute CreateUpAxisAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetUpAxisAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
PHYSXSCHEMA_API UsdAttribute GetForwardAxisAttr () const
 Deprecated. More...
 
PHYSXSCHEMA_API UsdAttribute CreateForwardAxisAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetForwardAxisAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
PHYSXSCHEMA_API UsdAttribute GetVerticalAxisAttr () const
 The axis defining the general up direction to use for vehicles. More...
 
PHYSXSCHEMA_API UsdAttribute CreateVerticalAxisAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetVerticalAxisAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 
PHYSXSCHEMA_API UsdAttribute GetLongitudinalAxisAttr () const
 The axis defining the general forward direction to use for vehicles. More...
 
PHYSXSCHEMA_API UsdAttribute CreateLongitudinalAxisAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetLongitudinalAxisAttr(), 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
PhysxSchemaPhysxVehicleContextAPI 		Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a PhysxSchemaPhysxVehicleContextAPI holding the prim adhering to this schema at path on stage. More...
 
static PHYSXSCHEMA_API
PhysxSchemaPhysxVehicleContextAPI 		Apply (const UsdPrim &prim)
 Applies this single-apply API schema to the given prim. More...
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType () const override
 Returns the type of schema this class belongs to. More...
 

Friends

class UsdSchemaRegistry
 

Detailed Description

PhysX vehicles general settings.

Has to be applied to a PhysicsScene prim.

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

Constructor & Destructor Documentation

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

Construct a PhysxSchemaPhysxVehicleContextAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxVehicleContextAPI::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 physxVehicleContextAPI.h.

PhysxSchemaPhysxVehicleContextAPI ( const UsdSchemaBase &  schemaObj)
inlineexplicit

Construct a PhysxSchemaPhysxVehicleContextAPI on the prim held by schemaObj .

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

Definition at line 82 of file physxVehicleContextAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxVehicleContextAPI ( )
virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType ( ) const
overrideprotected

Returns the type of schema this class belongs to.

See Also
UsdSchemaType
static PHYSXSCHEMA_API PhysxSchemaPhysxVehicleContextAPI Apply ( const UsdPrim &  prim)
static

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

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

Returns
A valid PhysxSchemaPhysxVehicleContextAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxVehicleContextAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
PHYSXSCHEMA_API UsdAttribute CreateForwardAxisAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

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

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

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

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

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

* PhysxSchemaPhysxVehicleContextAPI(stage->GetPrimAtPath(path));
*
PHYSXSCHEMA_API UsdAttribute GetForwardAxisAttr ( ) const

Deprecated.

Please use longitudinalAxis instead.

The normalized vector defining the general forward direction to use for vehicles. Has to match one of the base axes (1,0,0), (0,1,0) etc. Arbitrary axes are not supported.

Note: will be ignored if longitudinalAxis is used.

Declaration float3 physxVehicleContext:forwardAxis
C++ Type GfVec3f
Usd Type SdfValueTypeNames->Float3
PHYSXSCHEMA_API UsdAttribute GetLongitudinalAxisAttr ( ) const

The axis defining the general forward direction to use for vehicles.

Note: the "undefined" token value is only a valid option for indicating that the deprecated attribute forwardAxis should be used instead. Else, a valid axis has to be chosen.

Declaration uniform token physxVehicleContext:longitudinalAxis = "undefined"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Variability SdfVariabilityUniform
Allowed Values posX, negX, posY, negY, posZ, negZ, undefined
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.

PHYSXSCHEMA_API UsdAttribute GetUpAxisAttr ( ) const

Deprecated.

Please use verticalAxis instead.

The normalized vector defining the general up direction to use for vehicles. Has to match one of the base axes (1,0,0), (0,1,0) etc. Arbitrary axes are not supported.

Note: will be ignored if verticalAxis is used.

Declaration float3 physxVehicleContext:upAxis
C++ Type GfVec3f
Usd Type SdfValueTypeNames->Float3
PHYSXSCHEMA_API UsdAttribute GetUpdateModeAttr ( ) const

The dynamics of the vehicle simulation can get applied to the PhysX rigid body by either applying an acceleration or by using a velocity delta.

Declaration uniform token physxVehicleContext:updateMode = "velocityChange"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Variability SdfVariabilityUniform
Allowed Values velocityChange, acceleration
PHYSXSCHEMA_API UsdAttribute GetVerticalAxisAttr ( ) const

The axis defining the general up direction to use for vehicles.

Note: the "undefined" token value is only a valid option for indicating that the deprecated attribute upAxis should be used instead. Else, a valid axis has to be chosen.

Declaration uniform token physxVehicleContext:verticalAxis = "undefined"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Variability SdfVariabilityUniform
Allowed Values posX, negX, posY, negY, posZ, negZ, undefined

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
static

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

See Also
UsdSchemaType

Definition at line 68 of file physxVehicleContextAPI.h.

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