Represents a node that holds shading information. More...

#include <shaderNode.h>

Public Types
using	ComplianceResults = std::unordered_map< TfToken, std::vector< SdrIdentifier >, TfToken::HashFunctor >

Public Member Functions
SDR_API	SdrShaderNode (const SdrIdentifier &identifier, const SdrVersion &version, const std::string &name, const TfToken &family, const TfToken &context, const TfToken &sourceType, const std::string &definitionURI, const std::string &implementationURI, SdrShaderPropertyUniquePtrVec &&properties, const SdrTokenMap &metadata=SdrTokenMap(), const std::string &sourceCode=std::string())
	Constructor.

virtual SDR_API	~SdrShaderNode ()
	Destructor.

SDR_API VtValue	GetDataForKey (const TfToken &key) const
	Gets an item of data from this shader node according to the requested key.

The Basics
const SdrIdentifier &	GetIdentifier () const
	Return the identifier of the node.

SdrVersion	GetShaderVersion () const
	Return the version of the node.

const std::string &	GetName () const
	Gets the name of the node.

const TfToken &	GetFamily () const
	Gets the name of the family that the node belongs to.

const TfToken &	GetContext () const
	Gets the context of the shader node.

const TfToken &	GetSourceType () const
	Gets the type of source that this shader node originated from.

const std::string &	GetResolvedDefinitionURI () const
	Gets the URI to the resource that provided this node's definition.

const std::string &	GetResolvedImplementationURI () const
	Gets the URI to the resource that provides this node's implementation.

const std::string &	GetSourceCode () const
	Returns the source code for this node.

SDR_API bool	IsValid () const
	Whether or not this node is valid.

SDR_API std::string	GetInfoString () const
	Gets a string with basic information about this node.

Inputs and Outputs
An input or output is also generically referred to as a "property".
SDR_API const SdrTokenVec &	GetShaderInputNames () const
	Get an ordered list of all the input names on this shader node.

SDR_API const SdrTokenVec &	GetShaderOutputNames () const
	Get an ordered list of all the output names on this shader node.

SDR_API SdrShaderPropertyConstPtr	GetShaderInput (const TfToken &inputName) const
	Get a shader input property by name.

SDR_API SdrShaderPropertyConstPtr	GetShaderOutput (const TfToken &outputName) const
	Get a shader output property by name.

SDR_API SdrTokenVec	GetAssetIdentifierInputNames () const
	Returns the list of all inputs that are tagged as asset identifier inputs.

SDR_API SdrShaderPropertyConstPtr	GetDefaultInput () const
	Returns the first shader input that is tagged as the default input.

Metadata
The metadata returned here is a direct result of what the parser plugin is able to determine about the node. See the documentation for a specific parser plugin to get help on what the parser is looking for to populate these values.
SDR_API const SdrTokenMap &	GetMetadata () const
	All metadata that came from the parse process.

SDR_API const TfToken &	GetLabel () const
	The label assigned to this node, if any.

SDR_API const TfToken &	GetCategory () const
	The category assigned to this node, if any.

SDR_API std::string	GetRole () const
	Returns the role of this node.

SDR_API std::string	GetHelp () const
	The help message assigned to this node, if any.

SDR_API const SdrTokenVec &	GetDepartments () const
	The departments this node is associated with, if any.

SDR_API const SdrTokenVec &	GetPages () const
	Gets the pages on which the node's properties reside (an aggregate of the unique `SdrShaderProperty::GetPage()` values for all of the node's properties).

SDR_API const SdrTokenVec &	GetOpenPages () const
	Gets the pages which should be opened or expanded by default.

SDR_API const SdrTokenMap &	GetPagesShownIf () const
	Gets the `shownIf` expressions associated with each page.

SDR_API const SdrTokenVec &	GetPrimvars () const
	The list of primvars this node knows it requires / uses.

SDR_API const SdrTokenVec &	GetAdditionalPrimvarProperties () const
	The list of string input properties whose values provide the names of additional primvars consumed by this node.

SDR_API std::string	GetImplementationName () const
	Returns the implementation name of this node.

Aggregate Information
SDR_API SdrTokenVec	GetPropertyNamesForPage (const std::string &pageName) const
	Gets the names of the properties on a certain page (one that was returned by `GetPages()`).

