RSX Code Reference
    Preparing search index...

    Class GraphPin

    The GraphPin class represents a pin on a GraphNode. A pin can hold one or more connections that connect the pin (and its node) to another pin and node.

    Pins are considered to be instanced from a class object and are serialized with minimal data. The data is reconstructed when the pin is enabled via GraphNode#synchronizePinsWithReflectionData

    Hierarchy (View Summary)

    Index
    constructor
    _connections _id _name connectionType node pinType type
    connectionCount connections id isConnected isControlFlow isDefaultControlFlowInput isDefaultControlFlowOutput isInput isOutput name userData
    clone disconnect enable findConnection getConnectedValueOrDefault isConnectable markAsDirty onClone toString validate
    onDirty

    Readonly_connections

    _connections: GraphConnection[]

    Connections to and from the pin.

    Protected Readonly_id

    _id: UUID

    The unique ID.

    Protected_name

    _name: string

    The name of the pin.

    The primary identified to synchronize the to the reflection data.

    connectionType: EnumValueTyped<GraphPinConnectionType>

    The connection type.

    Only available when fully enabled.

    node: ImmutableGraphNode

    The owning node.

    Only available when fully enabled.

    pinType: EnumValueTyped<GraphPinType, number>

    The pin type.

    Only available when fully enabled.

    type: GraphType

    The type of the pin.

    Only available when fully enabled.

    • get connectionCount(): number

      The number of connections.

      Returns number

    • get id(): UUID

      The unique ID of the pin.

      Returns UUID

    • get isConnected(): boolean

      Determines if the pin is connected.

      Returns boolean

    • get isControlFlow(): boolean

      Determines if the pin is a control-flow pin.

      Returns boolean

    • get isDefaultControlFlowInput(): boolean

      Determines if the pin is an input "Control-flow pin".

      Returns boolean

    • get isDefaultControlFlowOutput(): boolean

      Determines if the pin is an output "Control-flow pin".

      Returns boolean

    • get isInput(): boolean

      Determines if this is an input pin.

      Returns boolean

    • get isOutput(): boolean

      Determines if this is an output pin.

      Returns boolean

    • get name(): string

      The pin name.

      Returns string

    • set name(value: string): void

      Parameters

      • value: string

      Returns void

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

      A map suitable for storing custom user-defined data.

      Returns Map<string, any>

    • Removes all connections.

      Returns void

    • Retrieves the value of this pin.

      Type Parameters

      • T

      Parameters

      Returns ValueTypeOf<T>

      Input pins will forward the request to the connected pin, if connected. Output pins will request the value from the respective node.

      If the input pin is not connected, the defaultValue will be used. If a default value is not specified, the internal field storage will be used.

      Output pins must return a valid, undefined value, otherwise a warning message is logged.

    • Determines if this pin is connectable to the otherPin

      Parameters

      • otherPin: GraphPin
      • validatePortCapacity: boolean

      Returns boolean

    • Internal callback method called after cloning the owning Node.

      Returns void

    • Returns a string representation of an object.

      Returns string

    • Virtual

      Ensures that the state of the pin is valid.

      Parameters

      Returns GraphValidationStatus

      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.

    onDirty: Event<[EnumValue<GraphNodeDirtyFlags, number>]>

    An event called whenever the GraphPin is dirtied.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods
    Events