Simplygon 9 Documentation

# 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

Property Description
InputCount The number of inputs for this custom node.

# Methods

Method Description
GetClass Get the name of the ShadingCustomNode class.
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.
IsNull Returns true if the ShadingCustomNode object is invalid.
SetCustomShaderCode Set custom shader code from OnShadingCustomNodeGenerateShaderCode observer method.
SetDefaultParameter The default parameter values.
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.
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.

# Properties details

# InputCount

The number of inputs for this custom node.

    # Methods details

    # GetClass

    Get the name of the ShadingCustomNode class.

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

                          # IsNull

                          Returns true if the ShadingCustomNode object is invalid.

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

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

                                      ← ShadingDivideNode →