#include <limitAPI.h>

Inheritance diagram for UsdPhysicsLimitAPI:

Public Member Functions
	UsdPhysicsLimitAPI (const UsdPrim &prim=UsdPrim(), const TfToken &name=TfToken())

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

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

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

USDPHYSICS_API UsdAttribute	GetLowAttr () const

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

USDPHYSICS_API UsdAttribute	GetHighAttr () const

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

Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)

virtual USD_API	~UsdAPISchemaBase ()=0
	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 TfTokenVector	GetSchemaAttributeNames (bool includeInherited, const TfToken &instanceName)

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

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

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

static USDPHYSICS_API bool	IsSchemaPropertyBaseName (const TfToken &baseName)

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

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

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

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

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

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::MultipleApplyAPI

Static Public Attributes inherited from UsdAPISchemaBase
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 UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)

const TfToken &	_GetInstanceName () const

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

Additional Inherited Members
Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector	_GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)

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 63 of file limitAPI.h.

Constructor & Destructor Documentation

UsdPhysicsLimitAPI::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 80 of file limitAPI.h.

UsdPhysicsLimitAPI::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 89 of file limitAPI.h.

virtual USDPHYSICS_API UsdPhysicsLimitAPI::~UsdPhysicsLimitAPI ( )

virtual

Destructor.

Member Function Documentation

USDPHYSICS_API UsdSchemaKind UsdPhysicsLimitAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDPHYSICS_API UsdPhysicsLimitAPI 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()

static USDPHYSICS_API bool UsdPhysicsLimitAPI::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()

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

See GetHighAttr(), 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 UsdPhysicsLimitAPI::CreateLowAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

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

static

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

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

static

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

USDPHYSICS_API UsdAttribute UsdPhysicsLimitAPI::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

USDPHYSICS_API UsdAttribute UsdPhysicsLimitAPI::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

TfToken UsdPhysicsLimitAPI::GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 115 of file limitAPI.h.

static USDPHYSICS_API const TfTokenVector& UsdPhysicsLimitAPI::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.

static USDPHYSICS_API TfTokenVector UsdPhysicsLimitAPI::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.

static USDPHYSICS_API bool UsdPhysicsLimitAPI::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.

static USDPHYSICS_API bool UsdPhysicsLimitAPI::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

friend class UsdSchemaRegistry

friend

Definition at line 215 of file limitAPI.h.

Member Data Documentation

const UsdSchemaKind UsdPhysicsLimitAPI::schemaKind = UsdSchemaKind::MultipleApplyAPI

static

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

See Also: UsdSchemaKind

Definition at line 69 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

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation