#include <materialXConfigAPI.h>

Inheritance diagram for UsdMtlxMaterialXConfigAPI:

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

	UsdMtlxMaterialXConfigAPI (const UsdSchemaBase &schemaObj)

virtual USDMTLX_API	~UsdMtlxMaterialXConfigAPI ()
	Destructor. More...

USDMTLX_API UsdAttribute	GetConfigMtlxVersionAttr () const

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

static USDMTLX_API UsdMtlxMaterialXConfigAPI	Get (const UsdStagePtr &stage, const SdfPath &path)

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

static USDMTLX_API UsdMtlxMaterialXConfigAPI	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
USDMTLX_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

MaterialXConfigAPI is an API schema that provides an interface for storing information about the MaterialX environment.

Initially, it only exposes an interface to record the MaterialX library version that data was authored against. The intention is to use this information to allow the MaterialX library to perform upgrades on data from prior MaterialX versions.

Definition at line 47 of file materialXConfigAPI.h.

Constructor & Destructor Documentation

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

inlineexplicit

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

Definition at line 59 of file materialXConfigAPI.h.

UsdMtlxMaterialXConfigAPI::UsdMtlxMaterialXConfigAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

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

Definition at line 67 of file materialXConfigAPI.h.

virtual USDMTLX_API UsdMtlxMaterialXConfigAPI::~UsdMtlxMaterialXConfigAPI ( )

virtual

Destructor.

Member Function Documentation

USDMTLX_API UsdSchemaKind UsdMtlxMaterialXConfigAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDMTLX_API UsdMtlxMaterialXConfigAPI UsdMtlxMaterialXConfigAPI::Apply ( const UsdPrim & prim )

static

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

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

USDMTLX_API UsdAttribute UsdMtlxMaterialXConfigAPI::CreateConfigMtlxVersionAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

static

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

UsdMtlxMaterialXConfigAPI(stage->GetPrimAtPath(path));

USDMTLX_API UsdAttribute UsdMtlxMaterialXConfigAPI::GetConfigMtlxVersionAttr ( ) const

MaterialX library version that the data has been authored against. Defaults to 1.38 to allow correct verisoning of old files.


Declaration	`string config:mtlx:version = "1.38"`
C++ Type	std::string
Usd Type	SdfValueTypeNames->String

static USDMTLX_API const TfTokenVector& UsdMtlxMaterialXConfigAPI::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 145 of file materialXConfigAPI.h.

Member Data Documentation

const UsdSchemaKind UsdMtlxMaterialXConfigAPI::schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also: UsdSchemaKind

Definition at line 53 of file materialXConfigAPI.h.

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

pxr/usd/usdMtlx/materialXConfigAPI.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