class ShadingTextureNode

TextureNode describes a texture source node in a shading network. When used in an input material, TextureName identifies a texture in the source TextureTable, and TexCoordName or TexCoordLevel selects the texture coordinate field on the input geometry used to sample it. These input field references are independent of MappingImageSettings::TexCoordName and TexCoordLevel, which select the destination UV field on the processed geometry.

Properties

Property	Description
ColorSpaceOverride	Used to override the color space of the sampled texture. Set to Undefined to not override, and use the color space defined in the texture and/or image data object.
Name	The name of the ShadingTextureNode object. (Inherited from Object)
OffsetU	The OffsetU value, which is will be added to the U-coordinate when sampling.
OffsetV	The OffsetV value, which is will be added to the V-coordinate when sampling.
Rotation	The rotation value, which is used to rotate the UV coordinates when sampling.
TexCoordLevel	The texture coordinate level used to sample this texture during casting if this node's TexCoordName has not been set. When this node is part of an input material, it refers to the original geometry's UV field, not the destination field selected by MappingImageSettings::TexCoordLevel. Setting the TexCoordName is still required for generating shader code.
TexCoordName	The name of the texture coordinate field used to sample this texture. When this node is part of an input material, it refers to the original geometry's UV field, not the destination field selected by MappingImageSettings::TexCoordName. If not set, the material uses this node's TexCoordLevel (index) instead. The TexCoordName is required when generating shader data.
TextureName	The name of the texture in the texture table used for casting. If both this and texture image is set, the casting uses the texture image.
TextureWrapMode	The texture wrap mode in both U and V direction, which determines what happens to texture samples outside the 0-1 range. Setting this property affects both U and V direction, and getting this property returns the wrap mode in U direction in the case when they are different.
TextureWrapModeU	The texture wrap mode in U direction, which determines what happens to texture samples outside the 0-1 range.
TextureWrapModeV	The texture wrap mode in V direction, which determines what happens to texture samples outside the 0-1 range.
TileU	The TileU value, which is multiplied into the U-coordinate when sampling.
TileV	The TileV value, which is multiplied into the U-coordinate when sampling.
UseSRGB	The use of sRGB when decoding the texture into an RGBA value.

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 ShadingTextureNode 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 ShadingTextureNode is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the ShadingTextureNode object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the ShadingTextureNode object is valid. (Inherited from Object)
NonNull	Returns true if the ShadingTextureNode object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the ShadingTextureNode 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 spShadingTextureNode, and if this is the case, returns the object cast into spShadingTextureNode. (Inherited from Object)

Properties details

ColorSpaceOverride

Used to override the color space of the sampled texture. Set to Undefined to not override, and use the color space defined in the texture and/or image data object.

Syntax

// Setter
void SetColorSpaceOverride( Simplygon::EImageColorSpace value ) const;

// Getter
Simplygon::EImageColorSpace GetColorSpaceOverride() const;

SetColorSpaceOverride parameters

Type	Name	Min	Max	Description
EImageColorSpace	value			The value to set ColorSpaceOverride to.

GetColorSpaceOverride return value

Type: EImageColorSpace

Key	Value	Comment
Undefined	0	The color space is undefined, or using the color space of an input image data.
Linear	1	The color space is linear (linear gamma).
sRGB	2	The color space is sRGB (nominal gamma of 2.2).

Syntax

// Setter
void SetColorSpaceOverride(EImageColorSpace value);

// Getter
EImageColorSpace GetColorSpaceOverride();

SetColorSpaceOverride parameters

Type	Name	Min	Max	Description
EImageColorSpace	value			The value to set ColorSpaceOverride to.

GetColorSpaceOverride return value

Type: EImageColorSpace

Key	Value	Comment
Undefined	0	The color space is undefined, or using the color space of an input image data.
Linear	1	The color space is linear (linear gamma).
sRGB	2	The color space is sRGB (nominal gamma of 2.2).

Syntax

# Setter
None SetColorSpaceOverride(value: EImageColorSpace_*)

