Skip to content
On this page

class ShadingCustomNode

CustomNode describes a custom shading node in a shading network. The output is produced based on customizable user specified operations. The custom node has a user specified amount of input parameters. Use SetInputCount() to specify the number of inputs. The user has to assign and implement event handlers (called observers) for the custom node to be able to evaluate to colors. See CustomNodeExample and API documentation for further explanations and code samples.

Properties

PropertyDescription
InputCountThe number of inputs for this custom node.
NameThe name of the ShadingCustomNode object. (Inherited from Object)

Methods

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetClassGet the name of the ShadingCustomNode class. (Inherited from Object)
GetDefaultParameterAlphaThe default parameter values. (Inherited from ShadingNode)
GetDefaultParameterBlueThe default parameter values. (Inherited from ShadingNode)
GetDefaultParameterGreenThe default parameter values. (Inherited from ShadingNode)
GetDefaultParameterRedThe default parameter values. (Inherited from ShadingNode)
GetInputThe default node inputs. (Inherited from ShadingFilterNode)
GetInputValueGet color value from node input index.
GetParameterCountThe input count. (Inherited from ShadingNode)
GetParameterIsInputableGet 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. (Inherited from ShadingFilterNode)
GetParameterNameThe name of a parameter. (Inherited from ShadingNode)
IsAReturns true if ShadingCustomNode is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the ShadingCustomNode object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the ShadingCustomNode object is valid. (Inherited from Object)
NonNullReturns true if the ShadingCustomNode object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the ShadingCustomNode object to the log. (Inherited from Object)
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
SetCustomShaderCodeSet custom shader code from OnShadingCustomNodeGenerateShaderCode observer method.
SetDefaultParameterThe default parameter values. (Inherited from ShadingNode)
SetInputThe default node inputs. (Inherited from ShadingFilterNode)

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast makes sure the input object is of a class that can be cast into spShadingCustomNode, and if this is the case, returns the object cast into spShadingCustomNode. (Inherited from Object)

Properties details

InputCount

The number of inputs for this custom node.

Name

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

Methods details

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

GetDefaultParameterAlpha

The default parameter values.

GetDefaultParameterBlue

The default parameter values.

GetDefaultParameterGreen

The default parameter values.

GetDefaultParameterRed

The default parameter values.

GetInput

The default node inputs.

GetInputValue

Get color value from node input index.

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.

GetParameterName

The name of a parameter.

IsA

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

IsNull

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

IsSameObjectAs

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

NonNull

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

PrintInfo

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

RemoveObserver

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

SetCustomShaderCode

Set custom shader code from OnShadingCustomNodeGenerateShaderCode observer method.

SetDefaultParameter

The default parameter values.

SetInput

The default node inputs.

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)

SafeCast

SafeCast makes sure the input object is of a class that can be cast into spShadingCustomNode, and if this is the case, returns the object cast into spShadingCustomNode. (Inherited from Object)