#include <houdiniProceduralAPI.h>

Inheritance diagram for UsdHoudiniHoudiniProceduralAPI:

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

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

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

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

UsdAttribute	GetHoudiniProceduralTypeAttr () const

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

UsdAttribute	GetHoudiniProceduralPathAttr () const

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

UsdAttribute	GetHoudiniProceduralArgsAttr () const

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

UsdAttribute	GetHoudiniActiveAttr () const

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

UsdAttribute	GetHoudiniPriorityAttr () const

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

UsdAttribute	GetHoudiniAnimatedAttr () const

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

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

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

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

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

static bool	IsSchemaPropertyBaseName (const TfToken &baseName)

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

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

static UsdHoudiniHoudiniProceduralAPI	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

Definition at line 56 of file houdiniProceduralAPI.h.

Constructor & Destructor Documentation

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

inlineexplicit

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

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

Definition at line 75 of file houdiniProceduralAPI.h.

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

inlineexplicit

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

Definition at line 84 of file houdiniProceduralAPI.h.

virtual UsdHoudiniHoudiniProceduralAPI::~UsdHoudiniHoudiniProceduralAPI ( )

overridevirtual

Destructor.

Member Function Documentation

UsdSchemaKind UsdHoudiniHoudiniProceduralAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdSchemaBase.

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

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

UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniActiveAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniAnimatedAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniPriorityAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniProceduralArgsAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniProceduralPathAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniProceduralTypeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

static

Return a UsdHoudiniHoudiniProceduralAPI 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>.houdiniProcedural:name .

This is shorthand for the following:

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

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

static

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

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

static

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

UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniActiveAttr ( ) const


Declaration	`bool houdini:active = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniAnimatedAttr ( ) const


Declaration	`uniform bool houdini:animated = 0`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool
Variability	SdfVariabilityUniform

UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniPriorityAttr ( ) const


Declaration	`int houdini:priority = 0`
C++ Type	int
Usd Type	SdfValueTypeNames->Int

UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniProceduralArgsAttr ( ) const


Declaration	`string houdini:procedural:args = ""`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String

UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniProceduralPathAttr ( ) const


Declaration	`asset houdini:procedural:path = @@`
C++ Type	SdfAssetPath
Usd Type	SdfValueTypeNames->Asset

UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniProceduralTypeAttr ( ) const


Declaration	`string houdini:procedural:type = ""`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String

TfToken UsdHoudiniHoudiniProceduralAPI::GetName ( ) const

inline

Returns the name of this multiple-apply schema instance.

Definition at line 107 of file houdiniProceduralAPI.h.

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

static

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

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

static

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