Represents the raw data of a node, and some other bits of metadata, that were determined via a SdrDiscoveryPlugin. More...

#include <shaderNodeDiscoveryResult.h>

Public Member Functions
	SdrShaderNodeDiscoveryResult (const SdrIdentifier &identifier, const SdrVersion &version, const std::string &name, const TfToken &family, const TfToken &discoveryType, const TfToken &sourceType, const std::string &uri, const std::string &resolvedUri, const std::string &sourceCode=std::string(), const SdrTokenMap &metadata=SdrTokenMap(), const std::string &blindData=std::string(), const TfToken &subIdentifier=TfToken())
	Constructor.

Public Attributes
SdrIdentifier	identifier
	The node's identifier.

SdrVersion	version
	The node's version.

std::string	name
	The node's name.

TfToken	family
	The node's family.

TfToken	discoveryType
	The node's discovery type.

TfToken	sourceType
	The node's source type.

std::string	uri
	The node's origin.

std::string	resolvedUri
	The node's fully-resolved URI.

std::string	sourceCode
	The node's entire source code.

SdrTokenMap	metadata
	The node's metadata collected during the discovery process.

std::string	blindData
	An optional detail for the parser plugin.

TfToken	subIdentifier
	The subIdentifier is associated with a particular asset and refers to a specific definition within the asset.

Detailed Description

Represents the raw data of a node, and some other bits of metadata, that were determined via a SdrDiscoveryPlugin.

Definition at line 19 of file shaderNodeDiscoveryResult.h.

Constructor & Destructor Documentation

◆ SdrShaderNodeDiscoveryResult()

SdrShaderNodeDiscoveryResult	(	const SdrIdentifier &	identifier,
		const SdrVersion &	version,
		const std::string &	name,
		const TfToken &	family,
		const TfToken &	discoveryType,
		const TfToken &	sourceType,
		const std::string &	uri,
		const std::string &	resolvedUri,
		const std::string &	sourceCode = `std::string()`,
		const SdrTokenMap &	metadata = `SdrTokenMap()`,
		const std::string &	blindData = `std::string()`,
		const TfToken &	subIdentifier = `TfToken()`
	)

inline

Constructor.

Definition at line 21 of file shaderNodeDiscoveryResult.h.

Member Data Documentation

◆ blindData

std::string blindData

An optional detail for the parser plugin.

The parser plugin defines the meaning of this data so the discovery plugin must be written to match.

Definition at line 122 of file shaderNodeDiscoveryResult.h.

◆ discoveryType

TfToken discoveryType

The node's discovery type.

The type could be the file extension, or some other type of metadata that can signify a type prior to parsing. See the documentation for SdrParserPlugin and SdrParserPlugin::DiscoveryTypes for more information on how this value is used.

Definition at line 82 of file shaderNodeDiscoveryResult.h.

◆ family

TfToken family

The node's family.

A node's family is an optional piece of metadata that specifies a generic grouping of nodes. E.g a node with identifier "mix_float_2_1" might have family "mix".

Definition at line 74 of file shaderNodeDiscoveryResult.h.

◆ identifier

SdrIdentifier identifier

The node's identifier.

How the node is identified. In many cases this will be the name of the file or resource that this node originated from. E.g. "mix_float_2_1". The identifier must be unique for a given sourceType.

Definition at line 54 of file shaderNodeDiscoveryResult.h.

◆ metadata

SdrTokenMap metadata

The node's metadata collected during the discovery process.

Additional metadata may be present in the node's source, in the asset pointed to by resolvedUri or in sourceCode (if resolvedUri is empty). In general, parsers should override this data with metadata from the shader source.

Definition at line 117 of file shaderNodeDiscoveryResult.h.

◆ name

std::string name

The node's name.

A version independent identifier for the node type. This will often embed type parameterization but should not embed the version. E.g a node with identifier "mix_float_2_1" might have name "mix_float".

Definition at line 67 of file shaderNodeDiscoveryResult.h.

◆ resolvedUri

std::string resolvedUri

The node's fully-resolved URI.

For example, this might be an absolute path when the original URI was a relative path. In most cases, this is the path that Ar's Resolve() returns. In any case, this path should be locally accessible.

Definition at line 103 of file shaderNodeDiscoveryResult.h.

◆ sourceCode

std::string sourceCode

The node's entire source code.

The source code is parsed (if non-empty) by parser plugins when the resolvedUri value is empty.

Definition at line 109 of file shaderNodeDiscoveryResult.h.

◆ sourceType

TfToken sourceType

The node's source type.

This type is unique to the parsing plugin (SdrParserPlugin::SourceType), and determines the source of the node. See SdrShaderNode::GetSourceType() for more information.

Definition at line 89 of file shaderNodeDiscoveryResult.h.

◆ subIdentifier

TfToken subIdentifier

The subIdentifier is associated with a particular asset and refers to a specific definition within the asset.

The asset is the one referred to by SdrRegistry::GetNodeFromAsset(). The subIdentifier is not needed for all cases where the node definition is not associated with an asset. Even if the node definition is associated with an asset, the subIdentifier is only needed if the asset specifies multiple definitions rather than a single definition.

Definition at line 131 of file shaderNodeDiscoveryResult.h.