NodeMaterialConnectionPoint

Defines a connection point for a block

Hierarchy

  • NodeMaterialConnectionPoint

Index

Constructors

constructor

Find examples in Playground

Properties

acceptedConnectionPointTypes

Find examples in Playground
acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[]

Gets or sets the additional types supported by this connection point

associatedVariableName

Find examples in Playground
associatedVariableName: string

Gets or sets the associated variable name in the shader

connectInputBlock

Find examples in Playground
connectInputBlock: Nullable<InputBlock>

Gets a the connected input block (if any)

connectedBlocks

Find examples in Playground
connectedBlocks: Array<NodeMaterialBlock>

Get the block connected on the endpoints of this connection (if any)

connectedPoint

Find examples in Playground

Get the other side of the connection (if any)

define

Find examples in Playground
define: string

Gets or sets a string indicating that this uniform must be defined under a #ifdef

endpoints

Find examples in Playground

Gets the list of connected endpoints

excludedConnectionPointTypes

Find examples in Playground
excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[]

Gets or sets the additional types excluded by this connection point

hasEndpoints

Find examples in Playground
hasEndpoints: boolean

Gets a boolean indicating if that output point is connected to at least one input

isConnected

Find examples in Playground
isConnected: boolean

Gets a boolean indicating that the current point is connected

isConnectedToInputBlock

Find examples in Playground
isConnectedToInputBlock: boolean

Gets a boolean indicating that the current point is connected to an input block

isOptional

Find examples in Playground
isOptional: boolean

Gets or sets a boolean indicating that this connection point can be omitted

name

Find examples in Playground
name: string

Gets or sets the connection point name

ownerBlock

Find examples in Playground
ownerBlock: NodeMaterialBlock

Get the block that owns this connection point

sourceBlock

Find examples in Playground

Get the block connected on the other side of this connection (if any)

target

Find examples in Playground

Gets or sets the target of that connection point

type

Find examples in Playground

Gets or sets the connection point type (default is float)

Methods

canConnectTo

Find examples in Playground
  • Gets an boolean indicating if the current point can be connected to another point

    Parameters

    Returns boolean

    true if the connection is possible

connectTo

Find examples in Playground
  • Connect this point to another connection point

    Parameters

    • connectionPoint: NodeMaterialConnectionPoint

      defines the other connection point

    • Optional ignoreConstraints: boolean

      defines if the system will ignore connection type constraints (default is false)

    Returns NodeMaterialConnectionPoint

    the current connection point

disconnectFrom

Find examples in Playground

getClassName

Find examples in Playground
  • getClassName(): string
  • Gets the current class name e.g. "NodeMaterialConnectionPoint"

    Returns string

    the class name

serialize

Find examples in Playground
  • serialize(): any
  • Serializes this point in a JSON representation

    Returns any

    the serialized point object

Generated using TypeDoc