#include <houdiniApexCharacterBindingAPI.h>

Inheritance diagram for UsdHoudiniHoudiniApexCharacterBindingAPI:

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

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

virtual	~UsdHoudiniHoudiniApexCharacterBindingAPI () override
	Destructor. More...

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

UsdAttribute	GetRigAttr () const

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

UsdRelationship	GetBindingRel () const

UsdRelationship	CreateBindingRel () 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 const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

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

static UsdHoudiniHoudiniApexCharacterBindingAPI	Get (const UsdStagePtr &stage, const SdfPath &path)

static UsdHoudiniHoudiniApexCharacterBindingAPI	Get (const UsdPrim &prim, const TfToken &name)

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

static bool	IsSchemaPropertyBaseName (const TfToken &baseName)

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

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

static UsdHoudiniHoudiniApexCharacterBindingAPI	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
UsdSchemaKind	_GetSchemaKind () const override

Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind	_GetSchemaKind () const override

	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

Houdini API schema for adding a character to an APEX animation scene. This is intended for use with HoudiniApexScene prims.

The schema's instance name (e.g. 'electra') is used as the character's name in the APEX scene (e.g. '/electra.char')

Definition at line 45 of file houdiniApexCharacterBindingAPI.h.

Constructor & Destructor Documentation

UsdHoudiniHoudiniApexCharacterBindingAPI::UsdHoudiniHoudiniApexCharacterBindingAPI	(	const UsdPrim &	prim = `UsdPrim()`,
		const TfToken &	name = `TfToken()`
	)

inlineexplicit

Construct a UsdHoudiniHoudiniApexCharacterBindingAPI on UsdPrim prim with name name . Equivalent to UsdHoudiniHoudiniApexCharacterBindingAPI::Get( prim.GetStage(), prim.GetPath().AppendProperty( "character:name"));

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

Definition at line 64 of file houdiniApexCharacterBindingAPI.h.

UsdHoudiniHoudiniApexCharacterBindingAPI::UsdHoudiniHoudiniApexCharacterBindingAPI	(	const UsdSchemaBase &	schemaObj,
		const TfToken &	name
	)

inlineexplicit

Construct a UsdHoudiniHoudiniApexCharacterBindingAPI on the prim held by schemaObj with name name. Should be preferred over UsdHoudiniHoudiniApexCharacterBindingAPI(schemaObj.GetPrim(), name), as it preserves SchemaBase state.

Definition at line 73 of file houdiniApexCharacterBindingAPI.h.

virtual UsdHoudiniHoudiniApexCharacterBindingAPI::~UsdHoudiniHoudiniApexCharacterBindingAPI ( )

overridevirtual

Destructor.

Member Function Documentation

UsdSchemaKind UsdHoudiniHoudiniApexCharacterBindingAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdSchemaBase.

static UsdHoudiniHoudiniApexCharacterBindingAPI UsdHoudiniHoudiniApexCharacterBindingAPI::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 "HoudiniApexCharacterBindingAPI:<i>name</i>" to the token-valued, listOp metadata apiSchemas on the prim. For example, if name is 'instance1', the token 'HoudiniApexCharacterBindingAPI:instance1' is added to 'apiSchemas'.

Returns: A valid UsdHoudiniHoudiniApexCharacterBindingAPI object is returned upon success. An invalid (or empty) UsdHoudiniHoudiniApexCharacterBindingAPI 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 bool UsdHoudiniHoudiniApexCharacterBindingAPI::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()

UsdRelationship UsdHoudiniHoudiniApexCharacterBindingAPI::CreateBindingRel ( ) const

See GetBindingRel(), and also Usd_Create_Or_Get_Property for when to use Get vs Create

UsdAttribute UsdHoudiniHoudiniApexCharacterBindingAPI::CreateRigAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

See GetRigAttr(), 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 UsdHoudiniHoudiniApexCharacterBindingAPI UsdHoudiniHoudiniApexCharacterBindingAPI::Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Return a UsdHoudiniHoudiniApexCharacterBindingAPI 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>.character:name .

This is shorthand for the following:

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

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

static

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

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

static

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

UsdRelationship UsdHoudiniHoudiniApexCharacterBindingAPI::GetBindingRel ( ) const

Relationship specifying the character to bind to the scene (a primitive with the HoudiniApexCharacterAPI schema).

TfToken UsdHoudiniHoudiniApexCharacterBindingAPI::GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 96 of file houdiniApexCharacterBindingAPI.h.

UsdAttribute UsdHoudiniHoudiniApexCharacterBindingAPI::GetRigAttr ( ) const

Specifies which rig to use for the character (for example, "Base.rig"). If authored, this value takes precedence over the 'houdini:apex:character:rig' attribute from HoudiniApexCharacterAPI.


Declaration	`uniform string rig = ""`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String
Variability	SdfVariabilityUniform

static const TfTokenVector& UsdHoudiniHoudiniApexCharacterBindingAPI::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 TfTokenVector UsdHoudiniHoudiniApexCharacterBindingAPI::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 bool UsdHoudiniHoudiniApexCharacterBindingAPI::IsHoudiniApexCharacterBindingAPIPath	(	const SdfPath &	path,
		TfToken *	name
	)

static

Checks if the given path path is of an API schema of type HoudiniApexCharacterBindingAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.

static bool UsdHoudiniHoudiniApexCharacterBindingAPI::IsSchemaPropertyBaseName ( const TfToken & baseName )

static

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