The PhysicsLimitAPI can be applied to a PhysicsJoint and will restrict the movement along an axis. More...

#include <limitAPI.h>

Inheritance diagram for UsdPhysicsLimitAPI:

Public Member Functions
	UsdPhysicsLimitAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())
	Construct a UsdPhysicsLimitAPI on UsdPrim `prim` with name `name` .

	UsdPhysicsLimitAPI (const UsdSchemaBase &schemaObj, const TfToken &name)
	Construct a UsdPhysicsLimitAPI on the prim held by `schemaObj` with name `name`.

virtual USDPHYSICS_API	~UsdPhysicsLimitAPI ()
	Destructor.

TfToken	GetName () const
	Returns the name of this multiple-apply schema instance.

USDPHYSICS_API UsdAttribute	GetLowAttr () const
	Lower limit.

USDPHYSICS_API UsdAttribute	CreateLowAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetLowAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDPHYSICS_API UsdAttribute	GetHighAttr () const
	Upper limit.

USDPHYSICS_API UsdAttribute	CreateHighAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetHighAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

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

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

virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor.

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
	Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.

bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped.

bool	IsAPISchema () const
	Returns whether this is an API schema or not.

bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not.

bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not.

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is.

USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store `prim` as the held prim.

USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by `otherSchema`.

virtual USD_API	~UsdSchemaBase ()
	Destructor.

UsdPrim	GetPrim () const
	Return this schema object's held prim.

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath().

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null.

USD_API	operator bool () const
	Return true if this schema object is compatible with its held prim, false otherwise.

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.

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

static USDPHYSICS_API UsdPhysicsLimitAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdPhysicsLimitAPI holding the prim adhering to this schema at `path` on `stage`.

static USDPHYSICS_API UsdPhysicsLimitAPI	Get (const UsdPrim &prim, const TfToken &name)
	Return a UsdPhysicsLimitAPI with name `name` holding the prim `prim`.

static USDPHYSICS_API std::vector< UsdPhysicsLimitAPI >	GetAll (const UsdPrim &prim)
	Return a vector of all named instances of UsdPhysicsLimitAPI on the given `prim`.

static USDPHYSICS_API bool	IsSchemaPropertyBaseName (const TfToken &baseName)
	Checks if the given name `baseName` is the base name of a property of PhysicsLimitAPI.

static USDPHYSICS_API bool	IsPhysicsLimitAPIPath (const SdfPath &path, TfToken *name)
	Checks if the given path `path` is of an API schema of type PhysicsLimitAPI.

static USDPHYSICS_API 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`.

static USDPHYSICS_API UsdPhysicsLimitAPI	Apply (const UsdPrim &prim, const TfToken &name)
	Applies this multiple-apply API schema to the given `prim` along with the given instance name, `name`.

Static Public Member Functions inherited from UsdAPISchemaBase
static USD_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.

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::MultipleApplyAPI
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
USDPHYSICS_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on UsdPrim `prim` with the specified `instanceName`.

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on the prim held by `schemaObj` with the given `instanceName`.

const TfToken &	_GetInstanceName () const
	Returns the instance name of the API schema object belonging to a multiple-apply API schema.

USD_API bool	_IsCompatible () const override
	Check whether this APISchema object is valid for the currently held prim.

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

Additional Inherited Members
Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector	_GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)
	Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim.

Detailed Description

The PhysicsLimitAPI can be applied to a PhysicsJoint and will restrict the movement along an axis.

PhysicsLimitAPI is a multipleApply schema: The PhysicsJoint can be restricted along "transX", "transY", "transZ", "rotX", "rotY", "rotZ", "distance". Setting these as a multipleApply schema TfToken name will define the degree of freedom the PhysicsLimitAPI is applied to. Note that if the low limit is higher than the high limit, motion along this axis is considered locked.

Definition at line 46 of file limitAPI.h.

Constructor & Destructor Documentation

◆ UsdPhysicsLimitAPI() [1/2]

UsdPhysicsLimitAPI	(	const UsdPrim &	prim = `UsdPrim()`,
		const TfToken &	name = `TfToken()`
	)

inlineexplicit

Construct a UsdPhysicsLimitAPI on UsdPrim prim with name name .

Equivalent to UsdPhysicsLimitAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "limit:name"));

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

Definition at line 63 of file limitAPI.h.

◆ UsdPhysicsLimitAPI() [2/2]

UsdPhysicsLimitAPI	(	const UsdSchemaBase &	schemaObj,
		const TfToken &	name
	)

inlineexplicit

Construct a UsdPhysicsLimitAPI on the prim held by schemaObj with name name.

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

Definition at line 72 of file limitAPI.h.

◆ ~UsdPhysicsLimitAPI()

virtual USDPHYSICS_API ~UsdPhysicsLimitAPI ( )

virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

USDPHYSICS_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDPHYSICS_API UsdPhysicsLimitAPI Apply	(	const UsdPrim &	prim,
		const TfToken &	name
	)

static

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

This information is stored by adding "PhysicsLimitAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'PhysicsLimitAPI:instance1' is added to 'apiSchemas'.

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

See also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

◆ CanApply()

static USDPHYSICS_API bool CanApply	(	const UsdPrim &	prim,
		const TfToken &	name,
		std::string *	whyNot = `nullptr`
	)

static

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(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

◆ CreateHighAttr()

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

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

◆ CreateLowAttr()

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

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

◆ Get() [1/2]

static USDPHYSICS_API UsdPhysicsLimitAPI Get	(	const UsdPrim &	prim,
		const TfToken &	name
	)

static

Return a UsdPhysicsLimitAPI with name name holding the prim prim.

Shorthand for UsdPhysicsLimitAPI(prim, name);

◆ Get() [2/2]

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

static

Return a UsdPhysicsLimitAPI 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 <path>.limit:name .

This is shorthand for the following:

TfToken name = SdfPath::StripNamespace(path.GetToken());
UsdPhysicsLimitAPI(
    stage->GetPrimAtPath(path.GetPrimPath()), name);

◆ GetAll()

static USDPHYSICS_API std::vector< UsdPhysicsLimitAPI > GetAll ( const UsdPrim & prim )

static

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

◆ GetHighAttr()

USDPHYSICS_API UsdAttribute GetHighAttr ( ) const

Upper limit.

Units: degrees or distance depending on trans or rot axis applied to. inf means not limited in positive direction.


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

◆ GetLowAttr()

USDPHYSICS_API UsdAttribute GetLowAttr ( ) const

Lower limit.

Units: degrees or distance depending on trans or rot axis applied to. -inf means not limited in negative direction.


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

◆ GetName()

TfToken GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 98 of file limitAPI.h.

◆ GetSchemaAttributeNames() [1/2]

static USDPHYSICS_API TfTokenVector GetSchemaAttributeNames	(	bool	includeInherited,
		const TfToken &	instanceName
	)

static

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.

◆ GetSchemaAttributeNames() [2/2]

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.

◆ IsPhysicsLimitAPIPath()

static USDPHYSICS_API bool IsPhysicsLimitAPIPath	(	const SdfPath &	path,
		TfToken *	name
	)

static

Checks if the given path path is of an API schema of type PhysicsLimitAPI.

If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

◆ IsSchemaPropertyBaseName()

static USDPHYSICS_API bool IsSchemaPropertyBaseName ( const TfToken & baseName )

static

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

Friends And Related Function Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 198 of file limitAPI.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI

static

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

See also: UsdSchemaKind

Definition at line 52 of file limitAPI.h.

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

pxr/usd/usdPhysics/limitAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UsdPhysicsLimitAPI() [1/2]

◆ UsdPhysicsLimitAPI() [2/2]

◆ ~UsdPhysicsLimitAPI()

Member Function Documentation

◆ _GetSchemaKind()

◆ Apply()

◆ CanApply()

◆ CreateHighAttr()

◆ CreateLowAttr()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetAll()

◆ GetHighAttr()

◆ GetLowAttr()

◆ GetName()

◆ GetSchemaAttributeNames() [1/2]

◆ GetSchemaAttributeNames() [2/2]

◆ IsPhysicsLimitAPIPath()

◆ IsSchemaPropertyBaseName()

Friends And Related Function Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind