An invertible controller that can determine which of several rigs are active at a given time, depending on the value of a switch attribute. More...

#include <switchController.h>

Inheritance diagram for ExecIrSwitchController:

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

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

virtual EXECIR_API	~ExecIrSwitchController ()
	Destructor.

EXECIR_API UsdAttribute	GetRig1SpaceAttr () const

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

EXECIR_API UsdAttribute	GetRig2SpaceAttr () const

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

EXECIR_API UsdAttribute	GetOutSpaceAttr () const

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

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

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

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

static EXECIR_API ExecIrSwitchController	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 ExecIrIrController
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 ExecIrIrController	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a ExecIrIrController 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 ExecIrIrController
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 ExecIrIrController
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 invertible controller that can determine which of several rigs are active at a given time, depending on the value of a switch attribute.

Note: The functionality provided by this schema is extremely limited, subject to change, and not yet ready for production use. In particular, this schema is hard coded to support two rigs, named "rig1" and "rig2". In the future, a general switch controller schema will likely be configurable via application of multi-apply schemas. This will allow switch controllers to switch among more than two rigs with arbitrary names.

Definition at line 50 of file switchController.h.

Constructor & Destructor Documentation

◆ ExecIrSwitchController() [1/2]

ExecIrSwitchController ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a ExecIrSwitchController on UsdPrim prim .

Equivalent to ExecIrSwitchController::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 switchController.h.

◆ ExecIrSwitchController() [2/2]

ExecIrSwitchController ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a ExecIrSwitchController on the prim held by schemaObj .

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

Definition at line 70 of file switchController.h.

◆ ~ExecIrSwitchController()

virtual EXECIR_API ~ExecIrSwitchController ( )

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 ExecIrIrController.

◆ CreateOutSpaceAttr()

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

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

◆ CreateRig1SpaceAttr()

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

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

◆ CreateRig2SpaceAttr()

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

See GetRig2SpaceAttr(), 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 ExecIrSwitchController 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 ExecIrSwitchController Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path )

static

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

ExecIrSwitchController(stage->GetPrimAtPath(path));

ExecIrSwitchController::ExecIrSwitchController

ExecIrSwitchController(const UsdPrim &prim=UsdPrim())

Construct a ExecIrSwitchController on UsdPrim prim .

Definition switchController.h:62

◆ GetOutSpaceAttr()

EXECIR_API UsdAttribute GetOutSpaceAttr ( ) const


Declaration	`matrix4d out:space = ( (1, 0, 0, 0), (0, 1, 0, 0), (0, 0, 1, 0), (0, 0, 0, 1) )`
C++ Type	GfMatrix4d
Usd Type	SdfValueTypeNames->Matrix4d

◆ GetRig1SpaceAttr()

EXECIR_API UsdAttribute GetRig1SpaceAttr ( ) const


Declaration	`matrix4d rig1:space = ( (1, 0, 0, 0), (0, 1, 0, 0), (0, 0, 1, 0), (0, 0, 0, 1) )`
C++ Type	GfMatrix4d
Usd Type	SdfValueTypeNames->Matrix4d

◆ GetRig2SpaceAttr()

EXECIR_API UsdAttribute GetRig2SpaceAttr ( ) const


Declaration	`matrix4d rig2:space = ( (1, 0, 0, 0), (0, 1, 0, 0), (0, 0, 1, 0), (0, 0, 0, 1) )`
C++ Type	GfMatrix4d
Usd Type	SdfValueTypeNames->Matrix4d

◆ 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 switchController.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 switchController.h.

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

pxr/exec/execIr/switchController.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ExecIrSwitchController() [1/2]

◆ ExecIrSwitchController() [2/2]

◆ ~ExecIrSwitchController()

Member Function Documentation

◆ _GetSchemaKind()

◆ CreateOutSpaceAttr()

◆ CreateRig1SpaceAttr()

◆ CreateRig2SpaceAttr()

◆ Define()

◆ Get()

◆ GetOutSpaceAttr()

◆ GetRig1SpaceAttr()

◆ GetRig2SpaceAttr()

◆ GetSchemaAttributeNames()

Friends And Related Symbol Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind