#include <ShaderNode.h>

Inheritance diagram for ShaderPort:

Public Member Functions
	ShaderPort (ShaderNode node, const TypeDesc type, const string &name, ValuePtr value=nullptr)
	Constructor. More...

ShaderPortPtr	getSelf ()
	Return a shared pointer instance of this object. More...

ShaderNode *	getNode ()
	Return the node this port belongs to. More...

const ShaderNode *	getNode () const
	Return the node this port belongs to. More...

void	setType (const TypeDesc *type)
	Set the data type for this port. More...

const TypeDesc *	getType () const
	Return the data type for this port. More...

void	setName (const string &name)
	Set the name of this port. More...

const string &	getName () const
	Return the name of this port. More...

string	getFullName () const
	Return the name of this port. More...

void	setVariable (const string &name)
	Set the variable name of this port. More...

const string &	getVariable () const
	Return the variable name of this port. More...

void	setSemantic (const string &semantic)
	Set the variable semantic of this port. More...

const string &	getSemantic () const
	Return the variable semantic of this port. More...

void	setValue (ValuePtr value)
	Set a value on this port. More...

ValuePtr	getValue () const
	Return the value set on this port. More...

string	getValueString () const
	Return the value set on this port as a string, or an empty string if there is no value. More...

void	setColorSpace (const string &colorspace)
	Set a source color space for the value on this port. More...

const string &	getColorSpace () const
	Return the source color space for the value on this port. More...

void	setUnit (const string &unit)
	Set a unit type for the value on this port. More...

const string &	getUnit () const
	Return the unit type for the value on this port. More...

void	setGeomProp (const string &geomprop)

const string &	getGeomProp () const
	Get geomprop name. More...

void	setPath (const string &path)
	Set the path to this port. More...

const string &	getPath () const
	Return the path to this port. More...

void	setFlags (uint32_t flags)
	Set flags on this port. More...

uint32_t	getFlags () const
	Return flags set on this port. More...

void	setFlag (uint32_t flag, bool value)
	Set the on\|off state of a given flag. More...

bool	getFlag (uint32_t flag) const
	Return the on\|off state of a given flag. More...

void	setUniform ()
	Set the uniform flag this port to true. More...

bool	isUniform () const
	Return the uniform flag on this port. More...

void	setEmitted ()
	Set the emitted state on this port to true. More...

bool	isEmitted () const
	Return the emitted state of this port. More...

void	setBindInput ()
	Set the bind input state on this port to true. More...

bool	isBindInput () const
	Return the emitted state of this port. More...

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

Protected Attributes
ShaderNode *	_node

const TypeDesc *	_type

string	_name

string	_path

string	_semantic

string	_variable

ValuePtr	_value

string	_unit

string	_colorspace

string	_geomprop

ShaderMetadataVecPtr	_metadata

uint32_t	_flags

Detailed Description

An input or output port on a ShaderNode

Definition at line 122 of file ShaderNode.h.

Constructor & Destructor Documentation

ShaderPort::ShaderPort	(	ShaderNode *	node,
		const TypeDesc *	type,
		const string &	name,
		ValuePtr	value = `nullptr`
	)

Constructor.

Member Function Documentation

const string& ShaderPort::getColorSpace ( ) const

inline

Return the source color space for the value on this port.

Definition at line 180 of file ShaderNode.h.

bool ShaderPort::getFlag ( uint32_t flag ) const

inline

Return the on|off state of a given flag.

Definition at line 214 of file ShaderNode.h.

uint32_t ShaderPort::getFlags ( ) const

inline

Return flags set on this port.

Definition at line 205 of file ShaderNode.h.

string ShaderPort::getFullName ( ) const

Return the name of this port.

const string& ShaderPort::getGeomProp ( ) const

inline

Get geomprop name.

Definition at line 193 of file ShaderNode.h.

ShaderMetadataVecPtr ShaderPort::getMetadata ( )

inline

Get the metadata vector.

Definition at line 241 of file ShaderNode.h.

const ShaderMetadataVecPtr& ShaderPort::getMetadata ( ) const

inline

Get the metadata vector.

Definition at line 244 of file ShaderNode.h.

const string& ShaderPort::getName ( ) const

inline

Return the name of this port.

Definition at line 150 of file ShaderNode.h.

ShaderNode* ShaderPort::getNode ( )

inline

Return the node this port belongs to.

Definition at line 135 of file ShaderNode.h.

const ShaderNode* ShaderPort::getNode ( ) const

inline

Return the node this port belongs to.

Definition at line 138 of file ShaderNode.h.

const string& ShaderPort::getPath ( ) const

inline

Return the path to this port.

Definition at line 199 of file ShaderNode.h.

ShaderPortPtr ShaderPort::getSelf ( )

inline

Return a shared pointer instance of this object.

Definition at line 129 of file ShaderNode.h.

const string& ShaderPort::getSemantic ( ) const

inline

Return the variable semantic of this port.

Definition at line 165 of file ShaderNode.h.

const TypeDesc* ShaderPort::getType ( ) const

inline

Return the data type for this port.

Definition at line 144 of file ShaderNode.h.

const string& ShaderPort::getUnit ( ) const

inline

Return the unit type for the value on this port.

Definition at line 186 of file ShaderNode.h.

ValuePtr ShaderPort::getValue ( ) const

inline

Return the value set on this port.

Definition at line 171 of file ShaderNode.h.

string ShaderPort::getValueString ( ) const

Return the value set on this port as a string, or an empty string if there is no value.

const string& ShaderPort::getVariable ( ) const

inline

Return the variable name of this port.

Definition at line 159 of file ShaderNode.h.

bool ShaderPort::isBindInput ( ) const

inline

Return the emitted state of this port.

Definition at line 235 of file ShaderNode.h.

bool ShaderPort::isEmitted ( ) const

inline

Return the emitted state of this port.

Definition at line 229 of file ShaderNode.h.

bool ShaderPort::isUniform ( ) const

inline

Return the uniform flag on this port.

Definition at line 223 of file ShaderNode.h.

void ShaderPort::setBindInput ( )

inline

Set the bind input state on this port to true.

Definition at line 232 of file ShaderNode.h.

void ShaderPort::setColorSpace ( const string & colorspace )

inline

Set a source color space for the value on this port.

Definition at line 177 of file ShaderNode.h.

void ShaderPort::setEmitted ( )

inline

Set the emitted state on this port to true.

Definition at line 226 of file ShaderNode.h.

void ShaderPort::setFlag	(	uint32_t	flag,
		bool	value
	)

inline

Set the on|off state of a given flag.

Definition at line 208 of file ShaderNode.h.

void ShaderPort::setFlags ( uint32_t flags )

inline

Set flags on this port.

Definition at line 202 of file ShaderNode.h.

void ShaderPort::setGeomProp ( const string & geomprop )

inline

Set geomprop name if the input has a default geomprop to be assigned when it is unconnected.

Definition at line 190 of file ShaderNode.h.

void ShaderPort::setMetadata ( ShaderMetadataVecPtr metadata )

inline

Set the metadata vector.

Definition at line 238 of file ShaderNode.h.

void ShaderPort::setName ( const string & name )

inline

Set the name of this port.

Definition at line 147 of file ShaderNode.h.

void ShaderPort::setPath ( const string & path )

inline

Set the path to this port.

Definition at line 196 of file ShaderNode.h.

void ShaderPort::setSemantic ( const string & semantic )

inline

Set the variable semantic of this port.

Definition at line 162 of file ShaderNode.h.

void ShaderPort::setType ( const TypeDesc * type )

inline

Set the data type for this port.

Definition at line 141 of file ShaderNode.h.

void ShaderPort::setUniform ( )

inline

Set the uniform flag this port to true.

Definition at line 220 of file ShaderNode.h.

void ShaderPort::setUnit ( const string & unit )

inline

Set a unit type for the value on this port.

Definition at line 183 of file ShaderNode.h.

void ShaderPort::setValue ( ValuePtr value )

inline

Set a value on this port.

Definition at line 168 of file ShaderNode.h.

void ShaderPort::setVariable ( const string & name )

inline

Set the variable name of this port.

Definition at line 156 of file ShaderNode.h.

Member Data Documentation

string ShaderPort::_colorspace

protected

Definition at line 255 of file ShaderNode.h.

uint32_t ShaderPort::_flags

protected

Definition at line 258 of file ShaderNode.h.

string ShaderPort::_geomprop

protected

Definition at line 256 of file ShaderNode.h.

ShaderMetadataVecPtr ShaderPort::_metadata

protected

Definition at line 257 of file ShaderNode.h.

string ShaderPort::_name

protected

Definition at line 249 of file ShaderNode.h.

ShaderNode* ShaderPort::_node

protected

Definition at line 247 of file ShaderNode.h.

string ShaderPort::_path

protected

Definition at line 250 of file ShaderNode.h.

string ShaderPort::_semantic

protected

Definition at line 251 of file ShaderNode.h.

const TypeDesc* ShaderPort::_type

protected

Definition at line 248 of file ShaderNode.h.

string ShaderPort::_unit

protected

Definition at line 254 of file ShaderNode.h.

ValuePtr ShaderPort::_value

protected

Definition at line 253 of file ShaderNode.h.

string ShaderPort::_variable

protected

Definition at line 252 of file ShaderNode.h.

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

MaterialXGenShader/ShaderNode.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation