MaterialX 1.38.10
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
TypeSyntax Class Referenceabstract

Base class for syntax handling of types. More...

#include <Syntax.h>

Inheritance diagram for TypeSyntax:
AggregateTypeSyntax ScalarTypeSyntax StringTypeSyntax

Public Member Functions

const string & getName () const
 Returns the type name.
 
const string & getTypeAlias () const
 Returns a type alias if needed to define the type in the target language.
 
const string & getTypeDefinition () const
 Returns a type definition if needed to define the type in the target language.
 
const string & getDefaultValue (bool uniform) const
 Returns the default value for this type.
 
const StringVec & getMembers () const
 Returns the syntax for accessing type members if the type can be swizzled.
 
virtual string getValue (const ShaderPort *port, bool uniform) const
 Returns a value formatted according to this type syntax. More...
 
virtual string getValue (const Value &value, bool uniform) const =0
 Returns a value formatted according to this type syntax. More...
 
virtual string getValue (const StringVec &values, bool uniform) const =0
 Returns a value formatted according to this type syntax. More...
 

Protected Member Functions

 TypeSyntax (const string &name, const string &defaultValue, const string &uniformDefaultValue, const string &typeAlias, const string &typeDefinition, const StringVec &members)
 Protected constructor.
 

Protected Attributes

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.

Member Function Documentation

◆ getValue() [1/3]

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

◆ getValue() [2/3]

virtual string getValue ( const StringVec &  values,
bool  uniform 
) const
pure virtual

Returns a value formatted according to this type syntax.

The value is constructed from the given list of value entries with one entry for each member of the type.

Implemented in ScalarTypeSyntax, and AggregateTypeSyntax.

◆ getValue() [3/3]

virtual string 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 ScalarTypeSyntax, StringTypeSyntax, and AggregateTypeSyntax.

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