#include <materialAPI.h>

Inheritance diagram for UsdRiMaterialAPI:

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

	UsdRiMaterialAPI (const UsdSchemaBase &schemaObj)

virtual USDRI_API	~UsdRiMaterialAPI ()
	Destructor. More...

USDRI_API UsdAttribute	GetSurfaceAttr () const

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

USDRI_API UsdAttribute	GetDisplacementAttr () const

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

USDRI_API UsdAttribute	GetVolumeAttr () const

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

	UsdRiMaterialAPI (const UsdShadeMaterial &material)
	A constructor for creating a MaterialAPI object from a material prim. More...

USDRI_API UsdShadeNodeGraph::InterfaceInputConsumersMap	ComputeInterfaceInputConsumersMap (bool computeTransitiveConsumers=false) const

Outputs API
USDRI_API UsdShadeOutput	GetSurfaceOutput () const
	Returns the "surface" output associated with the material. More...

USDRI_API UsdShadeOutput	GetDisplacementOutput () const
	Returns the "displacement" output associated with the material. More...

USDRI_API UsdShadeOutput	GetVolumeOutput () const
	Returns the "volume" output associated with the material. More...

API for setting sources of outputs
USDRI_API bool	SetSurfaceSource (const SdfPath &surfacePath) const

USDRI_API bool	SetDisplacementSource (const SdfPath &displacementPath) const

USDRI_API bool	SetVolumeSource (const SdfPath &volumePath) const

Shaders API
USDRI_API UsdShadeShader	GetSurface (bool ignoreBaseMaterial=false) const

USDRI_API UsdShadeShader	GetDisplacement (bool ignoreBaseMaterial=false) const

USDRI_API UsdShadeShader	GetVolume (bool ignoreBaseMaterial=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 USDRI_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

static USDRI_API UsdRiMaterialAPI	Get (const UsdStagePtr &stage, const SdfPath &path)

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

static USDRI_API UsdRiMaterialAPI	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
USDRI_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

Deprecated:: Materials should use UsdShadeMaterial instead. This schema will be removed in a future release.

This API provides outputs that connect a material prim to prman shaders and RIS objects.

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

Definition at line 72 of file materialAPI.h.

Constructor & Destructor Documentation

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

inlineexplicit

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

Definition at line 84 of file materialAPI.h.

UsdRiMaterialAPI::UsdRiMaterialAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

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

Definition at line 92 of file materialAPI.h.

virtual USDRI_API UsdRiMaterialAPI::~UsdRiMaterialAPI ( )

virtual

Destructor.

UsdRiMaterialAPI::UsdRiMaterialAPI ( const UsdShadeMaterial & material )

inlineexplicit

A constructor for creating a MaterialAPI object from a material prim.

Definition at line 259 of file materialAPI.h.

Member Function Documentation

USDRI_API UsdSchemaKind UsdRiMaterialAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDRI_API UsdRiMaterialAPI UsdRiMaterialAPI::Apply ( const UsdPrim & prim )

static

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

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

USDRI_API UsdShadeNodeGraph::InterfaceInputConsumersMap UsdRiMaterialAPI::ComputeInterfaceInputConsumersMap ( bool computeTransitiveConsumers = false ) const

Walks the namespace subtree below the material and computes a map containing the list of all inputs on the material and the associated vector of consumers of their values. The consumers can be inputs on shaders within the material or on node-graphs under it.

USDRI_API UsdAttribute UsdRiMaterialAPI::CreateDisplacementAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDRI_API UsdAttribute UsdRiMaterialAPI::CreateSurfaceAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

USDRI_API UsdAttribute UsdRiMaterialAPI::CreateVolumeAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

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

static

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

UsdRiMaterialAPI(stage->GetPrimAtPath(path));

USDRI_API UsdShadeShader UsdRiMaterialAPI::GetDisplacement ( bool ignoreBaseMaterial = false ) const

Returns a valid shader object if the "displacement" output on the material is connected to one.

If ignoreBaseMaterial is true and if the "displacement" shader source is specified in the base-material of this material, then this returns an invalid shader object.

USDRI_API UsdAttribute UsdRiMaterialAPI::GetDisplacementAttr ( ) const


Declaration	`token outputs:ri:displacement`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token

USDRI_API UsdShadeOutput UsdRiMaterialAPI::GetDisplacementOutput ( ) const

Returns the "displacement" output associated with the material.

static USDRI_API const TfTokenVector& UsdRiMaterialAPI::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.

USDRI_API UsdShadeShader UsdRiMaterialAPI::GetSurface ( bool ignoreBaseMaterial = false ) const

Returns a valid shader object if the "surface" output on the material is connected to one.

If ignoreBaseMaterial is true and if the "surface" shader source is specified in the base-material of this material, then this returns an invalid shader object.

USDRI_API UsdAttribute UsdRiMaterialAPI::GetSurfaceAttr ( ) const


Declaration	`token outputs:ri:surface`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token

USDRI_API UsdShadeOutput UsdRiMaterialAPI::GetSurfaceOutput ( ) const

Returns the "surface" output associated with the material.

USDRI_API UsdShadeShader UsdRiMaterialAPI::GetVolume ( bool ignoreBaseMaterial = false ) const

Returns a valid shader object if the "volume" output on the material is connected to one.

If ignoreBaseMaterial is true and if the "volume" shader source is specified in the base-material of this material, then this returns an invalid shader object.

USDRI_API UsdAttribute UsdRiMaterialAPI::GetVolumeAttr ( ) const


Declaration	`token outputs:ri:volume`
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token

USDRI_API UsdShadeOutput UsdRiMaterialAPI::GetVolumeOutput ( ) const

Returns the "volume" output associated with the material.

USDRI_API bool UsdRiMaterialAPI::SetDisplacementSource ( const SdfPath & displacementPath ) const

USDRI_API bool UsdRiMaterialAPI::SetSurfaceSource ( const SdfPath & surfacePath ) const

USDRI_API bool UsdRiMaterialAPI::SetVolumeSource ( const SdfPath & volumePath ) const

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 170 of file materialAPI.h.

Member Data Documentation

const UsdSchemaKind UsdRiMaterialAPI::schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also: UsdSchemaKind

Definition at line 78 of file materialAPI.h.

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

pxr/usd/usdRi/materialAPI.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