SDR_API SdrTokenVec	GetAllVstructNames () const
	Gets all vstructs that are present in the shader.

Static Public Member Functions
static SDR_API ComplianceResults	CheckPropertyCompliance (const std::vector< SdrShaderNodeConstPtr > &shaderNodes)
	This method checks if same named properties of `shaderNodes` are compatible with each other.

Protected Member Functions
SdrShaderNode &	operator= (const SdrShaderNode &)=delete

Protected Attributes
bool	_isValid

SdrIdentifier	_identifier

SdrVersion	_version

std::string	_name

TfToken	_family

TfToken	_context

TfToken	_sourceType

std::string	_definitionURI

std::string	_implementationURI

SdrShaderPropertyUniquePtrVec	_properties

SdrTokenMap	_metadata

std::string	_sourceCode

SdrShaderPropertyMap	_inputs

SdrTokenVec	_inputNames

SdrShaderPropertyMap	_outputs

SdrTokenVec	_outputNames

SdrTokenVec	_primvars

SdrTokenVec	_primvarNamingProperties

TfToken	_label

TfToken	_category

SdrTokenVec	_departments

SdrTokenVec	_pages

SdrTokenVec	_openPages

SdrTokenMap	_pagesShownIf

Detailed Description

Represents a node that holds shading information.

Describes information like the name of the node, what its inputs and outputs are, and any associated metadata.

Definition at line 88 of file shaderNode.h.

Member Typedef Documentation

◆ ComplianceResults

using ComplianceResults = std::unordered_map<TfToken, std::vector<SdrIdentifier>, TfToken::HashFunctor>

Definition at line 343 of file shaderNode.h.

Constructor & Destructor Documentation

◆ SdrShaderNode()

SDR_API SdrShaderNode	(	const SdrIdentifier &	identifier,
		const SdrVersion &	version,
		const std::string &	name,
		const TfToken &	family,
		const TfToken &	context,
		const TfToken &	sourceType,
		const std::string &	definitionURI,
		const std::string &	implementationURI,
		SdrShaderPropertyUniquePtrVec &&	properties,
		const SdrTokenMap &	metadata = `SdrTokenMap()`,
		const std::string &	sourceCode = `std::string()`
	)

Constructor.

◆ ~SdrShaderNode()

virtual SDR_API ~SdrShaderNode ( )

virtual

Destructor.

Member Function Documentation

◆ CheckPropertyCompliance()

static SDR_API ComplianceResults CheckPropertyCompliance ( const std::vector< SdrShaderNodeConstPtr > & shaderNodes )

static

This method checks if same named properties of shaderNodes are compatible with each other.

Checks if the same name properties have matching types and default values. In order to determine if same name properties from different shader nodes are compliant, we assume that the first shaderNode in the list providing this property is authoritative, and other nodes differing wrt this property are non-compliant. A map of property names and their respective shaderNodes are stored in the map. An empty map returned represents no compliance issues.

◆ GetAdditionalPrimvarProperties()

SDR_API const SdrTokenVec & GetAdditionalPrimvarProperties ( ) const

inline

The list of string input properties whose values provide the names of additional primvars consumed by this node.

For example, this may return a token named varname. This indicates that the client should query the value of a (presumed to be string-valued) input attribute named varname from its scene description to determine the name of a primvar the node will consume. See GetPrimvars() for additional information.

Definition at line 309 of file shaderNode.h.

◆ GetAllVstructNames()

SDR_API SdrTokenVec GetAllVstructNames ( ) const

Gets all vstructs that are present in the shader.

◆ GetAssetIdentifierInputNames()

SDR_API SdrTokenVec GetAssetIdentifierInputNames ( ) const

Returns the list of all inputs that are tagged as asset identifier inputs.

◆ GetCategory()

SDR_API const TfToken & GetCategory ( ) const

inline

The category assigned to this node, if any.

Distinct from the family returned from GetFamily().

Definition at line 258 of file shaderNode.h.

◆ GetContext()

const TfToken & GetContext ( ) const

inline

Gets the context of the shader node.

The context is the context that the node declares itself as having (or, if a particular node does not declare a context, it will be assigned a default context by the parser).

As a concrete example from the Sdr library, a shader with a specific source type may perform different duties vs. another shader with the same source type. For example, one shader with a source type of SdrArgsParser::SourceType may declare itself as having a context of 'pattern', while another shader of the same source type may say it is used for lighting, and thus has a context of 'light'.

Definition at line 138 of file shaderNode.h.

◆ GetDataForKey()

SDR_API VtValue GetDataForKey ( const TfToken & key ) const

Gets an item of data from this shader node according to the requested key.

Special keys indicate class fields and are identified by the SdrNodeFieldKey enum. The return type of GetDataForKey for these special keys is the return type of their getters. GetDataForKey(SdrNodeFieldKey->Identifier) results in VtValue holding a TfToken because GetIdentifier returns TfToken. The return types for these special keys is as follows:

SdrNodeFieldKey->Identifier -> VtValue holding TfToken
SdrNodeFieldKey->Name -> VtValue holding std::string
SdrNodeFieldKey->Family -> VtValue holding TfToken
SdrNodeFieldKey->SourceType -> VtValue holding TfToken

Any requested data item that isn't a SdrNodeFieldKey will be looked for in this shader node's metadata.

Returns an empty VtValue if no data is found to be associated with the requested key.

◆ GetDefaultInput()

SDR_API SdrShaderPropertyConstPtr GetDefaultInput ( ) const

Returns the first shader input that is tagged as the default input.

A default input and its value can be used to acquire a fallback value for a node when the node is considered 'disabled' or otherwise incapable of producing an output value.

◆ GetDepartments()

SDR_API const SdrTokenVec & GetDepartments ( ) const

inline

The departments this node is associated with, if any.

Definition at line 275 of file shaderNode.h.

◆ GetFamily()

const TfToken & GetFamily ( ) const

inline

Gets the name of the family that the node belongs to.

An empty token will be returned if the node does not belong to a family.

Definition at line 124 of file shaderNode.h.

◆ GetHelp()

SDR_API std::string GetHelp ( ) const

The help message assigned to this node, if any.

◆ GetIdentifier()

const SdrIdentifier & GetIdentifier ( ) const

inline

Return the identifier of the node.

Definition at line 114 of file shaderNode.h.

◆ GetImplementationName()

SDR_API std::string GetImplementationName ( ) const

Returns the implementation name of this node.

The name of the node is how to refer to the node in shader networks. The label is how to present this node to users. The implementation name is the name of the function (or something) this node represents in the implementation. Any client using the implementation must call this method to get the correct name; using getName() is not correct.

◆ GetInfoString()

SDR_API std::string GetInfoString ( ) const

Gets a string with basic information about this node.

Helpful for things like adding this node to a log.

◆ GetLabel()

SDR_API const TfToken & GetLabel ( ) const

inline

The label assigned to this node, if any.

Distinct from the name returned from GetName(). In the context of a UI, the label value might be used as the display name for the node instead of the name.

Definition at line 253 of file shaderNode.h.

◆ GetMetadata()

SDR_API const SdrTokenMap & GetMetadata ( ) const

All metadata that came from the parse process.

◆ GetName()

const std::string & GetName ( ) const

inline

Gets the name of the node.

Definition at line 120 of file shaderNode.h.

◆ GetOpenPages()

SDR_API const SdrTokenVec & GetOpenPages ( ) const

inline

Gets the pages which should be opened or expanded by default.

Definition at line 287 of file shaderNode.h.

◆ GetPages()

SDR_API const SdrTokenVec & GetPages ( ) const

inline

Gets the pages on which the node's properties reside (an aggregate of the unique SdrShaderProperty::GetPage() values for all of the node's properties).

Nodes themselves do not reside on pages. In an example scenario, properties might be divided into two pages, 'Simple' and 'Advanced'.

Definition at line 283 of file shaderNode.h.

◆ GetPagesShownIf()

SDR_API const SdrTokenMap & GetPagesShownIf ( ) const

inline

Gets the shownIf expressions associated with each page.

Definition at line 291 of file shaderNode.h.

◆ GetPrimvars()

SDR_API const SdrTokenVec & GetPrimvars ( ) const

inline

The list of primvars this node knows it requires / uses.

For example, a shader node may require the 'normals' primvar to function correctly. Additional, user specified primvars may have been authored on the node. These can be queried via GetAdditionalPrimvarProperties(). Together, GetPrimvars() and GetAdditionalPrimvarProperties(), provide the complete list of primvar requirements for the node.

Definition at line 300 of file shaderNode.h.

◆ GetPropertyNamesForPage()

SDR_API SdrTokenVec GetPropertyNamesForPage ( const std::string & pageName ) const

Gets the names of the properties on a certain page (one that was returned by GetPages()).

To get properties that are not assigned to a page, an empty string can be used for pageName.

◆ GetResolvedDefinitionURI()

const std::string & GetResolvedDefinitionURI ( ) const

inline

Gets the URI to the resource that provided this node's definition.

Could be a path to a file, or some other resource identifier. This URI should be fully resolved.

See also: SdrShaderNode::GetResolvedImplementationURI()

Definition at line 159 of file shaderNode.h.

◆ GetResolvedImplementationURI()

const std::string & GetResolvedImplementationURI ( ) const

inline

Gets the URI to the resource that provides this node's implementation.

Could be a path to a file, or some other resource identifier. This URI should be fully resolved.

See also: SdrShaderNode::GetResolvedDefinitionURI()

Definition at line 166 of file shaderNode.h.

◆ GetRole()

SDR_API std::string GetRole ( ) const

Returns the role of this node.

This is used to annotate the role that the shader node plays inside a shader network. We can tag certain shaders to indicate their role within a shading network. We currently tag primvar reading nodes, texture reading nodes and nodes that access volume fields (like extinction or scattering). This is done to identify resources used by a shading network.

◆ GetShaderInput()

SDR_API SdrShaderPropertyConstPtr GetShaderInput ( const TfToken & inputName ) const

Get a shader input property by name.

nullptr is returned if an input with the given name does not exist.

◆ GetShaderInputNames()

SDR_API const SdrTokenVec & GetShaderInputNames ( ) const

Get an ordered list of all the input names on this shader node.

◆ GetShaderOutput()

SDR_API SdrShaderPropertyConstPtr GetShaderOutput ( const TfToken & outputName ) const

Get a shader output property by name.

nullptr is returned if an output with the given name does not exist.

◆ GetShaderOutputNames()

SDR_API const SdrTokenVec & GetShaderOutputNames ( ) const

Get an ordered list of all the output names on this shader node.

◆ GetShaderVersion()

SdrVersion GetShaderVersion ( ) const

inline

Return the version of the node.

Definition at line 117 of file shaderNode.h.

◆ GetSourceCode()

const std::string & GetSourceCode ( ) const

inline

Returns the source code for this node.

This will be empty for most nodes. It will be non-empty only for the nodes that are constructed using SdrRegistry::GetShaderNodeFromSourceCode(), in which case, the source code has not been parsed (or even compiled) yet.

An unparsed node with non-empty source-code but no properties is considered to be invalid. Once the node is parsed and the relevant properties and metadata are extracted from the source code, the node becomes valid.

See also: SdrShaderNode::IsValid

Definition at line 181 of file shaderNode.h.

◆ GetSourceType()

const TfToken & GetSourceType ( ) const

inline

Gets the type of source that this shader node originated from.

Note that this is distinct from GetContext(), which is the type that the node declares itself as having.

As a concrete example from the Sdr library, several shader parsers exist and operate on different types of shaders. In this scenario, each distinct type of shader (OSL, Args, etc) is considered a different source, even though they are all shaders. In addition, the shaders under each source type may declare themselves as having a specific context (shaders can serve different roles). See GetContext() for more information on this.

Definition at line 152 of file shaderNode.h.

◆ IsValid()

SDR_API bool IsValid ( ) const

inline

Whether or not this node is valid.

A node that is valid indicates that the parser plugin was able to successfully parse the contents of this node.

Note that if a node is not valid, some data like its name, URI, source code etc. could still be available (data that was obtained during the discovery process). However, other data that must be gathered from the parsing process will NOT be available (eg, inputs and outputs).

Definition at line 192 of file shaderNode.h.

Member Data Documentation

◆ _category

TfToken _category

protected

Definition at line 424 of file shaderNode.h.

