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

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

Syntax

# Setter
None SetVertexColorIndex(value: int)

# Getter
int GetVertexColorIndex()

SetVertexColorIndex parameters

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

GetVertexColorIndex return value

Type: int

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

Syntax

// Setter
void SetVertexColorSet(string value);

// Getter
string GetVertexColorSet();

SetVertexColorSet parameters

Type	Name	Min	Max	Description
string	value			Vertex color set which will be used.

GetVertexColorSet return value

Type: string

Syntax

# Setter
None SetVertexColorSet(value: str)

# Getter
str GetVertexColorSet()

SetVertexColorSet parameters

Name	Type	Min	Max	Description
value	str			Vertex color set which will be used.

GetVertexColorSet return value

Type: str

Methods details

GetClass

Get the name of the ShadingVertexColorNode class.

Syntax

spString GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

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

Syntax

float GetDefaultParameterAlpha(rid parameter_id);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterAlpha(parameter_id: int)

Parameters

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

Return value

Type: float

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

Syntax

float GetDefaultParameterBlue(rid parameter_id);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterBlue(parameter_id: int)

Parameters

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

Return value

Type: float

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

Syntax

float GetDefaultParameterGreen(rid parameter_id);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterGreen(parameter_id: int)

Parameters

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

Return value

Type: float

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

Syntax

float GetDefaultParameterRed(rid parameter_id);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterRed(parameter_id: int)

Parameters

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

Return value

Type: float

GetParameterCount

The input count.

Syntax

unsigned int GetParameterCount();

Parameters

GetParameterCount takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetParameterCount();

Parameters

GetParameterCount takes no parameters.

Return value

Type: uint

Syntax

int GetParameterCount()

Parameters

GetParameterCount takes no parameters.

Return value

Type: 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

Syntax

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

Syntax

str GetParameterName(parameter_id: int)

Parameters

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

Return value

Type: str

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

Syntax

bool IsA(string type);

Parameters

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

Return value

Type: bool

Syntax

bool IsA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			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

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

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.

Syntax

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

Parameters

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

Syntax

None SetDefaultParameter(parameter_id: int, r: float, g: float, b: float, a: float)

Parameters

Name	Type	Min	Max	Description
parameter_id	int			The id of the input to be set.
r	float			The value of red to which the default input will be set.
g	float			The value of green to which the default input will be set.
b	float			The value of blue to which the default input will be set.
a	float			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

Syntax

static bool IsClassA(string type);

Parameters

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

Return value

Type: bool

Syntax

@staticmethod
bool IsClassA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			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

Syntax

static spShadingVertexColorNode SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: ShadingVertexColorNode

Syntax

@staticmethod
spShadingVertexColorNode SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: ShadingVertexColorNode