VisualShaderNodeGroupBase
Base class for a family of nodes with variable number of input and output ports within the visual shader graph.
Base class for a family of nodes with variable number of input and output ports within the visual shader graph.
Currently, has no direct usage, use the derived classes instead.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Methods21
AddInputPortvoid
public void AddInputPort(int id, int type, string name);Adds an input port with the specified type (see VisualShaderNode.PortType) and name.
| Name | Type | Default |
|---|---|---|
id | int | — |
type | int | — |
name | string | — |
AddOutputPortvoid
public void AddOutputPort(int id, int type, string name);Adds an output port with the specified type (see VisualShaderNode.PortType) and name.
| Name | Type | Default |
|---|---|---|
id | int | — |
type | int | — |
name | string | — |
ClearInputPortsvoid
public void ClearInputPorts();Removes all previously specified input ports.
ClearOutputPortsvoid
public void ClearOutputPorts();Removes all previously specified output ports.
GetFreeInputPortIdint
public int GetFreeInputPortId();Returns a free input port ID which can be used in VisualShaderNodeGroupBase.AddInputPort.
intGetFreeOutputPortIdint
public int GetFreeOutputPortId();Returns a free output port ID which can be used in VisualShaderNodeGroupBase.AddOutputPort.
intGetInputPortCountint
public int GetInputPortCount();Returns the number of input ports in use. Alternative for VisualShaderNodeGroupBase.GetFreeInputPortId.
intGetInputsstring
public string GetInputs();Returns a string description of the input ports as a colon-separated list using the format id,type,name; (see VisualShaderNodeGroupBase.AddInputPort).
stringGetOutputPortCountint
public int GetOutputPortCount();Returns the number of output ports in use. Alternative for VisualShaderNodeGroupBase.GetFreeOutputPortId.
intGetOutputsstring
public string GetOutputs();Returns a string description of the output ports as a colon-separated list using the format id,type,name; (see VisualShaderNodeGroupBase.AddOutputPort).
stringHasInputPortbool
public bool HasInputPort(int id);Returns true if the specified input port exists.
| Name | Type | Default |
|---|---|---|
id | int | — |
boolHasOutputPortbool
public bool HasOutputPort(int id);Returns true if the specified output port exists.
| Name | Type | Default |
|---|---|---|
id | int | — |
boolIsValidPortNamebool
public bool IsValidPortName(string name);Returns true if the specified port name does not override an existed port name and is valid within the shader.
| Name | Type | Default |
|---|---|---|
name | string | — |
boolRemoveInputPortvoid
public void RemoveInputPort(int id);Removes the specified input port.
| Name | Type | Default |
|---|---|---|
id | int | — |
RemoveOutputPortvoid
public void RemoveOutputPort(int id);Removes the specified output port.
| Name | Type | Default |
|---|---|---|
id | int | — |
SetInputPortNamevoid
public void SetInputPortName(int id, string name);Renames the specified input port.
| Name | Type | Default |
|---|---|---|
id | int | — |
name | string | — |
SetInputPortTypevoid
public void SetInputPortType(int id, int type);Sets the specified input port's type (see VisualShaderNode.PortType).
| Name | Type | Default |
|---|---|---|
id | int | — |
type | int | — |
SetInputsvoid
public void SetInputs(string inputs);Defines all input ports using a string formatted as a colon-separated list: id,type,name; (see VisualShaderNodeGroupBase.AddInputPort).
| Name | Type | Default |
|---|---|---|
inputs | string | — |
SetOutputPortNamevoid
public void SetOutputPortName(int id, string name);Renames the specified output port.
| Name | Type | Default |
|---|---|---|
id | int | — |
name | string | — |
SetOutputPortTypevoid
public void SetOutputPortType(int id, int type);Sets the specified output port's type (see VisualShaderNode.PortType).
| Name | Type | Default |
|---|---|---|
id | int | — |
type | int | — |
SetOutputsvoid
public void SetOutputs(string outputs);Defines all output ports using a string formatted as a colon-separated list: id,type,name; (see VisualShaderNodeGroupBase.AddOutputPort).
| Name | Type | Default |
|---|---|---|
outputs | string | — |