usdrt::PhysxSchemaPhysxCharacterControllerAPI

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

Functions

Variables

class PhysxSchemaPhysxCharacterControllerAPI : public usdrt::UsdAPISchemaBase

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.

Public Functions

inline explicit PhysxSchemaPhysxCharacterControllerAPI(const UsdPrim &prim = UsdPrim())

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.

inline explicit PhysxSchemaPhysxCharacterControllerAPI(const UsdSchemaBase &schemaObj)

Construct a PhysxSchemaPhysxCharacterControllerAPI on the prim held by schemaObj . Should be preferred over PhysxSchemaPhysxCharacterControllerAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~PhysxSchemaPhysxCharacterControllerAPI()

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

inline UsdAttribute CreateSlopeLimitAttr() const

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

inline UsdAttribute CreateMoveTargetAttr() const

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

inline UsdAttribute CreateUpAxisAttr() const

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

inline UsdAttribute CreateNonWalkableModeAttr() const

See GetNonWalkableModeAttr(), 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 GetClimbingModeAttr() const

The climbing mode.

Declaration

uniform token physxCharacterController:climbingMode = "easy"

C++ Type

TfToken

Usd Type

SdfValueTypeNames->Token

Variability

SdfVariabilityUniform

Allowed Values

easy, constrained

inline UsdAttribute CreateClimbingModeAttr() const

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

inline UsdAttribute CreateInvisibleWallHeightAttr() const

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

inline UsdAttribute CreateMaxJumpHeightAttr() const

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

inline UsdAttribute CreateContactOffsetAttr() const

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

inline UsdAttribute CreateStepOffsetAttr() const

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

inline UsdAttribute CreateScaleCoeffAttr() const

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

Cached volume growth. Range: [0, inf) Units: dimensionless.

Declaration

float physxCharacterController:volumeGrowth = 1.5

C++ Type

float

Usd Type

SdfValueTypeNames->Float

inline UsdAttribute CreateVolumeGrowthAttr() const

See GetVolumeGrowthAttr(), 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 GetSimulationOwnerRel() const

Single PhysicsScene that simulates this character controller. By default, this is the first PhysicsScene found in the stage using UsdStage::Traverse().

inline UsdRelationship CreateSimulationOwnerRel() const

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

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.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

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.

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.