`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.

Type	Name	Min	Max	Description
`rid`	value			Field index which will be used.

Type	Name	Min	Max	Description
`int`	value			Field index which will be used.

Name	Type	Min	Max	Description
value	`int`			Field index which will be used.

FieldName

The geometry field name, for those fields that have multiple layers. If both name and index is set, the name has priority.

Type	Name	Min	Max	Description
`const char *`	value			Field name which will be used.

Type	Name	Min	Max	Description
`string`	value			Field name which will be used.

Name	Type	Min	Max	Description
value	`str`			Field name which will be used.

FieldType

The geometry field type to sample.

Type	Name	Min	Max	Description
`rid`	value			Field type to sample.

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.

Type	Name	Min	Max	Description
`int`	value			Field type to sample.

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.

Name	Type	Min	Max	Description
value	`int`			Field type to sample.

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)

Type	Name	Min	Max	Description
`const char *`	name			New name of the object.

Type	Name	Min	Max	Description
`string`	name			New name of the object.

Name	Type	Min	Max	Description
name	`str`			New name of the object.

Methods details

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Type	Name	Min	Max	Description
`Observer`	observer			Observer is the object that will receive events.

Name	Type	Min	Max	Description
observer	`Observer`			Observer is the object that will receive events.

GetClass

Get the name of the ShadingGeometryFieldNode class. (Inherited from Object)

GetDefaultParameterAlpha

The default parameter values.

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

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

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

GetDefaultParameterBlue

The default parameter values.

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

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

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

GetDefaultParameterGreen

The default parameter values.

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

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

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

GetDefaultParameterRed

The default parameter values.

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

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

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

GetParameterCount

The input count.

GetParameterName

The name of a parameter.

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

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

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

IsA

Returns true if ShadingGeometryFieldNode is a or is a descendant of the class named as the type parameter. (Inherited from Object)

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

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

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

IsNull

Returns true if the ShadingGeometryFieldNode object is invalid. (Inherited from Object)

IsSameObjectAs

Returns true if the ShadingGeometryFieldNode object is valid. (Inherited from Object)

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Name	Type	Min	Max	Description
object	Object			Object to compare with.

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)

Type	Name	Min	Max	Description
`rid`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Type	Name	Min	Max	Description
`int`	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Name	Type	Min	Max	Description
observerId	`int`			ObserverId is the id returned by AddObserver when the observer was added.

SetDefaultParameter

The default parameter values.

Type	Name	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.

Type	Name	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.

Name	Type	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)

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

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

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)

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class ShadingGeometryFieldNode ​

Properties ​

Methods ​

Static methods ​

Properties details ​

FieldIndex ​

FieldName ​

FieldType ​

Name ​

Methods details ​

AddObserver ​

GetClass ​

GetDefaultParameterAlpha ​

GetDefaultParameterBlue ​

GetDefaultParameterGreen ​

GetDefaultParameterRed ​

`class` ShadingGeometryFieldNode

Properties

Methods

Static methods

Properties details

FieldIndex

FieldName

FieldType

Name

Methods details

AddObserver

GetClass

GetDefaultParameterAlpha

GetDefaultParameterBlue

GetDefaultParameterGreen

GetDefaultParameterRed