Class CarbonStateConnection

The CarbonStateConnection represents an oriented connection between two CarbonStateNodeBase instances. The class extends the GraphConnection by an additional pin that determines wheter the input state can be entered.

Hierarchy (View Summary)

GraphConnection
- CarbonStateConnection

Index

Constructors

constructor

new CarbonStateConnection(): CarbonStateConnection

Returns CarbonStateConnection

Overrides GraphConnection.constructor

Properties

`Protected`_gate

_gate: CarbonStateGateNode

`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

gate

get gate(): CarbonStateGateNode

The CarbonStateGateNode, only valid the connection was enabled.

Returns CarbonStateGateNode
set gate(value: CarbonStateGateNode): void
Parameters
- value: CarbonStateGateNode
Returns void

gateNodeID

get gateNodeID(): UUID

The UUID of gate that is part of the connection.

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

id

get id(): UUID

The UUID of the object.

Returns UUID

Inherited from GraphConnection.id

inputNodeID

get inputNodeID(): UUID

The unique UUID of the input node.

Returns UUID

Inherited from GraphConnection.inputNodeID
set inputNodeID(value: UUID): void
Parameters
- value: UUID
Returns void

Inherited from GraphConnection.inputNodeID

inputPin

get inputPin(): GraphPin

The input GraphPin the connection is connected to.

Returns GraphPin

Inherited from GraphConnection.inputPin
set inputPin(value: GraphPin): void
Parameters
- value: GraphPin
Returns void

Inherited from GraphConnection.inputPin

inputPinID

get inputPinID(): UUID

The unique UUID of the input pin.

Returns UUID

Inherited from GraphConnection.inputPinID
set inputPinID(value: UUID): void
Parameters
- value: UUID
Returns void

Inherited from GraphConnection.inputPinID

isEnabled

get isEnabled(): boolean

Virtual
Determines if the connection is currently valid.

Returns boolean

Overrides GraphConnection.isEnabled

outputNodeID

get outputNodeID(): UUID

The unique UUID of the output node.

Returns UUID

Inherited from GraphConnection.outputNodeID
set outputNodeID(value: UUID): void
Parameters
- value: UUID
Returns void

Inherited from GraphConnection.outputNodeID

outputPin

get outputPin(): GraphPin

The output GraphPin the connection is connected to.

Returns GraphPin

Inherited from GraphConnection.outputPin
set outputPin(value: GraphPin): void
Parameters
- value: GraphPin
Returns void

Inherited from GraphConnection.outputPin

outputPinID

get outputPinID(): UUID

The unique UUID of the output pin.

Returns UUID

Inherited from GraphConnection.outputPinID
set outputPinID(value: UUID): void
Parameters
- value: UUID
Returns void

Inherited from GraphConnection.outputPinID

Methods

clone

clone(): GraphConnection

Clones the pin.

Returns GraphConnection

Inherited from GraphConnection.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.

Inherited from GraphConnection.getConnectedNodeID

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

Inherited from GraphConnection.getConnectedPin

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.

Inherited from GraphConnection.getConnectedPinID

onEnable

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

Note
Implementing classes must call super.

Overrides GraphConnection.onEnable

toString

toString(): string

Returns a string representation of an object.

Returns string

Inherited from GraphConnection.toString

`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.

Inherited from GraphConnection.withPins

`Static`withPinsAndGate

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

Class CarbonStateConnection

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CarbonStateConnection

Properties

Protected_gate

Protected_inputNodeID

Protected_inputPin

Protected_inputPinID

Protected_outputNodeID

Protected_outputPin

Protected_outputPinID

Accessors

gate

Returns CarbonStateGateNode

Parameters

Returns void

gateNodeID

Returns UUID

Parameters

Returns void

id

Returns UUID

inputNodeID

Returns UUID

Parameters

Returns void

inputPin

Returns GraphPin

Parameters

Returns void

inputPinID

Returns UUID

Parameters

Returns void

isEnabled

Returns boolean

outputNodeID

Returns UUID

Parameters

Returns void

outputPin

Returns GraphPin

Parameters

Returns void

outputPinID

Returns UUID

Parameters

Returns void

Methods

clone

Returns GraphConnection

getConnectedNodeID

Parameters

Returns UUID

Note

getConnectedPin

Parameters

Returns GraphPin

getConnectedPinID

Parameters

Returns UUID

Note

onEnable

Parameters

Returns void

Note

toString

Returns string

StaticwithPins

Parameters

Returns GraphConnection

StaticwithPinsAndGate

Parameters

`Protected`_gate

`Protected`_inputNodeID

`Protected`_inputPin

`Protected`_inputPinID

`Protected`_outputNodeID

`Protected`_outputPin

`Protected`_outputPinID

`Static`withPins

`Static`withPinsAndGate