class ShadingVertexColorNode
VertexColorNode describes a vertex color source node in a shading network.
Properties
| Property | Description |
|---|
| Name | The name of the ShadingVertexColorNode object. (Inherited from Object) |
| 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 |
|---|
| AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
| GetClass | Get the name of the ShadingVertexColorNode class. (Inherited from Object) |
| GetDefaultParameterAlpha | The default parameter values. (Inherited from ShadingNode) |
| GetDefaultParameterBlue | The default parameter values. (Inherited from ShadingNode) |
| GetDefaultParameterGreen | The default parameter values. (Inherited from ShadingNode) |
| GetDefaultParameterRed | The default parameter values. (Inherited from ShadingNode) |
| GetParameterCount | The input count. (Inherited from ShadingNode) |
| GetParameterName | The name of a parameter. (Inherited from ShadingNode) |
| IsA | Returns true if ShadingVertexColorNode is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the ShadingVertexColorNode object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ShadingVertexColorNode object is valid. (Inherited from Object) |
| NonNull | Returns true if the ShadingVertexColorNode object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ShadingVertexColorNode object to the log. (Inherited from Object) |
| RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
| SetDefaultParameter | The default parameter values. (Inherited from ShadingNode) |
Static methods
| Method | Description |
|---|
| IsClassA | Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| 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. (Inherited from Object) |
Properties details
Name
The name of the ShadingVertexColorNode object. (Inherited from Object)
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | name | | | New name of the object. |
GetName return value
Type: spString
Syntax
SetName parameters
| Type | Name | Min | Max | Description |
|---|
string | name | | | New name of the object. |
GetName return value
Type: string
Syntax
SetName parameters
| Name | Type | Min | Max | Description |
|---|
| name | str | | | New name of the object. |
GetName return value
Type: str
VertexColorIndex
The vertex color index. This is the vertex color field in the geometry which will be used for casting with this node.
Syntax
SetVertexColorIndex parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | | | Vertex color index which will be used. |
GetVertexColorIndex return value
Type: rid
Syntax
SetVertexColorIndex parameters
| Type | Name | Min | Max | Description |
|---|
int | value | | | Vertex color index which will be used. |
GetVertexColorIndex return value
Type: int
Syntax
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
SetVertexColorSet parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | Vertex color set which will be used. |
GetVertexColorSet return value
Type: spString
Syntax
SetVertexColorSet parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | Vertex color set which will be used. |
GetVertexColorSet return value
Type: string
Syntax
SetVertexColorSet parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | Vertex color set which will be used. |
GetVertexColorSet return value
Type: str
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: rid
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Observer | observer | | | Observer is the object that will receive events. |
Return value
Type: int
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observer | Observer | | | Observer is the object that will receive events. |
Return value
Type: int
GetClass
Get the name of the ShadingVertexColorNode class. (Inherited from Object)
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
GetDefaultParameterAlpha
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameterId | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameterId | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameterId | int | | | The id of the input to be fetched. |
Return value
Type: float
GetDefaultParameterBlue
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameterId | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameterId | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameterId | int | | | The id of the input to be fetched. |
Return value
Type: float
GetDefaultParameterGreen
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameterId | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameterId | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameterId | int | | | The id of the input to be fetched. |
Return value
Type: float
GetDefaultParameterRed
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameterId | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameterId | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameterId | int | | | The id of the input to be fetched. |
Return value
Type: float
GetParameterCount
The input count.
Syntax
Parameters
GetParameterCount takes no parameters.
Return value
Type: unsigned int
Syntax
Parameters
GetParameterCount takes no parameters.
Return value
Type: uint
Syntax
Parameters
GetParameterCount takes no parameters.
Return value
Type: int
GetParameterName
The name of a parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameterId | | | The id of the input to fetch the name of. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameterId | | | The id of the input to fetch the name of. |
Return value
Type: string
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameterId | 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. (Inherited from Object)
Syntax
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
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
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. (Inherited from Object)
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
IsSameObjectAs
Returns true if the ShadingVertexColorNode object is valid. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
| Object | object | | | Object to compare with. |
Return value
Type: bool
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to compare with. |
Return value
Type: bool
NonNull
Returns true if the ShadingVertexColorNode object is valid. (Inherited from Object)
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
NonNull takes no parameters.
Return value
Type: bool
PrintInfo
Prints the content/info of the ShadingVertexColorNode object to the log. (Inherited from Object)
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
Syntax
Parameters
PrintInfo takes no parameters.
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
int | observerId | | | ObserverId is the id returned by AddObserver when the observer was added. |
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| observerId | int | | | ObserverId is the id returned by AddObserver when the observer was added. |
SetDefaultParameter
The default parameter values.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameterId | | | 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
Parameters
| Type | Name | Min | Max | Description |
|---|
int | parameterId | | | 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
Parameters
| Name | Type | Min | Max | Description |
|---|
| parameterId | 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. (Inherited from Object)
Syntax
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
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
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. (Inherited from Object)
