PhysX Schema#

class PhysxSchemaJointStateAPI : public UsdAPISchemaBase#

The PhysicsJointStateAPI allows reading and modifying position and velocity of a specific articulation joint axis. It can be applied only to the following joint primitives when they are part of an articulation:

• UsdPhysicsJoint

• UsdPhysicsRevoluteJoint

• UsdPhysicsPrismaticJoint

The PhysicsJointStateAPI is a multipleApply schema, and its instance name TfToken defines the joint axis. For multi degrees-of-freedom joints, the instance names to choose from are: “transX”, “transY”, “transZ”, “rotX”, “rotY”, “rotZ”. For prismatic joints, the name “linear” has to be used. For revolute joints, the name “angular” has to be used.

Public Functions

inline explicit PhysxSchemaJointStateAPI(

const UsdPrim &prim = UsdPrim(),

const TfToken &name = TfToken(),

)#

Construct a PhysxSchemaJointStateAPI on UsdPrim prim with name name . Equivalent to PhysxSchemaJointStateAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( “state:name”));.

for a valid prim, but will not immediately throw an error for an invalid prim

inline explicit PhysxSchemaJointStateAPI(

const UsdSchemaBase &schemaObj,

const TfToken &name,

)#

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

virtual ~PhysxSchemaJointStateAPI()#

Destructor.

inline TfToken GetName() const#

Returns the name of this multiple-apply schema instance.

UsdAttribute GetPositionAttr() const#

Joint state position defines the relative difference expressed as a distance or angle between articulation joint body0 frame and articulation joint body1 frame.

For UsdPhysicsPrismaticJoint it’s the linear distance between body0 and body1 along the axis specified by the joint itself. For UsdPhysicsRevoluteJoint it’s the angular difference between body0 and body1 frames along the axis specified by the joint itself. For UsdPhsyicsJoint joints it’s the angular or linear difference between body0 and body1 frames along the axis specified by the multiple apply schema instance name.

When writing to the position attribute, the changes are immediately reflected on the next simulation step, instantaneously teleporting articulation links to the wanted position.

After a simulation step, the position value will reflect the actual last position of the joint, that may have been affected by other mechanisms such as drives.

Range: (-inf, inf) Units: linear - distance angular - degrees

Declaration	float physics:position = 0
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreatePositionAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetVelocityAttr() const#

Joint state velocity defines the relative velocity between joint body0 and joint body1 along the specified joint axis.

For UsdPhysicsPrismaticJoint it’s the relative linear velocitity of body0 relative to body1 along the axis specified by the joint itself. For UsdPhysicsRevoluteJoint it’s the relative angular velocitity of body0 relative to body1 along the axis specified by the joint itself. For UsdPhsyicsJoint joints it’s the relative angular or linear velocitity of body0 relative to body1 along the axis specified by the multiple apply schema instance name.

When writing to the velocity attribute, the changes are immediately reflected on the next simulation step, instantaneously changing velocity to the wanted value.

After a simulation step, the velocity value will reflect the actual last velocity of the joint, that may have been affected by other mechanisms such as drives.

Range: (-inf, inf) Units: linear - distance / seconds angular - degrees / seconds

Declaration	float physics:velocity = 0
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateVelocityAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

Public Members

path state#

Return a PhysxSchemaJointStateAPI 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. path must be of the format.

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

static TfTokenVector GetSchemaAttributeNames(

bool includeInherited,

const TfToken &instanceName,

)#

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name. Does not include attributes that may be authored by custom/extended methods of the schemas involved. The names returned will have the proper namespace prefix.

static PhysxSchemaJointStateAPI Get(

const UsdPrim &prim,

const TfToken &name,

)#

Return a PhysxSchemaJointStateAPI with name name holding the prim prim. Shorthand for PhysxSchemaJointStateAPI(prim, name);.

static std::vector<PhysxSchemaJointStateAPI> GetAll(

const UsdPrim &prim,

)#

Return a vector of all named instances of PhysxSchemaJointStateAPI on the given prim.

static bool IsSchemaPropertyBaseName(const TfToken &baseName)#

Checks if the given name baseName is the base name of a property of PhysicsJointStateAPI.

static bool IsPhysicsJointStateAPIPath(

const SdfPath &path,

TfToken *name,

)#

Checks if the given path path is of an API schema of type PhysicsJointStateAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

static bool CanApply(

const UsdPrim &prim,

const TfToken &name,

std::string *whyNot = nullptr,

)#

Returns true if this multiple-apply API schema can be applied, with the given instance name, name, to the given prim. If this schema can not be a applied 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()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static PhysxSchemaJointStateAPI Apply(

const UsdPrim &prim,

const TfToken &name,

)#

Applies this multiple-apply API schema to the given prim along with the given instance name, name.

This information is stored by adding “PhysicsJointStateAPI:<i>name</i>” to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is ‘instance1’, the token ‘PhysicsJointStateAPI:instance1’ is added to ‘apiSchemas’.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns:

A valid PhysxSchemaJointStateAPI object is returned upon success. An invalid (or empty) PhysxSchemaJointStateAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI#

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

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class PhysxSchemaPhysxArticulationAPI : public UsdAPISchemaBase#

PhysX articulation extended parameters.

Public Functions

inline explicit PhysxSchemaPhysxArticulationAPI(

const UsdPrim &prim = UsdPrim(),

)#

Construct a PhysxSchemaPhysxArticulationAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxArticulationAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxArticulationAPI(

const UsdSchemaBase &schemaObj,

)#

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

virtual ~PhysxSchemaPhysxArticulationAPI()#

Destructor.

UsdAttribute GetArticulationEnabledAttr() const#

Boolean defining whether articulation is enabled or disabled.

Declaration	bool physxArticulation:articulationEnabled = 1
C++ Type	bool
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Bool

UsdAttribute CreateArticulationEnabledAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetSolverPositionIterationCountAttr() const#

Solver position iteration counts for the body. Allowed range [1, 255].

Declaration	int physxArticulation:solverPositionIterationCount = 32
C++ Type	int
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Int

UsdAttribute CreateSolverPositionIterationCountAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetSolverVelocityIterationCountAttr() const#

Solver velocity iteration counts for the body. Allowed range [0, 255].

Declaration	int physxArticulation:solverVelocityIterationCount = 1
C++ Type	int
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Int

UsdAttribute CreateSolverVelocityIterationCountAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetSleepThresholdAttr() const#

Mass-normalized kinetic energy threshold below which the articulation may go to sleep. Range: [0, inf) Default: 0.00005 * tolerancesSpeed * tolerancesSpeed Units: distance * distance / seconds / seconds.

Declaration	float physxArticulation:sleepThreshold = 0.00005
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSleepThresholdAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetStabilizationThresholdAttr() const#

The mass-normalized kinetic energy threshold below which the articulation may participate in stabilization. Range: [0, inf) Default: 0.00001 * tolerancesSpeed * tolerancesSpeed Units: distance * distance / seconds / seconds.

Declaration	float physxArticulation:stabilizationThreshold = 0.00001
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateStabilizationThresholdAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetEnabledSelfCollisionsAttr() const#

Boolean defining whether self collisions should be enabled or disabled.

Declaration	bool physxArticulation:enabledSelfCollisions = 1
C++ Type	bool
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Bool

UsdAttribute CreateEnabledSelfCollisionsAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

static PhysxSchemaPhysxArticulationAPI Get(

const UsdStagePtr &stage,

const SdfPath &path,

)#

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

PhysxSchemaPhysxArticulationAPI(stage->GetPrimAtPath(path));

static bool CanApply(

const UsdPrim &prim,

std::string *whyNot = nullptr,

)#

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

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static PhysxSchemaPhysxArticulationAPI Apply(const UsdPrim &prim)#

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxArticulationAPI” to the token-valued, listOp metadata apiSchemas on the prim.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns:

A valid PhysxSchemaPhysxArticulationAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxArticulationAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI#

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

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class PhysxSchemaPhysxAutoAttachmentAPI : public UsdAPISchemaBase#

Deprecated: Will be replaced by a new deformable schema in a future release. Auto generates the attachment points and filtering ids based on the attributes defined in the API.

Public Functions

inline explicit PhysxSchemaPhysxAutoAttachmentAPI(

const UsdPrim &prim = UsdPrim(),

)#

Construct a PhysxSchemaPhysxAutoAttachmentAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxAutoAttachmentAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxAutoAttachmentAPI(

const UsdSchemaBase &schemaObj,

)#

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

virtual ~PhysxSchemaPhysxAutoAttachmentAPI()#

Destructor.

UsdAttribute GetEnableDeformableVertexAttachmentsAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Enables attaching deformable mesh vertices which overlap with the other actor’s volume.

Declaration	bool physxAutoAttachment:enableDeformableVertexAttachments = 1
C++ Type	bool
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Bool

UsdAttribute CreateEnableDeformableVertexAttachmentsAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetDeformableVertexOverlapOffsetAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Deformable mesh vertices are attached if their distance to the other actor’s volume is smaller than the offset. Range: [0, inf) Units: distance.

Declaration	float physxAutoAttachment:deformableVertexOverlapOffset = 0
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateDeformableVertexOverlapOffsetAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetEnableRigidSurfaceAttachmentsAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Enables sampling attachment points on the rigid actor’s surface.

Declaration	bool physxAutoAttachment:enableRigidSurfaceAttachments = 0
C++ Type	bool
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Bool

UsdAttribute CreateEnableRigidSurfaceAttachmentsAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetRigidSurfaceSamplingDistanceAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Attachment points on the rigid surface are positioned such that their typical neighbor distance matches the sampling distance. Use heuristic by default. Range: [0, inf) Units: distance.

Declaration	float physxAutoAttachment:rigidSurfaceSamplingDistance = -inf
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateRigidSurfaceSamplingDistanceAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetEnableCollisionFilteringAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Enables adding collision filtering in the vicinity of the attachment points.

Declaration	bool physxAutoAttachment:enableCollisionFiltering = 1
C++ Type	bool
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Bool

UsdAttribute CreateEnableCollisionFilteringAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetCollisionFilteringOffsetAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Filtering ids are generated for deformable mesh vertices if their distance to the other actor’s volume is smaller than the offset. Use heuristic by default. Range: [0, inf) Units: distance.

Declaration	float physxAutoAttachment:collisionFilteringOffset = -inf
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateCollisionFilteringOffsetAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetEnableDeformableFilteringPairsAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Enables geometry pair based collision filtering for deformable-deformable attachments. By default a filtered geometry of one actor is filtered against all geometries of the other actor.

Declaration	bool physxAutoAttachment:enableDeformableFilteringPairs = 0
C++ Type	bool
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Bool

UsdAttribute CreateEnableDeformableFilteringPairsAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

static PhysxSchemaPhysxAutoAttachmentAPI Get(

const UsdStagePtr &stage,

const SdfPath &path,

)#

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

PhysxSchemaPhysxAutoAttachmentAPI(stage->GetPrimAtPath(path));

static bool CanApply(

const UsdPrim &prim,

std::string *whyNot = nullptr,

)#

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

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static PhysxSchemaPhysxAutoAttachmentAPI Apply(const UsdPrim &prim)#

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxAutoAttachmentAPI” to the token-valued, listOp metadata apiSchemas on the prim.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns:

A valid PhysxSchemaPhysxAutoAttachmentAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxAutoAttachmentAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI#

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

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class PhysxSchemaPhysxAutoParticleClothAPI : public UsdAPISchemaBase#

