Simplygon 9 Documentation

# 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

Method Description
GetClass Get the name of the ShadingGeometryFieldNode 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 ShadingGeometryFieldNode is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the ShadingGeometryFieldNode 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 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

// Setter
void SetFieldIndex( rid value );

// Getter
rid GetFieldIndex();

# SetFieldIndex parameters

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

# GetFieldIndex return value

Type: rid

# FieldName

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

# Syntax

// Setter
void SetFieldName( const char * value );

// Getter
spString GetFieldName();

# SetFieldName parameters

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

# GetFieldName return value

Type: spString

# FieldType

The geometry field type to sample.

# Syntax

// Setter
void SetFieldType( rid value );

// Getter
Simplygon::EGeometryDataFieldType GetFieldType();

# 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)

# Methods details

# GetClass

Get the name of the ShadingGeometryFieldNode class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# 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

# 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

# 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

# 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

# GetParameterCount

The input count.

# Syntax

unsigned int GetParameterCount();

# Parameters

GetParameterCount takes no parameters.

# Return value

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

# IsA

Returns true if ShadingGeometryFieldNode 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 ShadingGeometryFieldNode is, or is a descendant of.

# Return value

Type: bool

# IsNull

Returns true if the ShadingGeometryFieldNode object is invalid.

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

# 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

# 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

static spShadingGeometryFieldNode SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: ShadingGeometryFieldNode

← ShadingGreaterThanNode →