#include <materialAPI.h>

Inheritance diagram for UsdRiMaterialAPI:

Public Member Functions
	UsdRiMaterialAPI (const UsdPrim &prim=UsdPrim())
	Construct a UsdRiMaterialAPI on UsdPrim `prim` .

	UsdRiMaterialAPI (const UsdSchemaBase &schemaObj)
	Construct a UsdRiMaterialAPI on the prim held by `schemaObj` .

virtual USDRI_API	~UsdRiMaterialAPI ()
	Destructor.

USDRI_API UsdAttribute	GetSurfaceAttr () const

USDRI_API UsdAttribute	CreateSurfaceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSurfaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRI_API UsdAttribute	GetDisplacementAttr () const

USDRI_API UsdAttribute	CreateDisplacementAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDisplacementAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDRI_API UsdAttribute	GetVolumeAttr () const

USDRI_API UsdAttribute	CreateVolumeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetVolumeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

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

USDRI_API UsdShadeNodeGraph::InterfaceInputConsumersMap	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.

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

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

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

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
	Returns a valid shader object if the "surface" output on the material is connected to one.

USDRI_API UsdShadeShader	GetDisplacement (bool ignoreBaseMaterial=false) const
	Returns a valid shader object if the "displacement" output on the material is connected to one.

USDRI_API UsdShadeShader	GetVolume (bool ignoreBaseMaterial=false) const
	Returns a valid shader object if the "volume" output on the material is connected to one.

Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
	Construct a UsdAPISchemaBase on UsdPrim `prim` .

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
	Construct a UsdAPISchemaBase on the prim held by `schemaObj` .

virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor.

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
	Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.

bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped.

bool	IsAPISchema () const
	Returns whether this is an API schema or not.

bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not.

bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not.

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is.

USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store `prim` as the held prim.

USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by `otherSchema`.

virtual USD_API	~UsdSchemaBase ()
	Destructor.

UsdPrim	GetPrim () const
	Return this schema object's held prim.

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath().

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null.

USD_API	operator bool () const
	Return true if this schema object is compatible with its held prim, false otherwise.

Static Public Member Functions
static USDRI_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

static USDRI_API UsdRiMaterialAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdRiMaterialAPI holding the prim adhering to this schema at `path` on `stage`.

static USDRI_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
	Returns true if this single-apply API schema can be applied to the given `prim`.

static USDRI_API UsdRiMaterialAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`.

Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
USDRI_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on UsdPrim `prim` with the specified `instanceName`.

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on the prim held by `schemaObj` with the given `instanceName`.

const TfToken &	_GetInstanceName () const
	Returns the instance name of the API schema object belonging to a multiple-apply API schema.

USD_API bool	_IsCompatible () const override
	Check whether this APISchema object is valid for the currently held prim.

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)
	Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim.

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 55 of file materialAPI.h.

Constructor & Destructor Documentation

◆ UsdRiMaterialAPI() [1/3]

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 67 of file materialAPI.h.

◆ UsdRiMaterialAPI() [2/3]

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 75 of file materialAPI.h.

◆ ~UsdRiMaterialAPI()

virtual USDRI_API ~UsdRiMaterialAPI ( )

virtual

Destructor.

◆ UsdRiMaterialAPI() [3/3]

UsdRiMaterialAPI ( const UsdShadeMaterial & material )

inlineexplicit

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

Definition at line 242 of file materialAPI.h.

Member Function Documentation

◆ _GetSchemaKind()

USDRI_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDRI_API 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()

◆ CanApply()

static USDRI_API bool 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()

◆ ComputeInterfaceInputConsumersMap()

USDRI_API UsdShadeNodeGraph::InterfaceInputConsumersMap 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.

◆ CreateDisplacementAttr()

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

See GetDisplacementAttr(), and also Create vs Get Property Methods 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.

◆ CreateSurfaceAttr()

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

See GetSurfaceAttr(), and also Create vs Get Property Methods 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.

◆ CreateVolumeAttr()

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

See GetVolumeAttr(), and also Create vs Get Property Methods 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.

◆ Get()

static USDRI_API 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));

UsdRiMaterialAPI

Definition: materialAPI.h:56

◆ GetDisplacement()

USDRI_API UsdShadeShader 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.

◆ GetDisplacementAttr()

USDRI_API UsdAttribute GetDisplacementAttr ( ) const


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

◆ GetDisplacementOutput()

USDRI_API UsdShadeOutput GetDisplacementOutput ( ) const

Returns the "displacement" output associated with the material.

◆ GetSchemaAttributeNames()

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

◆ GetSurface()

USDRI_API UsdShadeShader 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.

◆ GetSurfaceAttr()

USDRI_API UsdAttribute GetSurfaceAttr ( ) const


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

◆ GetSurfaceOutput()

USDRI_API UsdShadeOutput GetSurfaceOutput ( ) const

Returns the "surface" output associated with the material.

◆ GetVolume()

USDRI_API UsdShadeShader 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.

◆ GetVolumeAttr()

USDRI_API UsdAttribute GetVolumeAttr ( ) const


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

◆ GetVolumeOutput()

USDRI_API UsdShadeOutput GetVolumeOutput ( ) const

Returns the "volume" output associated with the material.

Friends And Related Function Documentation

◆ UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 153 of file materialAPI.h.

Member Data Documentation

◆ schemaKind

const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See also: UsdSchemaKind

Definition at line 61 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

◆ UsdRiMaterialAPI() [1/3]

◆ UsdRiMaterialAPI() [2/3]

◆ ~UsdRiMaterialAPI()

◆ UsdRiMaterialAPI() [3/3]

Member Function Documentation

◆ _GetSchemaKind()

◆ Apply()

◆ CanApply()

◆ ComputeInterfaceInputConsumersMap()

◆ CreateDisplacementAttr()

◆ CreateSurfaceAttr()

◆ CreateVolumeAttr()

◆ Get()

◆ GetDisplacement()

◆ GetDisplacementAttr()

◆ GetDisplacementOutput()

◆ GetSchemaAttributeNames()

◆ GetSurface()

◆ GetSurfaceAttr()

◆ GetSurfaceOutput()

◆ GetVolume()

◆ GetVolumeAttr()

◆ GetVolumeOutput()

Friends And Related Function Documentation

◆ UsdSchemaRegistry

Member Data Documentation

◆ schemaKind