Class GraphConnection

The GraphConnection represents an oriented connection between two GraphPin instances.

Hierarchy (View Summary)

GraphObject
- GraphConnection
  - CarbonStateConnection

Index

Constructors

Properties

_inputNodeID _inputPin _inputPinID _outputNodeID _outputPin _outputPinID

Accessors

id inputNodeID inputPin inputPinID isEnabled outputNodeID outputPin outputPinID

Methods

clone getConnectedNodeID getConnectedPin getConnectedPinID onEnable toString withPins

Constructors

constructor

new GraphConnection(): GraphConnection

Returns GraphConnection

Overrides GraphObject.constructor

Properties

`Protected`_inputNodeID

_inputNodeID: UUID

`Protected`_inputPin

_inputPin: GraphPin

`Protected`_inputPinID

_inputPinID: UUID

`Protected`_outputNodeID

_outputNodeID: UUID

`Protected`_outputPin

_outputPin: GraphPin

`Protected`_outputPinID

_outputPinID: UUID

Accessors

id

get id(): UUID

The UUID of the object.

Returns UUID

Overrides GraphObject.id

inputNodeID

get inputNodeID(): UUID

The unique UUID of the input node.

Returns UUID
set inputNodeID(value: UUID): void
Parameters
- value: UUID
Returns void

inputPin

get inputPin(): GraphPin

The input GraphPin the connection is connected to.

Returns GraphPin
set inputPin(value: GraphPin): void
Parameters
- value: GraphPin
Returns void

inputPinID

get inputPinID(): UUID

The unique UUID of the input pin.

Returns UUID
set inputPinID(value: UUID): void
Parameters
- value: UUID
Returns void

isEnabled

get isEnabled(): boolean

Virtual
Determines if the connection is currently valid.

Returns boolean

outputNodeID

get outputNodeID(): UUID

The unique UUID of the output node.

Returns UUID
set outputNodeID(value: UUID): void
Parameters
- value: UUID
Returns void

outputPin

get outputPin(): GraphPin

The output GraphPin the connection is connected to.

Returns GraphPin
set outputPin(value: GraphPin): void
Parameters
- value: GraphPin
Returns void

outputPinID

get outputPinID(): UUID

The unique UUID of the output pin.

Returns UUID
set outputPinID(value: UUID): void
Parameters
- value: UUID
Returns void

Methods

clone

clone(): GraphConnection

Clones the pin.

Returns GraphConnection

Overrides GraphObject.clone

getConnectedNodeID

getConnectedNodeID(pin: GraphPin): UUID
Gets the connected node UUID for the specified pin.

If pin is the inputPin the outputNodeID will be returned and vice-versa.
Parameters
- pin: GraphPin
Returns UUID

Note
This method is usable when the connection is not fully formed as it relies on IDs, not objects.

getConnectedPin

getConnectedPin(pin: GraphPin): GraphPin
Gets the connected pin for the specified pin.

If pin is the inputPin the outputPin will be returned and vice-versa.
Parameters
- pin: GraphPin
Returns GraphPin

getConnectedPinID

getConnectedPinID(pin: GraphPin): UUID
Gets the connected pin UUID for the specified pin.

If pin is the inputPin the outputPin will be returned and vice-versa.
Parameters
- pin: GraphPin
Returns UUID

Note
This method is safer than getConnectedPin as it can be used if the connection is not fully loaded yet.

onEnable

onEnable(pin: GraphPin): void
Virtual
Enables the connection for the pin.
Parameters
- pin: GraphPin
Returns void

Note
Implementing classes must call super.

toString

toString(): string

Returns a string representation of an object.

Returns string

`Static`withPins

withPins(output: GraphPin, input: GraphPin): GraphConnection
Creates a new GraphConnection for the specified pins.
Parameters
- output: GraphPin
  The output pin.
- input: GraphPin
  The input pin.
Returns GraphConnection
The connection.