# Getter
EImageColorSpace_* GetColorSpaceOverride()

SetColorSpaceOverride parameters

Name	Type	Min	Max	Description
value	EImageColorSpace			The value to set ColorSpaceOverride to.

GetColorSpaceOverride return value

Type: EImageColorSpace

Key	Value	Comment
EImageColorSpace_Undefined	0	The color space is undefined, or using the color space of an input image data.
EImageColorSpace_Linear	1	The color space is linear (linear gamma).
EImageColorSpace_sRGB	2	The color space is sRGB (nominal gamma of 2.2).

Name

The name of the ShadingTextureNode object. (Inherited from Object)

Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

SetName parameters

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

GetName return value

Type: spString

Syntax

// Setter
void SetName(string name);

// Getter
string GetName();

SetName parameters

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

GetName return value

Type: string

Syntax

# Setter
None SetName(name: str)

# Getter
str GetName()

SetName parameters

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

GetName return value

Type: str

OffsetU

The OffsetU value, which is will be added to the U-coordinate when sampling.

Syntax

// Setter
void SetOffsetU( real value ) const;

// Getter
real GetOffsetU() const;

SetOffsetU parameters

Type	Name	Min	Max	Description
real	value			The new value.

GetOffsetU return value

Type: real

Syntax

// Setter
void SetOffsetU(float value);

// Getter
float GetOffsetU();

SetOffsetU parameters

Type	Name	Min	Max	Description
float	value			The new value.

GetOffsetU return value

Type: float

Syntax

# Setter
None SetOffsetU(value: float)

# Getter
float GetOffsetU()

SetOffsetU parameters

Name	Type	Min	Max	Description
value	float			The new value.

GetOffsetU return value

Type: float

OffsetV

The OffsetV value, which is will be added to the V-coordinate when sampling.

Syntax

// Setter
void SetOffsetV( real value ) const;

// Getter
real GetOffsetV() const;

SetOffsetV parameters

Type	Name	Min	Max	Description
real	value			The new value.

GetOffsetV return value

Type: real

Syntax

// Setter
void SetOffsetV(float value);

// Getter
float GetOffsetV();

SetOffsetV parameters

Type	Name	Min	Max	Description
float	value			The new value.

GetOffsetV return value

Type: float

Syntax

# Setter
None SetOffsetV(value: float)

# Getter
float GetOffsetV()

SetOffsetV parameters

Name	Type	Min	Max	Description
value	float			The new value.

GetOffsetV return value

Type: float

Rotation

The rotation value, which is used to rotate the UV coordinates when sampling.

Syntax

// Setter
void SetRotation( real value ) const;

// Getter
real GetRotation() const;

SetRotation parameters

Type	Name	Min	Max	Description
real	value			The rotation value.

GetRotation return value

Type: real

Syntax

// Setter
void SetRotation(float value);

// Getter
float GetRotation();

SetRotation parameters

Type	Name	Min	Max	Description
float	value			The rotation value.

GetRotation return value

Type: float

Syntax

# Setter
None SetRotation(value: float)

# Getter
float GetRotation()

SetRotation parameters

Name	Type	Min	Max	Description
value	float			The rotation value.

GetRotation return value

Type: float

TexCoordLevel

The texture coordinate level used to sample this texture during casting if this node's TexCoordName has not been set. When this node is part of an input material, it refers to the original geometry's UV field, not the destination field selected by MappingImageSettings::TexCoordLevel. Setting the TexCoordName is still required for generating shader code.

Syntax

// Setter
void SetTexCoordLevel( int value ) const;

// Getter
int GetTexCoordLevel() const;

SetTexCoordLevel parameters

Type	Name	Min	Max	Description
int	value			The desired texture level.

GetTexCoordLevel return value

Type: int

Syntax

// Setter
void SetTexCoordLevel(int value);

// Getter
int GetTexCoordLevel();

SetTexCoordLevel parameters

Type	Name	Min	Max	Description
int	value			The desired texture level.

GetTexCoordLevel return value

Type: int

Syntax

# Setter
None SetTexCoordLevel(value: int)

# Getter
int GetTexCoordLevel()

SetTexCoordLevel parameters

Name	Type	Min	Max	Description
value	int			The desired texture level.

GetTexCoordLevel return value

Type: int

TexCoordName

The name of the texture coordinate field used to sample this texture. When this node is part of an input material, it refers to the original geometry's UV field, not the destination field selected by MappingImageSettings::TexCoordName. If not set, the material uses this node's TexCoordLevel (index) instead. The TexCoordName is required when generating shader data.

Syntax

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

// Getter
spString GetTexCoordName() const;

SetTexCoordName parameters

Type	Name	Min	Max	Description
const char *	value			The desired texture level name.

GetTexCoordName return value

Type: spString

Syntax

// Setter
void SetTexCoordName(string value);

// Getter
string GetTexCoordName();

SetTexCoordName parameters

Type	Name	Min	Max	Description
string	value			The desired texture level name.

GetTexCoordName return value

Type: string

Syntax

# Setter
None SetTexCoordName(value: str)

# Getter
str GetTexCoordName()

SetTexCoordName parameters

Name	Type	Min	Max	Description
value	str			The desired texture level name.

GetTexCoordName return value

Type: str

TextureName

The name of the texture in the texture table used for casting. If both this and texture image is set, the casting uses the texture image.

Syntax

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

// Getter
spString GetTextureName() const;

SetTextureName parameters

Type	Name	Min	Max	Description
const char *	value			The path the texture will be read from.

GetTextureName return value

Type: spString

Syntax

// Setter
void SetTextureName(string value);

// Getter
string GetTextureName();

SetTextureName parameters

Type	Name	Min	Max	Description
string	value			The path the texture will be read from.

GetTextureName return value

Type: string

Syntax

# Setter
None SetTextureName(value: str)

# Getter
str GetTextureName()

SetTextureName parameters

Name	Type	Min	Max	Description
value	str			The path the texture will be read from.

GetTextureName return value

Type: str

TextureWrapMode

The texture wrap mode in both U and V direction, which determines what happens to texture samples outside the 0-1 range. Setting this property affects both U and V direction, and getting this property returns the wrap mode in U direction in the case when they are different.

Syntax

// Setter
void SetTextureWrapMode( Simplygon::ETextureWrapMode value ) const;

// Getter
Simplygon::ETextureWrapMode GetTextureWrapMode() const;

SetTextureWrapMode parameters

Type	Name	Min	Max	Description
ETextureWrapMode	value			The new texture wrap mode.

GetTextureWrapMode return value

Type: ETextureWrapMode

Default: Wrap

Key	Value	Comment
Wrap	0	Wrap texture mode, samples the tex coords using the fractional part of the texture coordinate.
Clamp	1	Clamp texture mode, will clamp the texture coordinates to [0,1)
Mirror	2	Mirror texture mode, which uses the fractional part, but flips it every other integer part, so e.g. 0->1->0->1->0 for the range 0->4

Syntax

// Setter
void SetTextureWrapMode(ETextureWrapMode value);

// Getter
ETextureWrapMode GetTextureWrapMode();

SetTextureWrapMode parameters

Type	Name	Min	Max	Description
ETextureWrapMode	value			The new texture wrap mode.

GetTextureWrapMode return value

Type: ETextureWrapMode

Default: Wrap

Key	Value	Comment
Wrap	0	Wrap texture mode, samples the tex coords using the fractional part of the texture coordinate.
Clamp	1	Clamp texture mode, will clamp the texture coordinates to [0,1)
Mirror	2	Mirror texture mode, which uses the fractional part, but flips it every other integer part, so e.g. 0->1->0->1->0 for the range 0->4

Syntax

# Setter
None SetTextureWrapMode(value: ETextureWrapMode_*)

# Getter
ETextureWrapMode_* GetTextureWrapMode()

SetTextureWrapMode parameters

Name	Type	Min	Max	Description
value	ETextureWrapMode			The new texture wrap mode.

GetTextureWrapMode return value

Type: ETextureWrapMode

Default: Wrap

Key	Value	Comment
ETextureWrapMode_Wrap	0	Wrap texture mode, samples the tex coords using the fractional part of the texture coordinate.
ETextureWrapMode_Clamp	1	Clamp texture mode, will clamp the texture coordinates to [0,1)
ETextureWrapMode_Mirror	2	Mirror texture mode, which uses the fractional part, but flips it every other integer part, so e.g. 0->1->0->1->0 for the range 0->4

TextureWrapModeU

The texture wrap mode in U direction, which determines what happens to texture samples outside the 0-1 range.

Syntax

// Setter
void SetTextureWrapModeU( Simplygon::ETextureWrapMode value ) const;

// Getter
Simplygon::ETextureWrapMode GetTextureWrapModeU() const;

SetTextureWrapModeU parameters

Type	Name	Min	Max	Description
ETextureWrapMode	value			The new texture wrap mode in U direction.

GetTextureWrapModeU return value

Type: ETextureWrapMode

Default: Wrap

Key	Value	Comment
Wrap	0	Wrap texture mode, samples the tex coords using the fractional part of the texture coordinate.
Clamp	1	Clamp texture mode, will clamp the texture coordinates to [0,1)
Mirror	2	Mirror texture mode, which uses the fractional part, but flips it every other integer part, so e.g. 0->1->0->1->0 for the range 0->4

Syntax

// Setter
void SetTextureWrapModeU(ETextureWrapMode value);

// Getter
ETextureWrapMode GetTextureWrapModeU();

SetTextureWrapModeU parameters

Type	Name	Min	Max	Description
ETextureWrapMode	value			The new texture wrap mode in U direction.

GetTextureWrapModeU return value

Type: ETextureWrapMode

Default: Wrap

Key	Value	Comment
Wrap	0	Wrap texture mode, samples the tex coords using the fractional part of the texture coordinate.
Clamp	1	Clamp texture mode, will clamp the texture coordinates to [0,1)
Mirror	2	Mirror texture mode, which uses the fractional part, but flips it every other integer part, so e.g. 0->1->0->1->0 for the range 0->4

Syntax

# Setter
None SetTextureWrapModeU(value: ETextureWrapMode_*)

# Getter
ETextureWrapMode_* GetTextureWrapModeU()

SetTextureWrapModeU parameters

Name	Type	Min	Max	Description
value	ETextureWrapMode			The new texture wrap mode in U direction.

GetTextureWrapModeU return value

Type: ETextureWrapMode

Default: Wrap

Key	Value	Comment
ETextureWrapMode_Wrap	0	Wrap texture mode, samples the tex coords using the fractional part of the texture coordinate.
ETextureWrapMode_Clamp	1	Clamp texture mode, will clamp the texture coordinates to [0,1)
ETextureWrapMode_Mirror	2	Mirror texture mode, which uses the fractional part, but flips it every other integer part, so e.g. 0->1->0->1->0 for the range 0->4

TextureWrapModeV

The texture wrap mode in V direction, which determines what happens to texture samples outside the 0-1 range.

Syntax

// Setter
void SetTextureWrapModeV( Simplygon::ETextureWrapMode value ) const;

// Getter
Simplygon::ETextureWrapMode GetTextureWrapModeV() const;

SetTextureWrapModeV parameters

Type	Name	Min	Max	Description
ETextureWrapMode	value			The new texture wrap mode in V direction.

GetTextureWrapModeV return value

Type: ETextureWrapMode

Default: Wrap

Key	Value	Comment
Wrap	0	Wrap texture mode, samples the tex coords using the fractional part of the texture coordinate.
Clamp	1	Clamp texture mode, will clamp the texture coordinates to [0,1)
Mirror	2	Mirror texture mode, which uses the fractional part, but flips it every other integer part, so e.g. 0->1->0->1->0 for the range 0->4

Syntax

// Setter
void SetTextureWrapModeV(ETextureWrapMode value);

// Getter
ETextureWrapMode GetTextureWrapModeV();

SetTextureWrapModeV parameters

Type	Name	Min	Max	Description
ETextureWrapMode	value			The new texture wrap mode in V direction.

GetTextureWrapModeV return value

Type: ETextureWrapMode

Default: Wrap

Key	Value	Comment
Wrap	0	Wrap texture mode, samples the tex coords using the fractional part of the texture coordinate.
Clamp	1	Clamp texture mode, will clamp the texture coordinates to [0,1)
Mirror	2	Mirror texture mode, which uses the fractional part, but flips it every other integer part, so e.g. 0->1->0->1->0 for the range 0->4

Syntax

# Setter
None SetTextureWrapModeV(value: ETextureWrapMode_*)

# Getter
ETextureWrapMode_* GetTextureWrapModeV()

SetTextureWrapModeV parameters

Name	Type	Min	Max	Description
value	ETextureWrapMode			The new texture wrap mode in V direction.

GetTextureWrapModeV return value

Type: ETextureWrapMode

Default: Wrap

Key	Value	Comment
ETextureWrapMode_Wrap	0	Wrap texture mode, samples the tex coords using the fractional part of the texture coordinate.
ETextureWrapMode_Clamp	1	Clamp texture mode, will clamp the texture coordinates to [0,1)
ETextureWrapMode_Mirror	2	Mirror texture mode, which uses the fractional part, but flips it every other integer part, so e.g. 0->1->0->1->0 for the range 0->4

TileU

The TileU value, which is multiplied into the U-coordinate when sampling.

Syntax

// Setter
void SetTileU( real value ) const;

// Getter
real GetTileU() const;

SetTileU parameters

Type	Name	Min	Max	Description
real	value			The new value.

GetTileU return value

Type: real

Syntax

// Setter
void SetTileU(float value);

// Getter
float GetTileU();

SetTileU parameters

Type	Name	Min	Max	Description
float	value			The new value.

GetTileU return value

Type: float

Syntax

# Setter
None SetTileU(value: float)

# Getter
float GetTileU()

SetTileU parameters

Name	Type	Min	Max	Description
value	float			The new value.

GetTileU return value

Type: float

TileV

The TileV value, which is multiplied into the U-coordinate when sampling.

Syntax

// Setter
void SetTileV( real value ) const;

// Getter
real GetTileV() const;

SetTileV parameters

Type	Name	Min	Max	Description
real	value			The new value.

GetTileV return value

Type: real

Syntax

// Setter
void SetTileV(float value);

// Getter
float GetTileV();

SetTileV parameters

Type	Name	Min	Max	Description
float	value			The new value.

GetTileV return value

Type: float

Syntax

# Setter
None SetTileV(value: float)

# Getter
float GetTileV()

SetTileV parameters

Name	Type	Min	Max	Description
value	float			The new value.

GetTileV return value

Type: float

UseSRGB

The use of sRGB when decoding the texture into an RGBA value.

WARNING

This property is marked as deprecated and will be removed in a future version.

Use ColorSpaceOverride instead.

Syntax

// Setter
SGDEPRECATED void SetUseSRGB( bool value ) const;

// Getter
SGDEPRECATED bool GetUseSRGB() const;

SetUseSRGB parameters

Type	Name	Min	Max	Description
bool	value			The flag to use sRGB.

GetUseSRGB return value

Type: bool

Syntax

// Setter
void SetUseSRGB(bool value);

// Getter
bool GetUseSRGB();

SetUseSRGB parameters

Type	Name	Min	Max	Description
bool	value			The flag to use sRGB.

GetUseSRGB return value

Type: bool

Syntax

# Setter
None SetUseSRGB(value: bool)

# Getter
bool GetUseSRGB()

SetUseSRGB parameters

Name	Type	Min	Max	Description
value	bool			The flag to use sRGB.

GetUseSRGB return value

Type: bool

