An abstract schema that represents an invertible controller. More...

#include <controller.h>

Inheritance diagram for ExecIrController:

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

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

virtual EXECIR_API	~ExecIrController ()
	Destructor.

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 ExecIrController	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a ExecIrController 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::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 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

An abstract schema that represents an invertible controller.

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

Controllers have explicit input and output attributes, a forward computation that produces output values from input values and an inverse computation that computes the input values that satisfy a given set of desired output values.

Definition at line 50 of file controller.h.

Constructor & Destructor Documentation

◆ ExecIrController() [1/2]

ExecIrController ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a ExecIrController on UsdPrim prim .

Equivalent to ExecIrController::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 controller.h.

◆ ExecIrController() [2/2]

ExecIrController ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a ExecIrController on the prim held by schemaObj .

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

Definition at line 70 of file controller.h.

◆ ~ExecIrController()

virtual EXECIR_API ~ExecIrController ( )

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.

Reimplemented in ExecIrFkController, and ExecIrSwitchController.

◆ Get()

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

static

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

ExecIrController(stage->GetPrimAtPath(path));

ExecIrController::ExecIrController

ExecIrController(const UsdPrim &prim=UsdPrim())

Construct a ExecIrController on UsdPrim prim .

Definition controller.h:62

◆ 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 109 of file controller.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped

static

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

See also: UsdSchemaKind

Definition at line 56 of file controller.h.

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

pxr/exec/execIr/controller.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ExecIrController() [1/2]

◆ ExecIrController() [2/2]

◆ ~ExecIrController()

Member Function Documentation

◆ _GetSchemaKind()

◆ Get()

◆ GetSchemaAttributeNames()

Friends And Related Symbol Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind