class ShadingGeometryFieldNode
Geometry field node describes a source node for geometry field data in a shading network, such as normals and tangents.
Properties
| Property | Description |
|---|
| FieldIndex | The geometry field index, for those fields that have multiple layers. If both name and index is set, the name has priority. |
| FieldName | The geometry field name, for those fields that have multiple layers. If both name and index is set, the name has priority. |
| FieldType | The geometry field type to sample. |
Methods
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 spShadingGeometryFieldNode, and if this is the case, returns the object cast into spShadingGeometryFieldNode. |
Properties details
FieldIndex
The geometry field index, for those fields that have multiple layers. If both name and index is set, the name has priority.
Syntax
SetFieldIndex parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | | | Field index which will be used. |
GetFieldIndex return value
Type: rid
Syntax
SetFieldIndex parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | | | Field index which will be used. |
GetFieldIndex return value
Type: rid
Syntax
SetFieldIndex parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | | | Field index which will be used. |
GetFieldIndex return value
Type: int
FieldName
The geometry field name, for those fields that have multiple layers. If both name and index is set, the name has priority.
Syntax
SetFieldName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | Field name which will be used. |
GetFieldName return value
Type: spString
Syntax
SetFieldName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | Field name which will be used. |
GetFieldName return value
Type: string
Syntax
SetFieldName parameters
| Name | Type | Min | Max | Description |
|---|
| value | str | | | Field name which will be used. |
GetFieldName return value
Type: str
FieldType
The geometry field type to sample.
Syntax
SetFieldType parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | | | Field type to sample. |
GetFieldType return value
Type: EGeometryDataFieldType
| Key | Value | Comment |
|---|
| Coords | 0 | Per-vertex coordinate data, xyz values (3 items per tuple) |
| TexCoords | 1 | Per-corner texture coords data, uv values (2 items per tuple) |
| Normals | 2 | Per-corner vertex normals data, xyz values (3 items per tuple) |
| Tangents | 3 | Per-corner vertex tangent data, xyz values (3 items per tuple) |
| Bitangents | 4 | Per-corner vertex bitangent data, xyz values (3 items per tuple) |
| Colors | 5 | Per-corner vertex color data, rgba values (4 items per tuple) |
| TriangleIds | 6 | Per-triangle triangle ids, id values, not interpolated. (1 item per tuple) |
| MaterialIds | 7 | Per-triangle material ids, id values, not interpolated. (1 item per tuple) |
Syntax
SetFieldType parameters
| Type | Name | Min | Max | Description |
|---|
rid | value | | | Field type to sample. |
GetFieldType return value
Type: EGeometryDataFieldType
| Key | Value | Comment |
|---|
| Coords | 0 | Per-vertex coordinate data, xyz values (3 items per tuple) |
| TexCoords | 1 | Per-corner texture coords data, uv values (2 items per tuple) |
| Normals | 2 | Per-corner vertex normals data, xyz values (3 items per tuple) |
| Tangents | 3 | Per-corner vertex tangent data, xyz values (3 items per tuple) |
| Bitangents | 4 | Per-corner vertex bitangent data, xyz values (3 items per tuple) |
| Colors | 5 | Per-corner vertex color data, rgba values (4 items per tuple) |
| TriangleIds | 6 | Per-triangle triangle ids, id values, not interpolated. (1 item per tuple) |
| MaterialIds | 7 | Per-triangle material ids, id values, not interpolated. (1 item per tuple) |
Syntax
SetFieldType parameters
| Name | Type | Min | Max | Description |
|---|
| value | int | | | Field type to sample. |
GetFieldType return value
Type: EGeometryDataFieldType
| Key | Value | Comment |
|---|
| EGeometryDataFieldType_Coords | 0 | Per-vertex coordinate data, xyz values (3 items per tuple) |
| EGeometryDataFieldType_TexCoords | 1 | Per-corner texture coords data, uv values (2 items per tuple) |
| EGeometryDataFieldType_Normals | 2 | Per-corner vertex normals data, xyz values (3 items per tuple) |
| EGeometryDataFieldType_Tangents | 3 | Per-corner vertex tangent data, xyz values (3 items per tuple) |
| EGeometryDataFieldType_Bitangents | 4 | Per-corner vertex bitangent data, xyz values (3 items per tuple) |
| EGeometryDataFieldType_Colors | 5 | Per-corner vertex color data, rgba values (4 items per tuple) |
| EGeometryDataFieldType_TriangleIds | 6 | Per-triangle triangle ids, id values, not interpolated. (1 item per tuple) |
| EGeometryDataFieldType_MaterialIds | 7 | Per-triangle material ids, id values, not interpolated. (1 item per tuple) |
Methods details
GetClass
Get the name of the ShadingGeometryFieldNode class.
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 | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
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
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
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
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
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
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: real
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to be fetched. |
Return value
Type: float
Syntax
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
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 | parameter_id | | | The id of the input to fetch the name of. |
Return value
Type: spString
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
rid | parameter_id | | | The id of the input to fetch the name of. |
Return value
Type: string
Syntax
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 ShadingGeometryFieldNode is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
const char * | type | | | Name of the class to check if ShadingGeometryFieldNode 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 ShadingGeometryFieldNode 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 ShadingGeometryFieldNode is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ShadingGeometryFieldNode object is invalid.
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
SetDefaultParameter
The default parameter values.
Syntax
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
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
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
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 spShadingGeometryFieldNode, and if this is the case, returns the object cast into spShadingGeometryFieldNode.
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: ShadingGeometryFieldNode
Syntax
Parameters
| Type | Name | Min | Max | Description |
|---|
Object | object | | | Object to cast. |
Return value
Type: ShadingGeometryFieldNode
Syntax
Parameters
| Name | Type | Min | Max | Description |
|---|
| object | Object | | | Object to cast. |
Return value
Type: ShadingGeometryFieldNode
