ShaderNode Class Reference

#include <ShaderNode.h>

Inheritance diagram for ShaderNode:

Classes
class	Classification
	Flags for classifying nodes into different categories. More...
struct	ScopeInfo

Public Member Functions
virtual	~ShaderNode ()
	ShaderNode (const ShaderGraph *parent, const string &name)
	Constructor. More...
virtual bool	isAGraph () const
	Return true if this node is a graph. More...
const ShaderGraph *	getParent () const
bool	hasClassification (uint32_t c) const
	Return true if this node matches the given classification. More...
const string &	getName () const
	Return the name of this node. More...
const ShaderNodeImpl &	getImplementation () const
	Return the implementation used for this node. More...
ScopeInfo &	getScopeInfo ()
	Return the scope info for this node. More...
const ScopeInfo &	getScopeInfo () const
	Return the scope info for this node. More...
bool	referencedConditionally () const
	Returns true if this node is only referenced by a conditional. More...
void	initialize (const Node &node, const NodeDef &nodeDef, GenContext &context)
ShaderInput *	addInput (const string &name, const TypeDesc *type)
	Add inputs/outputs. More...
ShaderOutput *	addOutput (const string &name, const TypeDesc *type)
size_t	numInputs () const
	Get number of inputs/outputs. More...
size_t	numOutputs () const
ShaderInput *	getInput (size_t index)
	Get inputs/outputs by index. More...
ShaderOutput *	getOutput (size_t index=0)
const ShaderInput *	getInput (size_t index) const
const ShaderOutput *	getOutput (size_t index=0) const
ShaderInput *	getInput (const string &name)
	Get inputs/outputs by name. More...
ShaderOutput *	getOutput (const string &name)
const ShaderInput *	getInput (const string &name) const
const ShaderOutput *	getOutput (const string &name) const
const vector< ShaderInput * > &	getInputs () const
	Get vector of inputs/outputs. More...
const vector< ShaderOutput * > &	getOutputs () const
void	setMetadata (ShaderMetadataVecPtr metadata)
	Set the metadata vector. More...
ShaderMetadataVecPtr	getMetadata ()
	Get the metadata vector. More...
const ShaderMetadataVecPtr &	getMetadata () const
	Get the metadata vector. More...
bool	isEditable (const ShaderInput &input) const
bool	isEditable (const ShaderGraphInputSocket &input) const

Static Public Member Functions
static ShaderNodePtr	create (const ShaderGraph *parent, const string &name, const NodeDef &nodeDef, GenContext &context)
	Create a new node from a nodedef. More...
static ShaderNodePtr	create (const ShaderGraph *parent, const string &name, ShaderNodeImplPtr impl, unsigned int classification=Classification::TEXTURE)
	Create a new node from a node implementation. More...

Static Public Attributes
static const ShaderNodePtr	NONE
static const string	CONSTANT
static const string	IMAGE
static const string	COMPARE
static const string	SWITCH
static const string	SCATTER_MODE
static const string	BSDF_R
static const string	BSDF_T
static const string	TRANSFORM_POINT
static const string	TRANSFORM_VECTOR
static const string	TRANSFORM_NORMAL
static const string	TEXTURE2D_GROUPNAME
static const string	TEXTURE3D_GROUPNAME
static const string	PROCEDURAL2D_GROUPNAME
static const string	PROCEDURAL3D_GROUPNAME

Protected Member Functions
void	createMetadata (const NodeDef &nodeDef, GenContext &context)
	Create metadata from the nodedef according to registered metadata. More...

Protected Attributes
const ShaderGraph *	_parent
string	_name
uint32_t	_classification
std::unordered_map< string, ShaderInputPtr >	_inputMap
vector< ShaderInput * >	_inputOrder
std::unordered_map< string, ShaderOutputPtr >	_outputMap
vector< ShaderOutput * >	_outputOrder
ShaderNodeImplPtr	_impl
ShaderMetadataVecPtr	_metadata
ScopeInfo	_scopeInfo

Friends
class	ShaderGraph

Detailed Description

Class representing a node in the shader generation DAG

Definition at line 323 of file ShaderNode.h.

Constructor & Destructor Documentation

virtual ShaderNode::~ShaderNode ( )

inlinevirtual

Definition at line 326 of file ShaderNode.h.

ShaderNode::ShaderNode	(	const ShaderGraph *	parent,
		const string &	name
	)

Constructor.

Member Function Documentation

ShaderInput* ShaderNode::addInput	(	const string &	name,
		const TypeDesc *	type
	)

Add inputs/outputs.

ShaderOutput* ShaderNode::addOutput	(	const string &	name,
		const TypeDesc *	type
	)

static ShaderNodePtr ShaderNode::create ( const ShaderGraph *  parent, const string &  name, const NodeDef &  nodeDef, GenContext &  context  )

static

Create a new node from a nodedef.

static ShaderNodePtr ShaderNode::create ( const ShaderGraph *  parent, const string &  name, ShaderNodeImplPtr  impl, unsigned int  classification = Classification::TEXTURE  )

static

Create a new node from a node implementation.

void ShaderNode::createMetadata ( const NodeDef &  nodeDef, GenContext &  context  )

protected

Create metadata from the nodedef according to registered metadata.

const ShaderNodeImpl& ShaderNode::getImplementation ( ) const

inline

Return the implementation used for this node.

Definition at line 441 of file ShaderNode.h.

ShaderInput* ShaderNode::getInput ( size_t  index )

inline

Get inputs/outputs by index.

Definition at line 474 of file ShaderNode.h.

const ShaderInput* ShaderNode::getInput ( size_t  index ) const

inline

Definition at line 476 of file ShaderNode.h.

ShaderInput* ShaderNode::getInput

(

const string &

name

)

Get inputs/outputs by name.

const ShaderInput* ShaderNode::getInput

(

const string &

name

)

const

const vector<ShaderInput*>& ShaderNode::getInputs ( ) const

inline

Get vector of inputs/outputs.

Definition at line 486 of file ShaderNode.h.

ShaderMetadataVecPtr ShaderNode::getMetadata ( )

inline

Get the metadata vector.

Definition at line 493 of file ShaderNode.h.

const ShaderMetadataVecPtr& ShaderNode::getMetadata ( ) const

inline

Get the metadata vector.

Definition at line 496 of file ShaderNode.h.

const string& ShaderNode::getName ( ) const

inline

Return the name of this node.

Definition at line 435 of file ShaderNode.h.

ShaderOutput* ShaderNode::getOutput ( size_t  index = 0 )

inline

Definition at line 475 of file ShaderNode.h.

const ShaderOutput* ShaderNode::getOutput ( size_t  index = 0 ) const

inline

Definition at line 477 of file ShaderNode.h.

ShaderOutput* ShaderNode::getOutput

(

const string &

name

)

const ShaderOutput* ShaderNode::getOutput

(

const string &

name

)

const

const vector<ShaderOutput*>& ShaderNode::getOutputs ( ) const

inline

Definition at line 487 of file ShaderNode.h.

const ShaderGraph* ShaderNode::getParent ( ) const

inline

Return the parent graph that owns this node. If this node is a root graph it has no parent and nullptr will be returned.

Definition at line 423 of file ShaderNode.h.

ScopeInfo& ShaderNode::getScopeInfo ( )

inline

Return the scope info for this node.

Definition at line 447 of file ShaderNode.h.

const ScopeInfo& ShaderNode::getScopeInfo ( ) const

inline

Return the scope info for this node.

Definition at line 453 of file ShaderNode.h.

bool ShaderNode::hasClassification ( uint32_t  c ) const

inline

Return true if this node matches the given classification.

Definition at line 429 of file ShaderNode.h.

void ShaderNode::initialize	(	const Node &	node,
		const NodeDef &	nodeDef,
		GenContext &	context
	)

Initialize this shader node with all required data from the given node and nodedef.

virtual bool ShaderNode::isAGraph ( ) const

inlinevirtual

Return true if this node is a graph.

Reimplemented in ShaderGraph.

Definition at line 418 of file ShaderNode.h.

bool ShaderNode::isEditable ( const ShaderInput &  input ) const

inline

Returns true if an input is editable by users. Editable inputs are allowed to be published as shader uniforms and hence must be presentable in a user interface.

Definition at line 501 of file ShaderNode.h.

bool ShaderNode::isEditable ( const ShaderGraphInputSocket &  input ) const

inline

Returns true if a graph input is accessible by users. Editable inputs are allowed to be published as shader uniforms and hence must be presentable in a user interface.

Definition at line 509 of file ShaderNode.h.

size_t ShaderNode::numInputs ( ) const

inline

Get number of inputs/outputs.

Definition at line 470 of file ShaderNode.h.

size_t ShaderNode::numOutputs ( ) const

inline

Definition at line 471 of file ShaderNode.h.

bool ShaderNode::referencedConditionally

(

)

const

Returns true if this node is only referenced by a conditional.

void ShaderNode::setMetadata ( ShaderMetadataVecPtr  metadata )

inline

Set the metadata vector.

Definition at line 490 of file ShaderNode.h.

Friends And Related Function Documentation

friend class ShaderGraph

friend

Definition at line 532 of file ShaderNode.h.

Member Data Documentation

uint32_t ShaderNode::_classification

protected

Definition at line 520 of file ShaderNode.h.

ShaderNodeImplPtr ShaderNode::_impl

protected

Definition at line 528 of file ShaderNode.h.

std::unordered_map<string, ShaderInputPtr> ShaderNode::_inputMap

protected

Definition at line 522 of file ShaderNode.h.

vector<ShaderInput*> ShaderNode::_inputOrder

protected

Definition at line 523 of file ShaderNode.h.

ShaderMetadataVecPtr ShaderNode::_metadata

protected

Definition at line 529 of file ShaderNode.h.

string ShaderNode::_name

protected

Definition at line 519 of file ShaderNode.h.

std::unordered_map<string, ShaderOutputPtr> ShaderNode::_outputMap

protected

Definition at line 525 of file ShaderNode.h.

vector<ShaderOutput*> ShaderNode::_outputOrder

protected

Definition at line 526 of file ShaderNode.h.

const ShaderGraph* ShaderNode::_parent

protected

Definition at line 518 of file ShaderNode.h.

ScopeInfo ShaderNode::_scopeInfo

protected

Definition at line 530 of file ShaderNode.h.

const string ShaderNode::BSDF_R

static

Definition at line 395 of file ShaderNode.h.

const string ShaderNode::BSDF_T

static

Definition at line 396 of file ShaderNode.h.

const string ShaderNode::COMPARE

static

Definition at line 392 of file ShaderNode.h.

const string ShaderNode::CONSTANT

static

Definition at line 390 of file ShaderNode.h.

const string ShaderNode::IMAGE

static

Definition at line 391 of file ShaderNode.h.

const ShaderNodePtr ShaderNode::NONE

static

Definition at line 388 of file ShaderNode.h.

const string ShaderNode::PROCEDURAL2D_GROUPNAME

static

Definition at line 402 of file ShaderNode.h.

const string ShaderNode::PROCEDURAL3D_GROUPNAME

static

Definition at line 403 of file ShaderNode.h.

const string ShaderNode::SCATTER_MODE

static

Definition at line 394 of file ShaderNode.h.

const string ShaderNode::SWITCH

static

Definition at line 393 of file ShaderNode.h.

const string ShaderNode::TEXTURE2D_GROUPNAME

static

Definition at line 400 of file ShaderNode.h.

const string ShaderNode::TEXTURE3D_GROUPNAME

static

Definition at line 401 of file ShaderNode.h.

const string ShaderNode::TRANSFORM_NORMAL

static

Definition at line 399 of file ShaderNode.h.

const string ShaderNode::TRANSFORM_POINT

static

Definition at line 397 of file ShaderNode.h.

const string ShaderNode::TRANSFORM_VECTOR

static

Definition at line 398 of file ShaderNode.h.

---

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

• MaterialXGenShader/ShaderNode.h