Class NodeGeometryConnectionPoint

constructor

• new NodeGeometryConnectionPoint(
      name: string,
      ownerBlock: NodeGeometryBlock,
      direction: NodeGeometryConnectionPointDirection,
  ): NodeGeometryConnectionPoint

  Creates a new connection point

  Parameters

  • name: string

    defines the connection point name

  • ownerBlock: NodeGeometryBlock

    defines the block hosting this connection point

  • direction: NodeGeometryConnectionPointDirection

    defines the direction of the connection point

  Returns NodeGeometryConnectionPoint

acceptedConnectionPointTypes

defaultValue

displayName

excludedConnectionPointTypes

exposedPortPosition

isExposedOnFrame

isOptional

name

onConnectionObservable

onDisconnectionObservable

value

valueMax

valueMin

callCount

• get callCount(): number

  Gets the number of times this point was called

  Returns number

connectedBlocks

• get connectedBlocks(): NodeGeometryBlock[]

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

  Returns NodeGeometryBlock[]

connectedPoint

• get connectedPoint(): Nullable<NodeGeometryConnectionPoint>

  Get the other side of the connection (if any)

  Returns Nullable<NodeGeometryConnectionPoint>

direction

• get direction(): NodeGeometryConnectionPointDirection

  Gets the direction of the point

  Returns NodeGeometryConnectionPointDirection

endpoints

• get endpoints(): NodeGeometryConnectionPoint[]

  Gets the list of connected endpoints

  Returns NodeGeometryConnectionPoint[]

executionCount

• get executionCount(): number

  Gets the number of times this point was executed

  Returns number

hasEndpoints

• get hasEndpoints(): boolean

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

  Returns boolean

innerType

• get innerType(): NodeGeometryBlockConnectionPointTypes

  Get the inner type (ie AutoDetect for instance instead of the inferred one)

  Returns NodeGeometryBlockConnectionPointTypes

isConnected

• get isConnected(): boolean

  Gets a boolean indicating that the current point is connected to another NodeMaterialBlock

  Returns boolean

ownerBlock

• get ownerBlock(): NodeGeometryBlock

  Get the block that owns this connection point

  Returns NodeGeometryBlock

sourceBlock

• get sourceBlock(): Nullable<NodeGeometryBlock>

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

  Returns Nullable<NodeGeometryBlock>

type

• get type(): NodeGeometryBlockConnectionPointTypes

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

  Returns NodeGeometryBlockConnectionPointTypes

• set type(value: NodeGeometryBlockConnectionPointTypes): void

  Parameters

  • value: NodeGeometryBlockConnectionPointTypes

  Returns void

addExcludedConnectionPointFromAllowedTypes

• addExcludedConnectionPointFromAllowedTypes(mask: number): void

  Fill the list of excluded connection point types with all types other than those passed in the parameter

  Parameters

  • mask: number

    Types (ORed values of NodeMaterialBlockConnectionPointTypes) that are allowed, and thus will not be pushed to the excluded list

  Returns void

canConnectTo

• canConnectTo(connectionPoint: NodeGeometryConnectionPoint): boolean

  Gets a boolean indicating if the current point can be connected to another point

  Parameters

  • connectionPoint: NodeGeometryConnectionPoint

    defines the other connection point

  Returns boolean

  a boolean

checkCompatibilityState

• checkCompatibilityState(
      connectionPoint: NodeGeometryConnectionPoint,
  ): NodeGeometryConnectionPointCompatibilityStates

  Gets a number indicating if the current point can be connected to another point

  Parameters

  • connectionPoint: NodeGeometryConnectionPoint

    defines the other connection point

  Returns NodeGeometryConnectionPointCompatibilityStates

  a number defining the compatibility state

connectTo

• connectTo(
      connectionPoint: NodeGeometryConnectionPoint,
      ignoreConstraints?: boolean,
  ): NodeGeometryConnectionPoint

  Connect this point to another connection point

  Parameters

  • connectionPoint: NodeGeometryConnectionPoint

    defines the other connection point

  • ignoreConstraints: boolean = false

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

  Returns NodeGeometryConnectionPoint

  the current connection point

disconnectFrom

• disconnectFrom(
      endpoint: NodeGeometryConnectionPoint,
  ): NodeGeometryConnectionPoint

  Disconnect this point from one of his endpoint

  Parameters

  • endpoint: NodeGeometryConnectionPoint

    defines the other connection point

  Returns NodeGeometryConnectionPoint

  the current connection point

dispose

• dispose(): void

  Release resources

  Returns void

getClassName

• getClassName(): string

  Gets the current class name e.g. "NodeMaterialConnectionPoint"

  Returns string

  the class name

getConnectedValue

• getConnectedValue(state: NodeGeometryBuildState): any

  Gets the value represented by this connection point

  Parameters

  • state: NodeGeometryBuildState

    current evaluation state

  Returns any

  the connected value or the value if nothing is connected

serialize

• serialize(isInput?: boolean): any

  Serializes this point in a JSON representation

  Parameters

  • isInput: boolean = true

    defines if the connection point is an input (default is true)

  Returns any

  the serialized point object