#include <generativeProceduralAPI.h>

Inheritance diagram for UsdHydraGenerativeProceduralAPI:

Public Member Functions
	UsdHydraGenerativeProceduralAPI (const UsdPrim &prim=UsdPrim())

	UsdHydraGenerativeProceduralAPI (const UsdSchemaBase &schemaObj)

virtual USDHYDRA_API	~UsdHydraGenerativeProceduralAPI ()
	Destructor. More...

USDHYDRA_API UsdAttribute	GetProceduralTypeAttr () const

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

USDHYDRA_API UsdAttribute	GetProceduralSystemAttr () const

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

static USDHYDRA_API UsdHydraGenerativeProceduralAPI	Get (const UsdStagePtr &stage, const SdfPath &path)

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

static USDHYDRA_API UsdHydraGenerativeProceduralAPI	Apply (const UsdPrim &prim)

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::SingleApplyAPI

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

Protected Member Functions inherited from UsdAPISchemaBase
	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

This API extends and configures the core UsdProcGenerativeProcedural schema defined within usdProc for use with hydra generative procedurals as defined within hdGp.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdHydraTokens. So to set an attribute to the value "rightHanded", use UsdHydraTokens->rightHanded as the value.

Definition at line 66 of file generativeProceduralAPI.h.

Constructor & Destructor Documentation

UsdHydraGenerativeProceduralAPI::UsdHydraGenerativeProceduralAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

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

Definition at line 78 of file generativeProceduralAPI.h.

UsdHydraGenerativeProceduralAPI::UsdHydraGenerativeProceduralAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

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

Definition at line 86 of file generativeProceduralAPI.h.

virtual USDHYDRA_API UsdHydraGenerativeProceduralAPI::~UsdHydraGenerativeProceduralAPI ( )

virtual

Destructor.

Member Function Documentation

USDHYDRA_API UsdSchemaKind UsdHydraGenerativeProceduralAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDHYDRA_API UsdHydraGenerativeProceduralAPI UsdHydraGenerativeProceduralAPI::Apply ( const UsdPrim & prim )

static

Applies this single-apply API schema to the given prim. This information is stored by adding "HydraGenerativeProceduralAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns: A valid UsdHydraGenerativeProceduralAPI object is returned upon success. An invalid (or empty) UsdHydraGenerativeProceduralAPI 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 USDHYDRA_API bool UsdHydraGenerativeProceduralAPI::CanApply	(	const UsdPrim &	prim,
		std::string *	whyNot = `nullptr`
	)

static

Returns true if this single-apply API schema can be applied to the given prim. If this schema can not be a applied to 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()

USDHYDRA_API UsdAttribute UsdHydraGenerativeProceduralAPI::CreateProceduralSystemAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDHYDRA_API UsdAttribute UsdHydraGenerativeProceduralAPI::CreateProceduralTypeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

static

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

UsdHydraGenerativeProceduralAPI(stage->GetPrimAtPath(path));

USDHYDRA_API UsdAttribute UsdHydraGenerativeProceduralAPI::GetProceduralSystemAttr ( ) const

This value should correspond to a configured instance of HdGpGenerativeProceduralResolvingSceneIndex which will evaluate the procedural. The default value of "hydraGenerativeProcedural" matches the equivalent default of HdGpGenerativeProceduralResolvingSceneIndex. Multiple instances of the scene index can be used to determine where within a scene index chain a given procedural will be evaluated.


Declaration	`token proceduralSystem = "hydraGenerativeProcedural"`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token

USDHYDRA_API UsdAttribute UsdHydraGenerativeProceduralAPI::GetProceduralTypeAttr ( ) const

The registered name of a HdGpGenerativeProceduralPlugin to be executed.


Declaration	`token primvars:hdGp:proceduralType`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token

static USDHYDRA_API const TfTokenVector& UsdHydraGenerativeProceduralAPI::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 Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 164 of file generativeProceduralAPI.h.

Member Data Documentation

const UsdSchemaKind UsdHydraGenerativeProceduralAPI::schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also: UsdSchemaKind

Definition at line 72 of file generativeProceduralAPI.h.

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

pxr/usd/usdHydra/generativeProceduralAPI.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation