Simplygon 9 Documentation

# class ShadingVertexColorNode

VertexColorNode describes a vertex color source node in a shading network.

# Properties

Property Description
VertexColorIndex The vertex color index. This is the vertex color field in the geometry which will be used for casting with this node.
VertexColorSet The vertex color set. This is the vertex color field in the geometry which will be used for casting with this node.

# Methods

Method Description
GetClass Get the name of the ShadingVertexColorNode class.
GetDefaultParameterAlpha The default parameter values.
GetDefaultParameterBlue The default parameter values.
GetDefaultParameterGreen The default parameter values.
GetDefaultParameterRed The default parameter values.
GetParameterCount The input count.
GetParameterName The name of a parameter.
IsA Returns true if ShadingVertexColorNode is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the ShadingVertexColorNode object is invalid.
SetDefaultParameter The default parameter values.

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spShadingVertexColorNode, and if this is the case, returns the object cast into spShadingVertexColorNode.

# Properties details

# VertexColorIndex

The vertex color index. This is the vertex color field in the geometry which will be used for casting with this node.

# Syntax

// Setter
void SetVertexColorIndex( rid value );

// Getter
rid GetVertexColorIndex();

# SetVertexColorIndex parameters

Type Name Min Max Description
rid value Vertex color index which will be used.

# GetVertexColorIndex return value

Type: rid

# VertexColorSet

The vertex color set. This is the vertex color field in the geometry which will be used for casting with this node.

# Syntax

// Setter
void SetVertexColorSet( const char * value );

// Getter
spString GetVertexColorSet();

# SetVertexColorSet parameters

Type Name Min Max Description
const char * value Vertex color set which will be used.

# GetVertexColorSet return value

Type: spString

# Methods details

# GetClass

Get the name of the ShadingVertexColorNode class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetDefaultParameterAlpha

The default parameter values.

# Syntax

real GetDefaultParameterAlpha( rid parameter_id );

# Parameters

Type Name Min Max Description
rid parameter_id The id of the input to be fetched.

# Return value

Type: real

# GetDefaultParameterBlue

The default parameter values.

# Syntax

real GetDefaultParameterBlue( rid parameter_id );

# Parameters

Type Name Min Max Description
rid parameter_id The id of the input to be fetched.

# Return value

Type: real

# GetDefaultParameterGreen

The default parameter values.

# Syntax

real GetDefaultParameterGreen( rid parameter_id );

# Parameters

Type Name Min Max Description
rid parameter_id The id of the input to be fetched.

# Return value

Type: real

# GetDefaultParameterRed

The default parameter values.

# Syntax

real GetDefaultParameterRed( rid parameter_id );

# Parameters

Type Name Min Max Description
rid parameter_id The id of the input to be fetched.

# Return value

Type: real

# GetParameterCount

The input count.

# Syntax

unsigned int GetParameterCount();

# Parameters

GetParameterCount takes no parameters.

# Return value

Type: unsigned int

# GetParameterName

The name of a parameter.

# Syntax

spString GetParameterName( rid parameter_id );

# Parameters

Type Name Min Max Description
rid parameter_id The id of the input to fetch the name of.

# Return value

Type: spString

# IsA

Returns true if ShadingVertexColorNode is a or is a descendant of the class named as the type parameter.

# Syntax

bool IsA( const char * type );

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if ShadingVertexColorNode is, or is a descendant of.

# Return value

Type: bool

# IsNull

Returns true if the ShadingVertexColorNode object is invalid.

# Syntax

bool IsNull();

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# SetDefaultParameter

The default parameter values.

# Syntax

void SetDefaultParameter( rid parameter_id , real r , real g , real b , real a );

# Parameters

Type Name Min Max Description
rid parameter_id The id of the input to be set.
real r The value of red to which the default input will be set.
real g The value of green to which the default input will be set.
real b The value of blue to which the default input will be set.
real a The value of alpha to which the default input will be set.

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter.

# Syntax

static bool IsClassA( const char * type );

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if the class is, or is a descendant of.

# Return value

Type: bool

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spShadingVertexColorNode, and if this is the case, returns the object cast into spShadingVertexColorNode.

# Syntax

static spShadingVertexColorNode SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: ShadingVertexColorNode

← Texture →