Deprecated: Will be replaced by a new deformable schema in a future release. WARNING: This is a draft API; the design is not fixed and may change in the future. Applied to a UsdGeomMesh with PhysxParticleClothAPI. Defines parameters to automatically compute spring constraints.

Public Functions

inline explicit PhysxSchemaPhysxAutoParticleClothAPI(

const UsdPrim &prim = UsdPrim(),

)#

Construct a PhysxSchemaPhysxAutoParticleClothAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxAutoParticleClothAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxAutoParticleClothAPI(

const UsdSchemaBase &schemaObj,

)#

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

virtual ~PhysxSchemaPhysxAutoParticleClothAPI()#

Destructor.

UsdAttribute GetSpringStretchStiffnessAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Stretch stiffness. Represents a stiffness for linear springs placed between particles to counteract stretching. Range: [0, inf) Units: force / distance = mass / second / second.

Declaration	float physxAutoParticleCloth:springStretchStiffness = 1.5
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSpringStretchStiffnessAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetSpringBendStiffnessAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Bend stiffness. Represents a stiffness for linear springs placed in a way to counteract bending. Range: [0, inf) Units: force / distance = mass / second / second.

Declaration	float physxAutoParticleCloth:springBendStiffness = 1.5
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSpringBendStiffnessAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetSpringShearStiffnessAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Shear stiffness. Represents a stiffness for linear springs placed in a way to counteract shear. Range: [0, inf) Units: force / distance = mass / second / second.

Declaration	float physxAutoParticleCloth:springShearStiffness = 1.5
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSpringShearStiffnessAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetSpringDampingAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Damping on cloth spring constraints. Applies to all constraints parametrized by stiffness attributes. Range: [0, inf) Units: force * second / distance = mass / second.

Declaration	float physxAutoParticleCloth:springDamping = 10
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSpringDampingAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetDisableMeshWeldingAttr() const#

Deprecated: Will be replaced by a new deformable schema in a future release. Disable welding of the UsdGeomMesh vertices for cloth simulation.

Declaration	bool physxAutoParticleCloth:disableMeshWelding = 0
C++ Type	bool
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Bool

UsdAttribute CreateDisableMeshWeldingAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

static PhysxSchemaPhysxAutoParticleClothAPI Get(

const UsdStagePtr &stage,

const SdfPath &path,

)#

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

PhysxSchemaPhysxAutoParticleClothAPI(stage->GetPrimAtPath(path));

static bool CanApply(

const UsdPrim &prim,

std::string *whyNot = nullptr,

)#

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

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static PhysxSchemaPhysxAutoParticleClothAPI Apply(

const UsdPrim &prim,

)#

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxAutoParticleClothAPI” to the token-valued, listOp metadata apiSchemas on the prim.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns:

A valid PhysxSchemaPhysxAutoParticleClothAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxAutoParticleClothAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI#

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

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class PhysxSchemaPhysxCameraAPI : public UsdAPISchemaBase#

PhysX camera.

Public Functions

inline explicit PhysxSchemaPhysxCameraAPI(

const UsdPrim &prim = UsdPrim(),

)#

Construct a PhysxSchemaPhysxCameraAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxCameraAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxCameraAPI(

const UsdSchemaBase &schemaObj,

)#

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

virtual ~PhysxSchemaPhysxCameraAPI()#

Destructor.

UsdAttribute GetAlwaysUpdateEnabledAttr() const#

When enabled, always update this camera whether it is the active camera or not. This prevents cameras from slewing into position when switching to a new active camera. When disabled, only the active camera is updated, saving time.

Declaration	bool alwaysUpdateEnabled = 1
C++ Type	bool
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Bool

UsdAttribute CreateAlwaysUpdateEnabledAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdRelationship GetPhysxCameraSubjectRel() const#

Reference to the subject this camera is to track.

UsdRelationship CreatePhysxCameraSubjectRel() const#

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

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

static PhysxSchemaPhysxCameraAPI Get(

const UsdStagePtr &stage,

const SdfPath &path,

)#

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

PhysxSchemaPhysxCameraAPI(stage->GetPrimAtPath(path));

static bool CanApply(

const UsdPrim &prim,

std::string *whyNot = nullptr,

)#

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

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static PhysxSchemaPhysxCameraAPI Apply(const UsdPrim &prim)#

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxCameraAPI” to the token-valued, listOp metadata apiSchemas on the prim.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns:

A valid PhysxSchemaPhysxCameraAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxCameraAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI#

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

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class PhysxSchemaPhysxCameraDroneAPI : public UsdAPISchemaBase#

PhysX drone camera that follows its subject from the air as it drives.

Public Functions

inline explicit PhysxSchemaPhysxCameraDroneAPI(

const UsdPrim &prim = UsdPrim(),

)#

Construct a PhysxSchemaPhysxCameraDroneAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxCameraDroneAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxCameraDroneAPI(

const UsdSchemaBase &schemaObj,

)#

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

virtual ~PhysxSchemaPhysxCameraDroneAPI()#

Destructor.

UsdAttribute GetFollowHeightAttr() const#

The height above the subject that the drone attmepts to maintain. e.g. 15 meters.

Declaration	float physxDroneCamera:followHeight
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateFollowHeightAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetFollowDistanceAttr() const#

The distance from the subject that the drone attempts to maintain. e.g. 30 meters.

Declaration	float physxDroneCamera:followDistance
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateFollowDistanceAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetMaxDistanceAttr() const#

The maximum distance allowed from the subject before the drone resets to the target position. e.g. 100 meters.

Declaration	float physxDroneCamera:maxDistance
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateMaxDistanceAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetMaxSpeedAttr() const#

The maximum speed the drone is allowed to move. e.g. 20.0 meters/second.

Declaration	float physxDroneCamera:maxSpeed
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateMaxSpeedAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetHorizontalVelocityGainAttr() const#

The higher the gain, the faster the drone will accelerate towards the target position. e.g. 1.0.

Declaration	float physxDroneCamera:horizontalVelocityGain
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateHorizontalVelocityGainAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetVerticalVelocityGainAttr() const#

The higher the gain, the higher the climb or descent rate of the drone to get to the target altitude. e.g. 1.0.

Declaration	float physxDroneCamera:verticalVelocityGain
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateVerticalVelocityGainAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetFeedForwardVelocityGainAttr() const#

The higher the gain, the more closely the drone will match the velocity of the subject and the more connected it will appear. e.g. 0.1.

Declaration	float physxDroneCamera:feedForwardVelocityGain
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateFeedForwardVelocityGainAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetVelocityFilterTimeConstantAttr() const#

The velocity of the drone is filtered to make it appear as if it is accelerating. e.g. 1.0 seconds.

Declaration	float physxDroneCamera:velocityFilterTimeConstant
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateVelocityFilterTimeConstantAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetRotationFilterTimeConstantAttr() const#

The angular velocity of the drone is filtered to make it appear as if it is accelerating. e.g. 0.2 seconds.

Declaration	float physxDroneCamera:rotationFilterTimeConstant
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateRotationFilterTimeConstantAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetPositionOffsetAttr() const#

An offset vector from the subject origin at which the drone looks. e.g. (0.0 m, 0.0 m, 0.0 m)

Declaration	float3 physxDroneCamera:positionOffset
C++ Type	GfVec3f
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float3

UsdAttribute CreatePositionOffsetAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

static PhysxSchemaPhysxCameraDroneAPI Get(

const UsdStagePtr &stage,

const SdfPath &path,

)#

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

PhysxSchemaPhysxCameraDroneAPI(stage->GetPrimAtPath(path));

