Class GraphNode

constructor

• new GraphNode(): GraphNode

  Returns GraphNode

customName

• get customName(): string

  The custom name for the node.

  Returns string

  Note

  By default, names should be inferred from the GraphNodeReflection data. Only set this field if the name cannot or should not be inferred from reflection data.

• set customName(value: string): void

  Parameters

  • value: string

  Returns void

graph

• get graph(): ImmutableGraph

  The owning graph.

  Returns ImmutableGraph

• set graph(value: ImmutableGraph): void

  Parameters

  • value: ImmutableGraph

  Returns void

id

• get id(): UUID

  The ID.

  Returns UUID

inputPins

• get inputPins(): GraphPin[]

  The input pins.

  Returns GraphPin[]

outputPins

• get outputPins(): GraphPin[]

  The output pins.

  Returns GraphPin[]

position

• get position(): Immutable<Vector2>

  The position.

  Returns Immutable<Vector2>

• set position(value: Immutable<Vector2>): void

  Parameters

  • value: Immutable<Vector2>

  Returns void

userData

• get userData(): Map<string, any>

  A map suitable for storing custom user-defined data.

  Returns Map<string, any>

addPin

• addPin(pin: GraphPin): void

  Add a GraphPin.

  Parameters

  • pin: GraphPin

  Returns void

clone

• clone(): GraphNode

  Clones the GraphNode and it's GraphPin. All connections will be removed from the clone.

  Returns GraphNode

disconnect

• disconnect(): void

  Removes all connections to this node.

  Returns void

enable

• enable(graph: ImmutableGraph): void

  Enables the node and its pins in the specified graph.

  Parameters

  • graph: ImmutableGraph

  Returns void

getCompatiblePin

• getCompatiblePin(otherPin: GraphPin): GraphPin

  Gets a pin that supports a connection to (or from) the otherPin.

  Parameters

  • otherPin: GraphPin

    The pin to find a compatible pin for.

  Returns GraphPin

  The first pin that matches the connection criteria.

  Note

  The orientation of the test depends on the type of the otherPin. The input pin denotes the type that must be supported by the output pin in the form

  	`outputPin isSubclassOf inputPin`
  

getConnectedValue

• getConnectedValue<T>(
      type: GraphType | ClassOf<T>,
      pinOrPinName: string | GraphPin,
      executionState: GraphExecutionState,
      defaultValue?: ValueTypeOf<T>,
  ): ValueTypeOf<T>

  Gets the value that is connected to the input pin. If the pin is not connected, the defaultValue is returned.

  Type Parameters

  • T

  Parameters

  • type: GraphType | ClassOf<T>

    The pin type

  • pinOrPinName: string | GraphPin

    The GraphPin or the name of the pin.

  • executionState: GraphExecutionState
  • OptionaldefaultValue: ValueTypeOf<T>

    An optional default value. Default: undefined

  Returns ValueTypeOf<T>

  The connected value, or if not connected the defaultValue.

getIndexofPin

• getIndexofPin(
      nameOrPin: string | GraphPin,
      direction: EnumValueTyped<GraphPinType>,
  ): number

  Get either an input or output pin.

  Parameters

  • nameOrPin: string | GraphPin
  • direction: EnumValueTyped<GraphPinType>

  Returns number

getInternalFieldStorageValueForPin

• getInternalFieldStorageValueForPin(pin: GraphPin): any

  The internal field value used as automatic value storage for templated nodes.

  Parameters

  • pin: GraphPin

  Returns any

getPin

• getPin(
      nameOrUUID: string | UUID,
      direction: EnumValueTyped<GraphPinType>,
  ): GraphPin

  Gets the specified pin by name or id.

  Parameters

  • nameOrUUID: string | UUID
  • direction: EnumValueTyped<GraphPinType>

  Returns GraphPin

getPins

• getPins(type: EnumValueTyped<GraphPinType>): GraphPin[]

  Returns all pins connected of the specified type.

  Parameters

  • type: EnumValueTyped<GraphPinType>

  Returns GraphPin[]

getUserData

• getUserData<T>(node: GraphNode, key: string, defaultValue?: T): T

  Gets the value for the specified user data key. If the key does not exist the defaultValue will be returned instead. If no defaultValue is specified, undefined is returned.

  Type Parameters

  • T

  Parameters

  • node: GraphNode
  • key: string

    A key that uniquely identifies the property to be fetched.

  • OptionaldefaultValue: T

    The default value, to be returned in case the property is not defined.

  Returns T

  The user defined property or defaultValue if not defined.

isConnectedToNode

• isConnectedToNode(
      otherNode: GraphNode,
      direction: EnumValueTyped<GraphPinType>,
  ): boolean

  Determines if this node is connected to the other node.

  Parameters

  • otherNode: GraphNode
  • direction: EnumValueTyped<GraphPinType>

  Returns boolean

isValidTypeForPin