◆ _context

TfToken _context

protected

Definition at line 402 of file shaderNode.h.

◆ _definitionURI

std::string _definitionURI

protected

Definition at line 404 of file shaderNode.h.

◆ _departments

SdrTokenVec _departments

protected

Definition at line 425 of file shaderNode.h.

◆ _family

TfToken _family

protected

Definition at line 401 of file shaderNode.h.

◆ _identifier

SdrIdentifier _identifier

protected

Definition at line 398 of file shaderNode.h.

◆ _implementationURI

std::string _implementationURI

protected

Definition at line 405 of file shaderNode.h.

◆ _inputNames

SdrTokenVec _inputNames

protected

Definition at line 411 of file shaderNode.h.

◆ _inputs

SdrShaderPropertyMap _inputs

protected

Definition at line 410 of file shaderNode.h.

◆ _isValid

bool _isValid

protected

Definition at line 397 of file shaderNode.h.

◆ _label

TfToken _label

protected

Definition at line 423 of file shaderNode.h.

◆ _metadata

SdrTokenMap _metadata

protected

Definition at line 407 of file shaderNode.h.

◆ _name

std::string _name

protected

Definition at line 400 of file shaderNode.h.

◆ _openPages

SdrTokenVec _openPages

protected

Definition at line 427 of file shaderNode.h.

◆ _outputNames

SdrTokenVec _outputNames

protected

Definition at line 413 of file shaderNode.h.

◆ _outputs

SdrShaderPropertyMap _outputs

protected

Definition at line 412 of file shaderNode.h.

◆ _pages

SdrTokenVec _pages

protected

Definition at line 426 of file shaderNode.h.

◆ _pagesShownIf

SdrTokenMap _pagesShownIf

protected

Definition at line 428 of file shaderNode.h.

◆ _primvarNamingProperties

SdrTokenVec _primvarNamingProperties

protected

Definition at line 420 of file shaderNode.h.

◆ _primvars

SdrTokenVec _primvars

protected

Definition at line 419 of file shaderNode.h.

◆ _properties

SdrShaderPropertyUniquePtrVec _properties

protected

Definition at line 406 of file shaderNode.h.

◆ _sourceCode

std::string _sourceCode

protected

Definition at line 408 of file shaderNode.h.

◆ _sourceType

TfToken _sourceType

protected

Definition at line 403 of file shaderNode.h.

◆ _version

SdrVersion _version

protected

Definition at line 399 of file shaderNode.h.

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

pxr/usd/sdr/shaderNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ComplianceResults

Constructor & Destructor Documentation

◆ SdrShaderNode()

◆ ~SdrShaderNode()

Member Function Documentation

◆ CheckPropertyCompliance()

◆ GetAdditionalPrimvarProperties()

◆ GetAllVstructNames()

◆ GetAssetIdentifierInputNames()

◆ GetCategory()

◆ GetContext()

◆ GetDataForKey()

◆ GetDefaultInput()

◆ GetDepartments()

◆ GetFamily()

◆ GetHelp()

◆ GetIdentifier()

◆ GetImplementationName()

◆ GetInfoString()

◆ GetLabel()

◆ GetMetadata()

◆ GetName()

◆ GetOpenPages()

◆ GetPages()

◆ GetPagesShownIf()

◆ GetPrimvars()

◆ GetPropertyNamesForPage()

◆ GetResolvedDefinitionURI()

◆ GetResolvedImplementationURI()

◆ GetRole()

◆ GetShaderInput()

◆ GetShaderInputNames()

◆ GetShaderOutput()

◆ GetShaderOutputNames()

◆ GetShaderVersion()

◆ GetSourceCode()

◆ GetSourceType()

◆ IsValid()

Member Data Documentation

◆ _category

◆ _context

◆ _definitionURI

◆ _departments

◆ _family

◆ _identifier

◆ _implementationURI

◆ _inputNames

◆ _inputs

◆ _isValid

◆ _label

◆ _metadata

◆ _name

◆ _openPages

◆ _outputNames

◆ _outputs

◆ _pages

◆ _pagesShownIf

◆ _primvarNamingProperties

◆ _primvars

◆ _properties

◆ _sourceCode

◆ _sourceType

◆ _version