UsdPhysicsPrismaticJoint Class Reference

#include <prismaticJoint.h>

Inheritance diagram for UsdPhysicsPrismaticJoint:

Public Member Functions
	UsdPhysicsPrismaticJoint (const UsdPrim &prim=UsdPrim())
	UsdPhysicsPrismaticJoint (const UsdSchemaBase &schemaObj)
virtual USDPHYSICS_API	~UsdPhysicsPrismaticJoint ()
	Destructor. More...
USDPHYSICS_API UsdAttribute	GetAxisAttr () const
USDPHYSICS_API UsdAttribute	CreateAxisAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdAttribute	GetLowerLimitAttr () const
USDPHYSICS_API UsdAttribute	CreateLowerLimitAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdAttribute	GetUpperLimitAttr () const
USDPHYSICS_API UsdAttribute	CreateUpperLimitAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Public Member Functions inherited from UsdPhysicsJoint
	UsdPhysicsJoint (const UsdPrim &prim=UsdPrim())
	UsdPhysicsJoint (const UsdSchemaBase &schemaObj)
virtual USDPHYSICS_API	~UsdPhysicsJoint ()
	Destructor. More...
USDPHYSICS_API UsdAttribute	GetLocalPos0Attr () const
USDPHYSICS_API UsdAttribute	CreateLocalPos0Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdAttribute	GetLocalRot0Attr () const
USDPHYSICS_API UsdAttribute	CreateLocalRot0Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdAttribute	GetLocalPos1Attr () const
USDPHYSICS_API UsdAttribute	CreateLocalPos1Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdAttribute	GetLocalRot1Attr () const
USDPHYSICS_API UsdAttribute	CreateLocalRot1Attr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdAttribute	GetJointEnabledAttr () const
USDPHYSICS_API UsdAttribute	CreateJointEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdAttribute	GetCollisionEnabledAttr () const
USDPHYSICS_API UsdAttribute	CreateCollisionEnabledAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdAttribute	GetExcludeFromArticulationAttr () const
USDPHYSICS_API UsdAttribute	CreateExcludeFromArticulationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdAttribute	GetBreakForceAttr () const
USDPHYSICS_API UsdAttribute	CreateBreakForceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdAttribute	GetBreakTorqueAttr () const
USDPHYSICS_API UsdAttribute	CreateBreakTorqueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDPHYSICS_API UsdRelationship	GetBody0Rel () const
USDPHYSICS_API UsdRelationship	CreateBody0Rel () const
USDPHYSICS_API UsdRelationship	GetBody1Rel () const
USDPHYSICS_API UsdRelationship	CreateBody1Rel () const
Public Member Functions inherited from UsdGeomImageable
	UsdGeomImageable (const UsdPrim &prim=UsdPrim())
	UsdGeomImageable (const UsdSchemaBase &schemaObj)
virtual USDGEOM_API	~UsdGeomImageable ()
	Destructor. More...
USDGEOM_API UsdAttribute	GetVisibilityAttr () const
USDGEOM_API UsdAttribute	CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdAttribute	GetPurposeAttr () const
USDGEOM_API UsdAttribute	CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDGEOM_API UsdRelationship	GetProxyPrimRel () const
USDGEOM_API UsdRelationship	CreateProxyPrimRel () const
USDGEOM_API void	MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
USDGEOM_API void	MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
USDGEOM_API TfToken	ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const
USDGEOM_API UsdAttribute	GetPurposeVisibilityAttr (const TfToken &purpose=UsdGeomTokens->default_) const
USDGEOM_API TfToken	ComputeEffectiveVisibility (const TfToken &purpose=UsdGeomTokens->default_, const UsdTimeCode &time=UsdTimeCode::Default()) const
USDGEOM_API PurposeInfo	ComputePurposeInfo () const
USDGEOM_API PurposeInfo	ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const
USDGEOM_API TfToken	ComputePurpose () const
USDGEOM_API UsdPrim	ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
USDGEOM_API bool	SetProxyPrim (const UsdPrim &proxy) const
USDGEOM_API bool	SetProxyPrim (const UsdSchemaBase &proxy) const
USDGEOM_API GfBBox3d	ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
USDGEOM_API GfBBox3d	ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
USDGEOM_API GfBBox3d	ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
USDGEOM_API GfMatrix4d	ComputeLocalToWorldTransform (UsdTimeCode const &time) const
USDGEOM_API GfMatrix4d	ComputeParentToWorldTransform (UsdTimeCode const &time) const
Public Member Functions inherited from UsdTyped
	UsdTyped (const UsdPrim &prim=UsdPrim())
	UsdTyped (const UsdSchemaBase &schemaObj)
virtual USD_API	~UsdTyped ()
	Destructor. More...
Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
bool	IsTyped () const
bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...
bool	IsAppliedAPISchema () const
bool	IsMultipleApplyAPISchema () const
UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...
USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store prim as the held prim. More...
USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by otherSchema. More...
virtual USD_API	~UsdSchemaBase ()
	Destructor. More...
USD_API	operator bool () const
UsdPrim	GetPrim () const
	Return this schema object's held prim. More...
SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath(). More...
USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static USDPHYSICS_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDPHYSICS_API UsdPhysicsPrismaticJoint	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDPHYSICS_API UsdPhysicsPrismaticJoint	Define (const UsdStagePtr &stage, const SdfPath &path)
Static Public Member Functions inherited from UsdPhysicsJoint
static USDPHYSICS_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDPHYSICS_API UsdPhysicsJoint	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDPHYSICS_API UsdPhysicsJoint	Define (const UsdStagePtr &stage, const SdfPath &path)
Static Public Member Functions inherited from UsdGeomImageable
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDGEOM_API UsdGeomImageable	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDGEOM_API const TfTokenVector &	GetOrderedPurposeTokens ()
Static Public Member Functions inherited from UsdTyped
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USD_API UsdTyped	Get (const UsdStagePtr &stage, const SdfPath &path)
Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped
Static Public Attributes inherited from UsdPhysicsJoint
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped
Static Public Attributes inherited from UsdGeomImageable
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions
USDPHYSICS_API UsdSchemaKind	_GetSchemaKind () const override
Protected Member Functions inherited from UsdTyped
USD_API bool	_IsCompatible () const override
Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind	_GetSchemaType () const
const TfType &	_GetType () const
USD_API UsdAttribute	_CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const

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::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::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::~UsdPhysicsPrismaticJoint ( )

virtual

Destructor.

Member Function Documentation

USDPHYSICS_API UsdSchemaKind UsdPhysicsPrismaticJoint::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

Reimplemented from UsdPhysicsJoint.

USDPHYSICS_API UsdAttribute UsdPhysicsPrismaticJoint::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 UsdPhysicsPrismaticJoint::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 UsdPhysicsPrismaticJoint::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 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 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 UsdPhysicsPrismaticJoint::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 UsdPhysicsPrismaticJoint::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& UsdPhysicsPrismaticJoint::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 UsdPhysicsPrismaticJoint::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

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 147 of file prismaticJoint.h.

Member Data Documentation

const UsdSchemaKind UsdPhysicsPrismaticJoint::schemaKind = UsdSchemaKind::ConcreteTyped

static

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

See Also

UsdSchemaKind

Definition at line 69 of file prismaticJoint.h.

---

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

• pxr/usd/usdPhysics/prismaticJoint.h