A concrete typed schema that represents the joint of an armature-based model. More...

#include <jointScope.h>

Inheritance diagram for ExecIrJointScope:

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

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

virtual EXECIR_API	~ExecIrJointScope ()
	Destructor.

EXECIR_API UsdAttribute	GetGuideLengthAttr () const

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

EXECIR_API UsdAttribute	GetGuideDisplayColorAttr () const

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

EXECIR_API UsdAttribute	GetGuideDisplayOpacityAttr () const

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

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

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

virtual EXECIR_API	~ExecIrXformable ()
	Destructor.

EXECIR_API UsdAttribute	GetRestTxAttr () const

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

EXECIR_API UsdAttribute	GetRestTyAttr () const

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

EXECIR_API UsdAttribute	GetRestTzAttr () const

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

EXECIR_API UsdAttribute	GetRestRxAttr () const

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

EXECIR_API UsdAttribute	GetRestRyAttr () const

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

EXECIR_API UsdAttribute	GetRestRzAttr () const

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

EXECIR_API UsdAttribute	GetRestSpaceAttr () const

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

EXECIR_API UsdAttribute	GetDefaultTxAttr () const

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

EXECIR_API UsdAttribute	GetDefaultTyAttr () const

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

EXECIR_API UsdAttribute	GetDefaultTzAttr () const

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

EXECIR_API UsdAttribute	GetDefaultRxAttr () const

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

EXECIR_API UsdAttribute	GetDefaultRyAttr () const

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

EXECIR_API UsdAttribute	GetDefaultRzAttr () const

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

EXECIR_API UsdAttribute	GetDefaultSpaceAttr () const

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

EXECIR_API UsdAttribute	GetPosedSpaceAttr () const

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

EXECIR_API UsdAttribute	GetPosedDefaultSpaceAttr () const

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

EXECIR_API UsdAttribute	GetAvarsTxAttr () const

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

EXECIR_API UsdAttribute	GetAvarsTyAttr () const

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

EXECIR_API UsdAttribute	GetAvarsTzAttr () const

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

EXECIR_API UsdAttribute	GetAvarsRxAttr () const

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

EXECIR_API UsdAttribute	GetAvarsRyAttr () const

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

EXECIR_API UsdAttribute	GetAvarsRzAttr () const

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

EXECIR_API UsdAttribute	GetAvarsRspinAttr () const

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

EXECIR_API UsdAttribute	GetAvarsRotationOrderAttr () const

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

EXECIR_API UsdAttribute	GetAvarsDefaultSpaceAttr () const

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

EXECIR_API UsdAttribute	GetAvarsUnitScaleFactorAttr () const

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

EXECIR_API UsdAttribute	GetParentSpaceAttr () const

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

EXECIR_API UsdAttribute	GetParentDefaultSpaceAttr () const

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

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

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

virtual USD_API	~UsdTyped ()
	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 EXECIR_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 EXECIR_API ExecIrJointScope	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a ExecIrJointScope holding the prim adhering to this schema at `path` on `stage`.

static EXECIR_API ExecIrJointScope	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.

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

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

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

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

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

Static Public Attributes inherited from UsdTyped
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
EXECIR_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

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

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

USD_API bool	_IsCompatible () const override
	Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility.

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

A concrete typed schema that represents the joint of an armature-based model.

The base schema IrXformable defines the behavior; this schema exists mainly so we can specialize drawing of guides, etc. In the future, other concrete schemas will also extend IrXformable.

Note: The functionality provided by this schema is extremely limited, subject to change, and not yet ready for production use.

Definition at line 50 of file jointScope.h.

Constructor & Destructor Documentation

◆ ExecIrJointScope() [1/2]

ExecIrJointScope ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a ExecIrJointScope on UsdPrim prim .

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

Definition at line 62 of file jointScope.h.

◆ ExecIrJointScope() [2/2]

ExecIrJointScope ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a ExecIrJointScope on the prim held by schemaObj .

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

Definition at line 70 of file jointScope.h.

◆ ~ExecIrJointScope()

virtual EXECIR_API ~ExecIrJointScope ( )

virtual

Destructor.

Member Function Documentation

◆ _GetSchemaKind()

EXECIR_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdSchemaBase.

◆ CreateGuideDisplayColorAttr()

EXECIR_API UsdAttribute CreateGuideDisplayColorAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false ) const

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

◆ CreateGuideDisplayOpacityAttr()

EXECIR_API UsdAttribute CreateGuideDisplayOpacityAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false ) const

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

◆ CreateGuideLengthAttr()

EXECIR_API UsdAttribute CreateGuideLengthAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false ) const

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

◆ Define()

static EXECIR_API ExecIrJointScope 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.

◆ Get()

static EXECIR_API ExecIrJointScope Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path )

static

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

ExecIrJointScope(stage->GetPrimAtPath(path));

ExecIrJointScope::ExecIrJointScope

ExecIrJointScope(const UsdPrim &prim=UsdPrim())

Construct a ExecIrJointScope on UsdPrim prim .

Definition jointScope.h:62

◆ GetGuideDisplayColorAttr()

EXECIR_API UsdAttribute GetGuideDisplayColorAttr ( ) const


Declaration	`color3f guide:displayColor = (1, 0.3, 0.3)`
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Color3f

◆ GetGuideDisplayOpacityAttr()

EXECIR_API UsdAttribute GetGuideDisplayOpacityAttr ( ) const


Declaration	`float guide:displayOpacity = 0.5`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

◆ GetGuideLengthAttr()

EXECIR_API UsdAttribute GetGuideLengthAttr ( ) const


Declaration	`double guide:length = 0`
C++ Type	double
Usd Type	SdfValueTypeNames->Double

◆ GetSchemaAttributeNames()

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

Friends And Related Symbol Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 134 of file jointScope.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped

static

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

See also: UsdSchemaKind

Definition at line 56 of file jointScope.h.

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

pxr/exec/execIr/jointScope.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ExecIrJointScope() [1/2]

◆ ExecIrJointScope() [2/2]

◆ ~ExecIrJointScope()

Member Function Documentation

◆ _GetSchemaKind()

◆ CreateGuideDisplayColorAttr()

◆ CreateGuideDisplayOpacityAttr()

◆ CreateGuideLengthAttr()

◆ Define()

◆ Get()

◆ GetGuideDisplayColorAttr()

◆ GetGuideDisplayOpacityAttr()

◆ GetGuideLengthAttr()

◆ GetSchemaAttributeNames()

Friends And Related Symbol Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind