class ShadingTextureNode
TextureNode describes a texture source node in a shading network.
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 texture coordinate level. The texture level is used during casting if the TexCoordName has not been set. Setting the TexCoordName is still required for generating shader code. |
| TexCoordName | The name of the texture coordinate. If not set, the material uses the texture level (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
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
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
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
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
OffsetU
The OffsetU value, which is will be added to the U-coordinate when sampling.
Syntax
SetOffsetU parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | The new value. |
GetOffsetU return value
Type: real
Syntax
SetOffsetU parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | The new value. |
GetOffsetU return value
Type: float
Syntax
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
SetOffsetV parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | The new value. |
GetOffsetV return value
Type: real
Syntax
SetOffsetV parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | The new value. |
GetOffsetV return value
Type: float
Syntax
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
SetRotation parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | The rotation value. |
GetRotation return value
Type: real
Syntax
SetRotation parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | The rotation value. |
GetRotation return value
Type: float
Syntax
SetRotation parameters
| Name | Type | Min | Max | Description |
|---|
| value | float | | | The rotation value. |
GetRotation return value
Type: float
TexCoordLevel
The texture texture coordinate level. The texture level is used during casting if the TexCoordName has not been set. Setting the TexCoordName is still required for generating shader code.
Syntax
SetTexCoordLevel parameters
| Type | Name | Min | Max | Description |
|---|
int | value | | | The desired texture level. |
GetTexCoordLevel return value
Type: int
Syntax
SetTexCoordLevel parameters
| Type | Name | Min | Max | Description |
|---|
int | value | | | The desired texture level. |
GetTexCoordLevel return value
Type: int
Syntax
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. If not set, the material uses the texture level (index) instead. The TexCoordName is required when generating shader data.
Syntax
SetTexCoordName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The desired texture level name. |
GetTexCoordName return value
Type: spString
Syntax
SetTexCoordName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The desired texture level name. |
GetTexCoordName return value
Type: string
Syntax
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
SetTextureName parameters
| Type | Name | Min | Max | Description |
|---|
const char * | value | | | The path the texture will be read from. |
GetTextureName return value
Type: spString
Syntax
SetTextureName parameters
| Type | Name | Min | Max | Description |
|---|
string | value | | | The path the texture will be read from. |
GetTextureName return value
Type: string
Syntax
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
SetTextureWrapMode parameters
GetTextureWrapMode return value
Type: ETextureWrapMode
Default: Wrap
| Key | Value | Comment |
|---|
| Wrap | 0 | |
| Clamp | 1 | |
| Mirror | 2 | |
Syntax
SetTextureWrapMode parameters
GetTextureWrapMode return value
Type: ETextureWrapMode
Default: Wrap
| Key | Value | Comment |
|---|
| Wrap | 0 | |
| Clamp | 1 | |
| Mirror | 2 | |
Syntax
SetTextureWrapMode parameters
GetTextureWrapMode return value
Type: ETextureWrapMode
Default: Wrap
| Key | Value | Comment |
|---|
| ETextureWrapMode_Wrap | 0 | |
| ETextureWrapMode_Clamp | 1 | |
| ETextureWrapMode_Mirror | 2 | |
TextureWrapModeU
The texture wrap mode in U direction, which determines what happens to texture samples outside the 0-1 range.
Syntax
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 | |
| Clamp | 1 | |
| Mirror | 2 | |
Syntax
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 | |
| Clamp | 1 | |
| Mirror | 2 | |
Syntax
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 | |
| ETextureWrapMode_Clamp | 1 | |
| ETextureWrapMode_Mirror | 2 | |
TextureWrapModeV
The texture wrap mode in V direction, which determines what happens to texture samples outside the 0-1 range.
Syntax
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 | |
| Clamp | 1 | |
| Mirror | 2 | |
Syntax
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 | |
| Clamp | 1 | |
| Mirror | 2 | |
Syntax
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 | |
| ETextureWrapMode_Clamp | 1 | |
| ETextureWrapMode_Mirror | 2 | |
TileU
The TileU value, which is multiplied into the U-coordinate when sampling.
Syntax
SetTileU parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | The new value. |
GetTileU return value
Type: real
Syntax
SetTileU parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | The new value. |
GetTileU return value
Type: float
Syntax
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
SetTileV parameters
| Type | Name | Min | Max | Description |
|---|
real | value | | | The new value. |
GetTileV return value
Type: real
Syntax
SetTileV parameters
| Type | Name | Min | Max | Description |
|---|
float | value | | | The new value. |
GetTileV return value
Type: float
Syntax
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
SetUseSRGB parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The flag to use sRGB. |
GetUseSRGB return value
Type: bool
Syntax
SetUseSRGB parameters
| Type | Name | Min | Max | Description |
|---|
bool | value | | | The flag to use sRGB. |
GetUseSRGB return value
Type: bool
Syntax
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
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 ShadingTextureNode 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 ShadingTextureNode 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 ShadingTextureNode 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 ShadingTextureNode 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 ShadingTextureNode is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the ShadingTextureNode 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 ShadingTextureNode 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 ShadingTextureNode 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 ShadingTextureNode 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 spShadingTextureNode, and if this is the case, returns the object cast into spShadingTextureNode. (Inherited from Object)
