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. |
| Name | The name of the ShadingGeometryFieldNode object. (Inherited from Object) |
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 ShadingGeometryFieldNode 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 ShadingGeometryFieldNode is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
| IsNull | Returns true if the ShadingGeometryFieldNode object is invalid. (Inherited from Object) |
| IsSameObjectAs | Returns true if the ShadingGeometryFieldNode object is valid. (Inherited from Object) |
| NonNull | Returns true if the ShadingGeometryFieldNode object is valid. (Inherited from Object) |
| PrintInfo | Prints the content/info of the ShadingGeometryFieldNode 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 spShadingGeometryFieldNode, and if this is the case, returns the object cast into spShadingGeometryFieldNode. (Inherited from Object) |
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 |
|---|
int | value | | | Field index which will be used. |
GetFieldIndex return value
Type: int
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, default attribute format type F32vec3) |
| TexCoords | 1 | Per-corner texture coords data, uv values (2 items per tuple, default attribute format type F32vec2) |
| Normals | 2 | Per-corner vertex normals data, xyz values (3 items per tuple, default attribute format type F32vec3) |
| Tangents | 3 | Per-corner vertex tangent data, xyz values (3 items per tuple, default attribute format type F32vec3) |
| Bitangents | 4 | Per-corner vertex bitangent data, xyz values (3 items per tuple, default attribute format type F32vec3) |
| Colors | 5 | Per-corner vertex color data, rgba values (4 items per tuple, default attribute format type F32vec4) |
| TriangleIds | 6 | Per-triangle triangle ids, id values, not interpolated. (1 item per tuple, default attribute format type S32) |
| MaterialIds | 7 | Per-triangle material ids, id values, not interpolated. (1 item per tuple, default attribute format type S32) |
| VertexIds | 8 | Per-corner vertex ids, id values, not interpolated. (1 item per tuple, default attribute format type S32) |
| UserVertexField | 9 | User-defined Per-vertex geometry data field. |
| UserCornerField | 10 | User-defined Per-corner geometry data field. |
| UserTriangleField | 11 | User-defined Per-triangle geometry data field. |
| CustomField | 12 | Custom-size user-defined geometry data field. |
Syntax
SetFieldType parameters
| Type | Name | Min | Max | Description |
|---|
int | 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, default attribute format type F32vec3) |
| TexCoords | 1 | Per-corner texture coords data, uv values (2 items per tuple, default attribute format type F32vec2) |
| Normals | 2 | Per-corner vertex normals data, xyz values (3 items per tuple, default attribute format type F32vec3) |
| Tangents | 3 | Per-corner vertex tangent data, xyz values (3 items per tuple, default attribute format type F32vec3) |
| Bitangents | 4 | Per-corner vertex bitangent data, xyz values (3 items per tuple, default attribute format type F32vec3) |
| Colors | 5 | Per-corner vertex color data, rgba values (4 items per tuple, default attribute format type F32vec4) |
| TriangleIds | 6 | Per-triangle triangle ids, id values, not interpolated. (1 item per tuple, default attribute format type S32) |
| MaterialIds | 7 | Per-triangle material ids, id values, not interpolated. (1 item per tuple, default attribute format type S32) |
| VertexIds | 8 | Per-corner vertex ids, id values, not interpolated. (1 item per tuple, default attribute format type S32) |
| UserVertexField | 9 | User-defined Per-vertex geometry data field. |
| UserCornerField | 10 | User-defined Per-corner geometry data field. |
| UserTriangleField | 11 | User-defined Per-triangle geometry data field. |
| CustomField | 12 | Custom-size user-defined geometry data field. |
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, default attribute format type F32vec3) |
| EGeometryDataFieldType_TexCoords | 1 | Per-corner texture coords data, uv values (2 items per tuple, default attribute format type F32vec2) |
| EGeometryDataFieldType_Normals | 2 | Per-corner vertex normals data, xyz values (3 items per tuple, default attribute format type F32vec3) |
| EGeometryDataFieldType_Tangents | 3 | Per-corner vertex tangent data, xyz values (3 items per tuple, default attribute format type F32vec3) |
| EGeometryDataFieldType_Bitangents | 4 | Per-corner vertex bitangent data, xyz values (3 items per tuple, default attribute format type F32vec3) |
| EGeometryDataFieldType_Colors | 5 | Per-corner vertex color data, rgba values (4 items per tuple, default attribute format type F32vec4) |
| EGeometryDataFieldType_TriangleIds | 6 | Per-triangle triangle ids, id values, not interpolated. (1 item per tuple, default attribute format type S32) |
| EGeometryDataFieldType_MaterialIds | 7 | Per-triangle material ids, id values, not interpolated. (1 item per tuple, default attribute format type S32) |
| EGeometryDataFieldType_VertexIds | 8 | Per-corner vertex ids, id values, not interpolated. (1 item per tuple, default attribute format type S32) |
| EGeometryDataFieldType_UserVertexField | 9 | User-defined Per-vertex geometry data field. |
| EGeometryDataFieldType_UserCornerField | 10 | User-defined Per-corner geometry data field. |
| EGeometryDataFieldType_UserTriangleField | 11 | User-defined Per-triangle geometry data field. |
| EGeometryDataFieldType_CustomField | 12 | Custom-size user-defined geometry data field. |
Name
The name of the ShadingGeometryFieldNode 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
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 ShadingGeometryFieldNode 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 ShadingGeometryFieldNode 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 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. (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 ShadingGeometryFieldNode 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 ShadingGeometryFieldNode 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 ShadingGeometryFieldNode 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 spShadingGeometryFieldNode, and if this is the case, returns the object cast into spShadingGeometryFieldNode. (Inherited from Object)
