PhysxSchemaPhysxCharacterControllerAPI Class Reference

PhysxCharacterControllerAPI can be applied to a capsuleGeom. More...

Inherits UsdAPISchemaBase.

Public Member Functions
	PhysxSchemaPhysxCharacterControllerAPI (const UsdPrim &prim=UsdPrim())
	Construct a PhysxSchemaPhysxCharacterControllerAPI on UsdPrim prim . More...
	PhysxSchemaPhysxCharacterControllerAPI (const UsdSchemaBase &schemaObj)
	Construct a PhysxSchemaPhysxCharacterControllerAPI on the prim held by schemaObj . More...
virtual PHYSXSCHEMA_API	~PhysxSchemaPhysxCharacterControllerAPI ()
	Destructor. More...
PHYSXSCHEMA_API UsdAttribute	GetSlopeLimitAttr () const
	Slope limit which the CCT can climb. More...
PHYSXSCHEMA_API UsdAttribute	CreateSlopeLimitAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSlopeLimitAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMoveTargetAttr () const
	Desired target position that CCT should try to reach. More...
PHYSXSCHEMA_API UsdAttribute	CreateMoveTargetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMoveTargetAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetUpAxisAttr () const
	Up axis for stepping functionality. 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	GetNonWalkableModeAttr () const
	The non-walkable mode controls if a character controller slides or not on a non-walkable part. More...
PHYSXSCHEMA_API UsdAttribute	CreateNonWalkableModeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetNonWalkableModeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetClimbingModeAttr () const
	The climbing mode. More...
PHYSXSCHEMA_API UsdAttribute	CreateClimbingModeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetClimbingModeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetInvisibleWallHeightAttr () const
	Height of invisible walls created around non-walkable triangles. More...
PHYSXSCHEMA_API UsdAttribute	CreateInvisibleWallHeightAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetInvisibleWallHeightAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetMaxJumpHeightAttr () const
	Maximum height a jumping character can reach. More...
PHYSXSCHEMA_API UsdAttribute	CreateMaxJumpHeightAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetMaxJumpHeightAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetContactOffsetAttr () const
	The contact offset used by the controller. More...
PHYSXSCHEMA_API UsdAttribute	CreateContactOffsetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetContactOffsetAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetStepOffsetAttr () const
	Defines the maximum height of an obstacle which the character can climb. More...
PHYSXSCHEMA_API UsdAttribute	CreateStepOffsetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetStepOffsetAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetScaleCoeffAttr () const
	Scale coefficient for underlying kinematic actor. More...
PHYSXSCHEMA_API UsdAttribute	CreateScaleCoeffAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetScaleCoeffAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdAttribute	GetVolumeGrowthAttr () const
	Cached volume growth. More...
PHYSXSCHEMA_API UsdAttribute	CreateVolumeGrowthAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetVolumeGrowthAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
PHYSXSCHEMA_API UsdRelationship	GetSimulationOwnerRel () const
	Single PhysicsScene that simulates this character controller. More...
PHYSXSCHEMA_API UsdRelationship	CreateSimulationOwnerRel () const
	See GetSimulationOwnerRel(), 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 PhysxSchemaPhysxCharacterControllerAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a PhysxSchemaPhysxCharacterControllerAPI 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 PhysxSchemaPhysxCharacterControllerAPI	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

PhysxCharacterControllerAPI can be applied to a capsuleGeom.

It will turn the capsule into a character controller.

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

Constructor & Destructor Documentation

PhysxSchemaPhysxCharacterControllerAPI ( const UsdPrim &  prim = UsdPrim() )

inlineexplicit

Construct a PhysxSchemaPhysxCharacterControllerAPI on UsdPrim prim .

Equivalent to PhysxSchemaPhysxCharacterControllerAPI::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 physxCharacterControllerAPI.h.

PhysxSchemaPhysxCharacterControllerAPI ( const UsdSchemaBase &  schemaObj )

inlineexplicit

Construct a PhysxSchemaPhysxCharacterControllerAPI on the prim held by schemaObj .

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

Definition at line 82 of file physxCharacterControllerAPI.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaPhysxCharacterControllerAPI ( )

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

static

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

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

Returns

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

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

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

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

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

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

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

See GetScaleCoeffAttr(), 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 CreateSimulationOwnerRel

(

)

const

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

PHYSXSCHEMA_API UsdAttribute CreateSlopeLimitAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

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

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

See GetVolumeGrowthAttr(), 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 PhysxSchemaPhysxCharacterControllerAPI Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

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

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

PHYSXSCHEMA_API UsdAttribute GetClimbingModeAttr

(

)

const

The climbing mode.

Declaration	uniform token physxCharacterController:climbingMode = "easy"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	easy, constrained

PHYSXSCHEMA_API UsdAttribute GetContactOffsetAttr

(

)

const

The contact offset used by the controller.

Range: [0, inf) Units: distance

Declaration	float physxCharacterController:contactOffset = 0.1
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetInvisibleWallHeightAttr

(

)

const

Height of invisible walls created around non-walkable triangles.

Range: [0, inf) Units: distance

Declaration	float physxCharacterController:invisibleWallHeight = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetMaxJumpHeightAttr

(

)

const

Maximum height a jumping character can reach.

Range: [0, inf) Units: distance

Declaration	float physxCharacterController:maxJumpHeight = 0
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetMoveTargetAttr

(

)

const

Desired target position that CCT should try to reach.

Declaration	vector3f physxCharacterController:moveTarget = (0, 0, 0)
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Vector3f

PHYSXSCHEMA_API UsdAttribute GetNonWalkableModeAttr

(

)

const

The non-walkable mode controls if a character controller slides or not on a non-walkable part.

Declaration	uniform token physxCharacterController:nonWalkableMode = "preventClimbing"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	preventClimbing, preventClimbingForceSliding

PHYSXSCHEMA_API UsdAttribute GetScaleCoeffAttr

(

)

const

Scale coefficient for underlying kinematic actor.

Range: [0, inf) Units: dimensionless

Declaration	float physxCharacterController:scaleCoeff = 0.8
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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 UsdRelationship GetSimulationOwnerRel

(

)

const

Single PhysicsScene that simulates this character controller.

By default, this is the first PhysicsScene found in the stage using UsdStage::Traverse().

PHYSXSCHEMA_API UsdAttribute GetSlopeLimitAttr

(

)

const

Slope limit which the CCT can climb.

The limit is expressed as the cosine of the desired limit angle. A value of 0 disables this feature.

Declaration	float physxCharacterController:slopeLimit = 0.3
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetStepOffsetAttr

(

)

const

Defines the maximum height of an obstacle which the character can climb.

Range: [0, inf) Units: distance

Declaration	float physxCharacterController:stepOffset = 0.5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

PHYSXSCHEMA_API UsdAttribute GetUpAxisAttr

(

)

const

Up axis for stepping functionality.

Declaration	uniform token physxCharacterController:upAxis = "Z"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	X, Y, Z

PHYSXSCHEMA_API UsdAttribute GetVolumeGrowthAttr

(

)

const

Cached volume growth.

Range: [0, inf) Units: dimensionless

Declaration	float physxCharacterController:volumeGrowth = 1.5
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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

---

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

• C:/g/19412595/omni/schema/source/physxSchema/physxCharacterControllerAPI.h