Predefined prismatic joint type (translation along prismatic joint axis is permitted.) More...

Inheritance diagram for UsdPhysicsPrismaticJoint:

Public Member Functions
	UsdPhysicsPrismaticJoint (const UsdPrim &prim=UsdPrim())
	Construct a UsdPhysicsPrismaticJoint on UsdPrim `prim` . More...

	UsdPhysicsPrismaticJoint (const UsdSchemaBase &schemaObj)
	Construct a UsdPhysicsPrismaticJoint on the prim held by `schemaObj` . More...

virtual USDPHYSICS_API	~UsdPhysicsPrismaticJoint ()
	Destructor. More...

USDPHYSICS_API UsdAttribute	GetAxisAttr () const
	Joint axis. More...

USDPHYSICS_API UsdAttribute	CreateAxisAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetAxisAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdAttribute	GetLowerLimitAttr () const
	Lower limit. More...

USDPHYSICS_API UsdAttribute	CreateLowerLimitAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLowerLimitAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdAttribute	GetUpperLimitAttr () const
	Upper limit. More...

USDPHYSICS_API UsdAttribute	CreateUpperLimitAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetUpperLimitAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Public Member Functions inherited from UsdPhysicsJoint
	UsdPhysicsJoint (const UsdPrim &prim=UsdPrim())
	Construct a UsdPhysicsJoint on UsdPrim `prim` . More...

	UsdPhysicsJoint (const UsdSchemaBase &schemaObj)
	Construct a UsdPhysicsJoint on the prim held by `schemaObj` . More...

virtual USDPHYSICS_API	~UsdPhysicsJoint ()
	Destructor. More...

USDPHYSICS_API UsdAttribute	GetLocalPos0Attr () const
	Relative position of the joint frame to body0's frame. More...

USDPHYSICS_API UsdAttribute	CreateLocalPos0Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLocalPos0Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdAttribute	GetLocalRot0Attr () const
	Relative orientation of the joint frame to body0's frame. More...

USDPHYSICS_API UsdAttribute	CreateLocalRot0Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLocalRot0Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdAttribute	GetLocalPos1Attr () const
	Relative position of the joint frame to body1's frame. More...

USDPHYSICS_API UsdAttribute	CreateLocalPos1Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLocalPos1Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdAttribute	GetLocalRot1Attr () const
	Relative orientation of the joint frame to body1's frame. More...

USDPHYSICS_API UsdAttribute	CreateLocalRot1Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLocalRot1Attr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdAttribute	GetJointEnabledAttr () const
	Determines if the joint is enabled. More...

USDPHYSICS_API UsdAttribute	CreateJointEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetJointEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdAttribute	GetCollisionEnabledAttr () const
	Determines if the jointed subtrees should collide or not. More...

USDPHYSICS_API UsdAttribute	CreateCollisionEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetCollisionEnabledAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdAttribute	GetExcludeFromArticulationAttr () const
	Determines if the joint can be included in an Articulation. More...

USDPHYSICS_API UsdAttribute	CreateExcludeFromArticulationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetExcludeFromArticulationAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdAttribute	GetBreakForceAttr () const
	Joint break force. More...

USDPHYSICS_API UsdAttribute	CreateBreakForceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetBreakForceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdAttribute	GetBreakTorqueAttr () const
	Joint break torque. More...

USDPHYSICS_API UsdAttribute	CreateBreakTorqueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetBreakTorqueAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdRelationship	GetBody0Rel () const
	Relationship to any UsdGeomXformable. More...

USDPHYSICS_API UsdRelationship	CreateBody0Rel () const
	See GetBody0Rel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

USDPHYSICS_API UsdRelationship	GetBody1Rel () const
	Relationship to any UsdGeomXformable. More...

USDPHYSICS_API UsdRelationship	CreateBody1Rel () const
	See GetBody1Rel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...

Static Public Member Functions
static USDPHYSICS_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 USDPHYSICS_API UsdPhysicsPrismaticJoint	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdPhysicsPrismaticJoint holding the prim adhering to this schema at `path` on `stage`. More...

static USDPHYSICS_API UsdPhysicsPrismaticJoint	Define (const UsdStagePtr &stage, const SdfPath &path)
	Attempt to ensure a UsdPrim adhering to this schema at `path` is defined (according to UsdPrim::IsDefined()) on this stage. More...

Static Public Member Functions inherited from UsdPhysicsJoint
static USDPHYSICS_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 USDPHYSICS_API UsdPhysicsJoint	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdPhysicsJoint holding the prim adhering to this schema at `path` on `stage`. More...

static USDPHYSICS_API UsdPhysicsJoint	Define (const UsdStagePtr &stage, const SdfPath &path)
	Attempt to ensure a UsdPrim adhering to this schema at `path` is defined (according to UsdPrim::IsDefined()) on this stage. More...

Static Public Attributes
static const UsdSchemaType	schemaType = UsdSchemaType::ConcreteTyped
	Compile time constant representing what kind of schema this class is. More...

Static Public Attributes inherited from UsdPhysicsJoint
static const UsdSchemaType	schemaType = UsdSchemaType::ConcreteTyped
	Compile time constant representing what kind of schema this class is. More...

Protected Member Functions
USDPHYSICS_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Protected Member Functions inherited from UsdPhysicsJoint
USDPHYSICS_API UsdSchemaType	_GetSchemaType () const override
	Returns the type of schema this class belongs to. More...

Friends
class	UsdSchemaRegistry

Detailed Description

Predefined prismatic joint type (translation along prismatic joint axis is permitted.)

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdPhysicsTokens. So to set an attribute to the value "rightHanded", use UsdPhysicsTokens->rightHanded as the value.

Definition at line 63 of file prismaticJoint.h.

Constructor & Destructor Documentation

UsdPhysicsPrismaticJoint ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a UsdPhysicsPrismaticJoint on UsdPrim prim .

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

Definition at line 75 of file prismaticJoint.h.

UsdPhysicsPrismaticJoint ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdPhysicsPrismaticJoint on the prim held by schemaObj .

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

Definition at line 83 of file prismaticJoint.h.

virtual USDPHYSICS_API ~UsdPhysicsPrismaticJoint ( )

virtual

Destructor.

Member Function Documentation

USDPHYSICS_API UsdSchemaType _GetSchemaType ( ) const

overrideprotected

Returns the type of schema this class belongs to.

See Also: UsdSchemaType

USDPHYSICS_API UsdAttribute CreateAxisAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDPHYSICS_API UsdAttribute CreateLowerLimitAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDPHYSICS_API UsdAttribute CreateUpperLimitAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetUpperLimitAttr(), 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 USDPHYSICS_API UsdPhysicsPrismaticJoint Define	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

static USDPHYSICS_API UsdPhysicsPrismaticJoint Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

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

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

*

USDPHYSICS_API UsdAttribute GetAxisAttr ( ) const

Joint axis.


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

USDPHYSICS_API UsdAttribute GetLowerLimitAttr ( ) const

Lower limit.

Units: distance. -inf means not limited in negative direction.


Declaration	`float physics:lowerLimit = -inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

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

USDPHYSICS_API UsdAttribute GetUpperLimitAttr ( ) const

Upper limit.

Units: distance. inf means not limited in positive direction.


Declaration	`float physics:upperLimit = inf`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped

static

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

See Also: UsdSchemaType

Definition at line 69 of file prismaticJoint.h.

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

W:/919a5455eee1e83c/src/usdPhysics/prismaticJoint.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation