`class` ShadingFilterNode

FilterNode is the parent of all non-source nodes in a shading network.

Properties

Property	Description
Name	The name of the ShadingFilterNode 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 ShadingFilterNode 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)
GetInput	The default node inputs.
GetParameterCount	The input count. (Inherited from ShadingNode)
GetParameterIsInputable	Get if the parameter is inputable. If true, a different node can be set as this parameters value. If false, the parameter can only be set manually and not through a node input.
GetParameterName	The name of a parameter. (Inherited from ShadingNode)
IsA	Returns true if ShadingFilterNode is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the ShadingFilterNode object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the ShadingFilterNode object is valid. (Inherited from Object)
NonNull	Returns true if the ShadingFilterNode object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the ShadingFilterNode 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)
SetInput	The default node inputs.

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

Properties details

Name

The name of the ShadingFilterNode 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 ShadingFilterNode 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.

GetInput

The default node inputs.

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

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

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

GetParameterCount

The input count.

GetParameterIsInputable

Get if the parameter is inputable. If true, a different node can be set as this parameters value. If false, the parameter can only be set manually and not through a node input.

Type	Name	Min	Max	Description
`rid`	paramId			The id of the parameter to be checked.

Type	Name	Min	Max	Description
`int`	paramId			The id of the parameter to be checked.

Name	Type	Min	Max	Description
paramId	`int`			The id of the parameter to be checked.

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 ShadingFilterNode 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 ShadingFilterNode is, or is a descendant of.

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

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

IsNull

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

IsSameObjectAs

Returns true if the ShadingFilterNode 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 ShadingFilterNode object is valid. (Inherited from Object)

PrintInfo

Prints the content/info of the ShadingFilterNode 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.

SetInput

The default node inputs.

Type	Name	Min	Max	Description
`rid`	inputId			The id of the input to be set.
`ShadingNode`	inputNode			The node to be set as input.

Type	Name	Min	Max	Description
`int`	inputId			The id of the input to be set.
`ShadingNode`	inputNode			The node to be set as input.

Name	Type	Min	Max	Description
inputId	`int`			The id of the input to be set.
inputNode	`ShadingNode`			The node to be set as input.

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.

Name	Type	Min	Max	Description
type	`str`			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 spShadingFilterNode, and if this is the case, returns the object cast into spShadingFilterNode. (Inherited from Object)

Material casters

Array

ObjectCollection

Table

GraphicsExporter

GraphicsImporter

ShaderParameter

Pipeline

ProcessingObject

SettingsObject

SceneNode

ShadingNode

class ShadingFilterNode ​

Properties ​

Methods ​

Static methods ​

Properties details ​

Name ​

Methods details ​

AddObserver ​

GetClass ​

GetDefaultParameterAlpha ​

GetDefaultParameterBlue ​

GetDefaultParameterGreen ​

GetDefaultParameterRed ​

GetInput ​

GetParameterCount ​

GetParameterIsInputable ​

`class` ShadingFilterNode

Properties

Methods

Static methods

Properties details

Name

Methods details

AddObserver

GetClass

GetDefaultParameterAlpha

GetDefaultParameterBlue

GetDefaultParameterGreen

GetDefaultParameterRed

GetInput

GetParameterCount

GetParameterIsInputable