TypeSyntax Class Reference

#include <Syntax.h>

Inheritance diagram for TypeSyntax:

Public Member Functions
virtual	~TypeSyntax ()
const string &	getName () const
	Returns the type name. More...
const string &	getTypeAlias () const
	Returns a type alias if needed to define the type in the target language. More...
const string &	getTypeDefinition () const
	Returns a type definition if needed to define the type in the target language. More...
const string &	getDefaultValue (bool uniform) const
	Returns the default value for this type. More...
const StringVec &	getMembers () const
virtual string	getValue (const ShaderPort *port, bool uniform) const
virtual string	getValue (const Value &value, bool uniform) const =0

Protected Member Functions
	TypeSyntax (const Syntax *parent, const string &name, const string &defaultValue, const string &uniformDefaultValue, const string &typeAlias, const string &typeDefinition, const StringVec &members)
	Protected constructor. More...

Protected Attributes
const Syntax *	_parent
string	_name
string	_defaultValue
string	_uniformDefaultValue
string	_typeAlias
string	_typeDefinition
StringVec	_members

Static Protected Attributes
static const StringVec	EMPTY_MEMBERS

Detailed Description

Base class for syntax handling of types.

Definition at line 232 of file Syntax.h.

Constructor & Destructor Documentation

virtual TypeSyntax::~TypeSyntax ( )

inlinevirtual

Definition at line 235 of file Syntax.h.

TypeSyntax::TypeSyntax ( const Syntax *  parent, const string &  name, const string &  defaultValue, const string &  uniformDefaultValue, const string &  typeAlias, const string &  typeDefinition, const StringVec &  members  )

protected

Protected constructor.

Member Function Documentation

const string& TypeSyntax::getDefaultValue ( bool  uniform ) const

inline

Returns the default value for this type.

Definition at line 247 of file Syntax.h.

const StringVec& TypeSyntax::getMembers ( ) const

inline

Returns the syntax for accessing type members if the type can be swizzled.

Definition at line 251 of file Syntax.h.

const string& TypeSyntax::getName ( ) const

inline

Returns the type name.

Definition at line 238 of file Syntax.h.

const string& TypeSyntax::getTypeAlias ( ) const

inline

Returns a type alias if needed to define the type in the target language.

Definition at line 241 of file Syntax.h.

const string& TypeSyntax::getTypeDefinition ( ) const

inline

Returns a type definition if needed to define the type in the target language.

Definition at line 244 of file Syntax.h.

virtual string TypeSyntax::getValue ( const ShaderPort *  port, bool  uniform  ) const

virtual

Returns a value formatted according to this type syntax. The value is constructed from the given shader port object.

virtual string TypeSyntax::getValue ( const Value &  value, bool  uniform  ) const

pure virtual

Returns a value formatted according to this type syntax. The value is constructed from the given value object.

Implemented in StructTypeSyntax, AggregateTypeSyntax, StringTypeSyntax, ScalarTypeSyntax, and GlslStructTypeSyntax.

Member Data Documentation

string TypeSyntax::_defaultValue

protected

Definition at line 268 of file Syntax.h.

StringVec TypeSyntax::_members

protected

Definition at line 272 of file Syntax.h.

string TypeSyntax::_name

protected

Definition at line 267 of file Syntax.h.

const Syntax* TypeSyntax::_parent

protected

Definition at line 266 of file Syntax.h.

string TypeSyntax::_typeAlias

protected

Definition at line 270 of file Syntax.h.

string TypeSyntax::_typeDefinition

protected

Definition at line 271 of file Syntax.h.

string TypeSyntax::_uniformDefaultValue

protected

Definition at line 269 of file Syntax.h.

const StringVec TypeSyntax::EMPTY_MEMBERS

staticprotected

Definition at line 274 of file Syntax.h.

---

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

• MaterialXGenShader/Syntax.h