• isValidTypeForPin(pin: GraphPin, type: GraphType): boolean
  Virtual

  Determines if the specified pin is valid for the given type.

  Parameters

  • pin: GraphPin
  • type: GraphType

  Returns boolean

iterateAllPins

• iterateAllPins(): Generator<GraphPin>

  Iterates all connections to pins of this node. First input pins are iterated over, then output pins.

  Returns Generator<GraphPin>

makeCanvasName

• makeCanvasName(reflectionData: GraphNodeReflectionData): string
  Virtual

  Gets the name of the node as it should be displayed in the canvas.

  Parameters

  • reflectionData: GraphNodeReflectionData

  Returns string

markAsDirty

• markAsDirty(flags: EnumValue<GraphNodeDirtyFlags>): void

  Marks the node contents as changed and signals events.

  Parameters

  • flags: EnumValue<GraphNodeDirtyFlags>

  Returns void

onClone

• onClone(): void
  Virtual

  Invoked when the node was cloned, invoked after invoking GraphPin#onClone.

  Returns void

onCreate

• onCreate(): void

  Called when the node has been instanced and is about to be added to a graph. This is a good place to initialize the default values for the node pins as it will then not be done during deserialization, which might otherwise discard newly instances values immediately.

  Returns void

onEnable

• onEnable(): void
  Virtual

  Called when the Graph is being enabled or when the node is added to the graph via Graph#addNode />

  Returns void

onFieldValueChanged

• onFieldValueChanged(
      currentReflectionData: GraphNodeReflectionData,
      editableData: GraphInspectableFieldReflectionData,
  ): void
  Virtual

  Invoked when an inspectable field data was changed through the UI.

  Parameters

  • currentReflectionData: GraphNodeReflectionData
  • editableData: GraphInspectableFieldReflectionData

  Returns void

  Note

  Implementing classes must call super.

onPinConnected

• onPinConnected(pin: GraphPin, connection: GraphConnection): void
  Virtual

  Invoked when a GraphPin was connected.

  Parameters

  • pin: GraphPin
  • connection: GraphConnection

  Returns void

onPinDisconnected

• onPinDisconnected(pin: GraphPin, connection: GraphConnection): void
  Virtual

  Invoked when a GraphPin was disconnected.

  Parameters

  • pin: GraphPin
  • connection: GraphConnection

  Returns void

onPinValueChanged

• onPinValueChanged(
      pin: GraphPin,
      nodeReflectionData: GraphNodeReflectionData,
      pinReflectionPin: GraphPinReflectionData,
  ): void
  Virtual

  Invoked when the pin field data was changed through the UI.

  Parameters

  • pin: GraphPin
  • nodeReflectionData: GraphNodeReflectionData
  • pinReflectionPin: GraphPinReflectionData

  Returns void

  Note

  Implementing classes must call super.

onRemove

• onRemove(): void

  Called before the node is removed from a graph.

  Returns void

onRequestValue

• onRequestValue(pin: GraphPin, executionState: GraphExecutionState): any
  Virtual

  Requests the value associated with the given pin.

  Parameters

  • pin: GraphPin

    The GraphPin for whom the data is requested.

  • executionState: GraphExecutionState

    THhe GraphExecutionState state containing the execution data.

  Returns any

  The pin data.

onSerialize

• onSerialize(): void

  Invoked when serialization begins by the owning Graph.

  Returns void

registerOutdatedConnection

• registerOutdatedConnection(pin: GraphPin, connection: GraphConnection): void

  Registers an outdated GraphConnection if it wasn't enabled during initialization. Outdated connections are attempted to be re-enabled during the call to enable

  Parameters

  • pin: GraphPin
  • connection: GraphConnection

  Returns void

removePin

• removePin(pin: GraphPin): void

  Removes a GraphPin.

  Parameters

  • pin: GraphPin

  Returns void

removeUserData

• removeUserData(key: string): void

  Removes the user data key.

  Parameters

  • key: string

  Returns void

setUserData

• setUserData<T>(key: string, value: T): void

  Sets the user data key to the specified value.

  Type Parameters

  • T

  Parameters

  • key: string

    A key that uniquely identifies the property to be defined.

  • value: T

    The value to set the property to. The value type must support serialization.

  Returns void

synchronizePinsWithReflectionData

• synchronizePinsWithReflectionData(): void

  Synchronizes the node pins with the reflection data by adding missing pins and removing superfluous pins on the node.

  Returns void

toString

• toString(): string

  Returns a string representation of an object.

  Returns string

validate

• validate(validationStatus: Map<GraphObject, string>): GraphValidationStatus
  Virtual

  Ensures that the state of the node is valid.

  Parameters

  • validationStatus: Map<GraphObject, string>

  Returns GraphValidationStatus

  Note

  Implementing classes must call super. The method is typically called after deserialization or major edits to the graph. If validation fails, error information must be added to the validationStatus map.

withBlockedEvents

• withBlockedEvents(callback: () => void): void

  Invokes the callback while prevent events to be dispatched.

  Parameters

  • callback: () => void

  Returns void

ReadonlyonDirty