Methods details

AddObserver

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

Syntax

rid AddObserver( const spObserver & observer ) const;

Parameters

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

Return value

Type: rid

Syntax

int AddObserver(spObserver observer);

Parameters

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

Return value

Type: int

Syntax

int AddObserver(observer: spObserver)

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 ShadingTextureNode class. (Inherited from Object)

Syntax

spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

GetDefaultParameterAlpha

The default parameter values.

Syntax

real GetDefaultParameterAlpha( rid parameterId ) const;

Parameters

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

Return value

Type: real

Syntax

float GetDefaultParameterAlpha(int parameterId);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterAlpha(parameterId: int)

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

real GetDefaultParameterBlue( rid parameterId ) const;

Parameters

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

Return value

Type: real

Syntax

float GetDefaultParameterBlue(int parameterId);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterBlue(parameterId: int)

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

real GetDefaultParameterGreen( rid parameterId ) const;

Parameters

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

Return value

Type: real

Syntax

float GetDefaultParameterGreen(int parameterId);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterGreen(parameterId: int)

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

real GetDefaultParameterRed( rid parameterId ) const;

Parameters

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

Return value

Type: real

Syntax

float GetDefaultParameterRed(int parameterId);

Parameters

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

Return value

Type: float

Syntax

float GetDefaultParameterRed(parameterId: int)

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

unsigned int GetParameterCount() const;

Parameters

GetParameterCount takes no parameters.

Return value

Type: unsigned int

Syntax

uint GetParameterCount();

Parameters

GetParameterCount takes no parameters.

Return value

Type: uint

Syntax

int GetParameterCount()

Parameters

GetParameterCount takes no parameters.

Return value

Type: int

GetParameterName

The name of a parameter.

Syntax

spString GetParameterName( rid parameterId ) const;

Parameters

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

Return value

Type: spString

Syntax

string GetParameterName(int parameterId);

Parameters

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

Return value

Type: string

Syntax

str GetParameterName(parameterId: int)

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 ShadingTextureNode is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Syntax

bool IsA( const char * type ) const;

Parameters

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

Return value

Type: bool

Syntax

bool IsA(string type);

Parameters

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

Return value

Type: bool

Syntax

bool IsA(type: str)

Parameters

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

Return value

Type: bool

IsNull

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

Syntax

bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

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

Syntax

bool IsSameObjectAs( const spObject & object ) const;

Parameters

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

Return value

Type: bool

Syntax

bool IsSameObjectAs(spObject object);

Parameters

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

Return value

Type: bool

Syntax

bool IsSameObjectAs(object: spObject)

Parameters

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

Return value

Type: bool

NonNull

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

Syntax

bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull();

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull()

Parameters

NonNull takes no parameters.

Return value

Type: bool

PrintInfo

Prints the content/info of the ShadingTextureNode object to the log. (Inherited from Object)

Syntax

void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

Syntax

void PrintInfo();

Parameters

PrintInfo takes no parameters.

Syntax

None PrintInfo()

Parameters

PrintInfo takes no parameters.

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

Syntax

void RemoveObserver( rid observerId ) const;

Parameters

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

Syntax

void RemoveObserver(int observerId);

Parameters

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

Syntax

None RemoveObserver(observerId: int)

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

void SetDefaultParameter( rid parameterId , real r , real g , real b , real a ) const;

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

void SetDefaultParameter(int parameterId, float r, float g, float b, float a);

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

None SetDefaultParameter(parameterId: int, r: float, g: float, b: float, a: float)

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

static bool IsClassA( const char * type ) const;

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

static bool IsClassA(string type);

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

@staticmethod
bool IsClassA(type: str)

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 spShadingTextureNode, and if this is the case, returns the object cast into spShadingTextureNode. (Inherited from Object)

Syntax

static spShadingTextureNode SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: ShadingTextureNode

Syntax

static spShadingTextureNode SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: ShadingTextureNode

Syntax

@staticmethod
spShadingTextureNode SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: ShadingTextureNode