static bool CanApply(

const UsdPrim &prim,

std::string *whyNot = nullptr,

)#

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

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static PhysxSchemaPhysxCameraDroneAPI Apply(const UsdPrim &prim)#

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxCameraDroneAPI” to the token-valued, listOp metadata apiSchemas on the prim.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns:

A valid PhysxSchemaPhysxCameraDroneAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxCameraDroneAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI#

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

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

class PhysxSchemaPhysxCameraFollowAPI : public UsdAPISchemaBase#

PhysX camera that follows behind the subject as it moves.

Public Functions

inline explicit PhysxSchemaPhysxCameraFollowAPI(

const UsdPrim &prim = UsdPrim(),

)#

Construct a PhysxSchemaPhysxCameraFollowAPI on UsdPrim prim . Equivalent to PhysxSchemaPhysxCameraFollowAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim.

inline explicit PhysxSchemaPhysxCameraFollowAPI(

const UsdSchemaBase &schemaObj,

)#

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

virtual ~PhysxSchemaPhysxCameraFollowAPI()#

Destructor.

UsdAttribute GetYawAngleAttr() const#

The yaw angle of the follow vector around the subject. Zero is directly behind the subject. e.g. 0 degrees.

Declaration	float physxFollowCamera:yawAngle
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateYawAngleAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetPitchAngleAttr() const#

The pitch angle of the follow vector around the subject. Zero is directly behind the subject. e.g. 15 degrees.

Declaration	float physxFollowCamera:pitchAngle
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreatePitchAngleAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetPitchAngleTimeConstantAttr() const#

Time constant to filter the pitch angle, in seconds. Used to pitch the camera up and down when driving up or down hills. e.g. 0.2 seconds.

Declaration	float physxFollowCamera:pitchAngleTimeConstant
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreatePitchAngleTimeConstantAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetSlowSpeedPitchAngleScaleAttr() const#

Scale of the camera pitch angle at slow speed. This lowers the camera behind the subject at slow speeds. e.g. 0.5.

Declaration	float physxFollowCamera:slowSpeedPitchAngleScale
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSlowSpeedPitchAngleScaleAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetSlowPitchAngleSpeedAttr() const#

Scale of the camera pitch angle at slow speed. This lowers the camera behind the subject at slow speeds. e.g. 1000 cm/sec.

Declaration	float physxFollowCamera:slowPitchAngleSpeed
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateSlowPitchAngleSpeedAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetVelocityNormalMinSpeedAttr() const#

The minimum speed, below which, the subject look vector must be used because the normalized velocity vector is too erratic. e.g. 600.0 cm/sec.

Declaration	float physxFollowCamera:velocityNormalMinSpeed
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateVelocityNormalMinSpeedAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetFollowMinSpeedAttr() const#

The minimum speed used for a linear interpolation to compute the follow distance of the camera. e.g. 300.0 cm/sec.

Declaration	float physxFollowCamera:followMinSpeed
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateFollowMinSpeedAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetFollowMinDistanceAttr() const#

The minimum distance used for a linear interpolation to compute the follow distance of the camera. e.g. 1500.0 cm.

Declaration	float physxFollowCamera:followMinDistance
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateFollowMinDistanceAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetFollowMaxSpeedAttr() const#

The maximum speed used for a linear interpolation to compute the follow distance of the camera. e.g. 3000.0 cm/sec.

Declaration	float physxFollowCamera:followMaxSpeed
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateFollowMaxSpeedAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetFollowMaxDistanceAttr() const#

The maximum distance used for a linear interpolation to compute the follow distance of the camera. e.g. 1000.0 cm.

Declaration	float physxFollowCamera:followMaxDistance
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateFollowMaxDistanceAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetYawRateTimeConstantAttr() const#

Time constant to filter the subject yaw rate, in seconds. Use to look into turns. e.g. 0.2 sec.

Declaration	float physxFollowCamera:yawRateTimeConstant
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateYawRateTimeConstantAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetFollowTurnRateGainAttr() const#

A scale factor that multiplies the filtered yaw rate to yaw the camera position behind the subject. Can be any positive or negative number. e.g. 0.2.

Declaration	float physxFollowCamera:followTurnRateGain
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateFollowTurnRateGainAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetCameraPositionTimeConstantAttr() const#

Filter time constant for the position of the camera for each axis, in seconds. e.g. (0.5 sec, 0.1 sec, 0.5 sec)

Declaration	float3 physxFollowCamera:cameraPositionTimeConstant
C++ Type	GfVec3f
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float3

UsdAttribute CreateCameraPositionTimeConstantAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetPositionOffsetAttr() const#

Position offset from the subject center of mass from which the camera follow vector and look vector are computed. e.g. (0.0 cm, 10.0 cm, 0.0 cm)

Declaration	float3 physxFollowCamera:positionOffset
C++ Type	GfVec3f
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float3

UsdAttribute CreatePositionOffsetAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetLookAheadMinSpeedAttr() const#

The minimum speed used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 0.0 cm/sec.

Declaration	float physxFollowCamera:lookAheadMinSpeed
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateLookAheadMinSpeedAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetLookAheadMinDistanceAttr() const#

The minimum distance used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 0.0 cm.

Declaration	float physxFollowCamera:lookAheadMinDistance
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateLookAheadMinDistanceAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetLookAheadMaxSpeedAttr() const#

The maximum speed used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 2000.0 cm.

Declaration	float physxFollowCamera:lookAheadMaxSpeed
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateLookAheadMaxSpeedAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetLookAheadMaxDistanceAttr() const#

The maximum distance used for a linear interpolation to compute the look ahead distance of the camera look point. e.g. 500.0 cm.

Declaration	float physxFollowFollowCamera:lookAheadMaxDistance
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateLookAheadMaxDistanceAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetLookAheadTurnRateGainAttr() const#

A scale factor that multiplies the filtered yaw rate to yaw the camera look point left or right. Can be any positive or negative number. e.g. 0.2.

Declaration	float physxFollowCamera:lookAheadTurnRateGain
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateLookAheadTurnRateGainAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetLookPositionHeightAttr() const#

Distance to elevate the camera look point. e.g. 50.0 cm.

Declaration	float physxFollowCamera:lookPositionHeight
C++ Type	float
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float

UsdAttribute CreateLookPositionHeightAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

UsdAttribute GetLookPositionTimeConstantAttr() const#

Filter time constant for the camera look point, in seconds. e.g. (0.2 sec, 0.5 sec, 0.2 sec)

Declaration	float3 physxFollowCamera:lookPositionTimeConstant
C++ Type	GfVec3f
Usd_Datatypes “Usd Type”	SdfValueTypeNames->Float3

UsdAttribute CreateLookPositionTimeConstantAttr(

VtValue const &defaultValue = VtValue(),

bool writeSparsely = false,

) const#

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

Public Static Functions

static 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. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

static PhysxSchemaPhysxCameraFollowAPI Get(

const UsdStagePtr &stage,

const SdfPath &path,

)#

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

PhysxSchemaPhysxCameraFollowAPI(stage->GetPrimAtPath(path));

static bool CanApply(

const UsdPrim &prim,

std::string *whyNot = nullptr,

)#

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

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

static PhysxSchemaPhysxCameraFollowAPI Apply(const UsdPrim &prim)#

Applies this single-apply API schema to the given prim. This information is stored by adding “PhysxCameraFollowAPI” to the token-valued, listOp metadata apiSchemas on the prim.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::CanApplyAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns:

A valid PhysxSchemaPhysxCameraFollowAPI object is returned upon success. An invalid (or empty) PhysxSchemaPhysxCameraFollowAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI#

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

See also

UsdSchemaKind

Protected Functions

UsdSchemaKind _GetSchemaKind() const override#

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind