Class GraphNodeReflectionData

The GraphNodeReflectionData provides reflection information for a GraphNode.

Constructors

constructor

new GraphNodeReflectionData(classType, nodeAttribute, templateType?, templateObject?): GraphNodeReflectionData
Parameters
- classType: Type
- nodeAttribute: GraphNodeAttribute
- OptionaltemplateType: Type
- OptionaltemplateObject: TemplatedGraphNodeSpecializationObject
Returns GraphNodeReflectionData

Properties

`Readonly`classType

classType: Type

The reflected system type. This is the type of the node that is instanced.

`Readonly`compatability

compatability: GraphCompatibiltyName[]

Compatability that determine what Graph types support this node.

`Readonly`description

description: string

Helpful information about the node, displayed in the UI at various places.

`Readonly`flags

flags: EnumValueTyped<GraphNodeFlags, number>

The GraphNodeFlags.

`Readonly`iconAttribute

iconAttribute: IconAttribute

An optional IconAttribute that was set on the node class.

`Readonly`inputPins

inputPins: GraphPinReflectionData[]

Data for input pins, typically created through the GraphInputAttribute decorator.

`Readonly`inspectableFields

inspectableFields: GraphInspectableFieldReflectionData[]

Reflection data for fields marked with the InspectableFieldAttribute.

`Readonly`isHiddenInInspector

isHiddenInInspector: boolean

Determines if the result should not be displayed in inspectors and user searches.

`Readonly`name

name: string

The name of the node being reflected.

`Readonly`outputPins

outputPins: GraphPinReflectionData[]

Data for output pins, typically created through the GraphOutputAttribute decorator.

`Readonly`templateObject

templateObject: TemplatedGraphNodeSpecializationObject

Additional data for the template specialization, such as input or output parameters.

`Readonly`templateType

templateType: Type

If set, the node is templated to the specified Type

`Static` `Readonly`arithmeticNodeBooleanSynonyms

arithmeticNodeBooleanSynonyms: Const<Map<string, string>>

A map that maps arithmetic math nodes from readable nodes to symbolic names.

Note

Return type must be Boolean

`Static` `Readonly`arithmeticNodeScalarSynonyms

arithmeticNodeScalarSynonyms: Const<Map<string, string>>

A map that maps arithmetic math nodes from readable nodes to symbolic names.

Note

Second type must be Number.

`Static` `Readonly`arithmeticNodeSynonyms

arithmeticNodeSynonyms: Const<Map<string, string>>

A map that maps arithmetic math nodes from readable nodes to symbolic names.

`Static` `Readonly`fieldStoragePrefix

fieldStoragePrefix = "!"

The prefix for internal field storage. The field storage is used when a parameter is not connected on a templated node.

Accessors

friendlyCategory

get friendlyCategory(): string
The friendly name of the node. Use for display in the UI.

Returns string

friendlyName

get friendlyName(): string
The friendly name of the node. Use for display in the UI.

Returns string

hasConditionallyVisiblePins

get hasConditionallyVisiblePins(): boolean
Determines if the node has conditionally visible pins.

Returns boolean

inputPinCount

get inputPinCount(): number
Returns the number of input pins in the node.

Returns number

isMoveable

get isMoveable(): boolean
Determines if the node is movable by the user.

Returns boolean

isPersistent

get isPersistent(): boolean
Determines if the node is deletable by the user.

Returns boolean

outputPinCount

get outputPinCount(): number
Returns the number of output pins out the node.

Returns number

Methods

`Protected`addInputPin

addInputPin(inputPin): void
Adds the inputPin.
Parameters
- inputPin: GraphPinReflectionData
Returns void

`Protected`addOutputPin

addOutputPin(outputPin): void
Adds the outputPin.
Parameters
- outputPin: GraphPinReflectionData
Returns void

createInstance

createInstance(): GraphNode
Creates an instance of for the reflection type. If the node is templated, the instance will be specialized for the type.

Returns GraphNode

createPinInstanceForNode

createPinInstanceForNode(node, reflectionPin): GraphPin
Instances the reflectionPin as GraphPin for the specified node.
Parameters
- node: GraphNode
- reflectionPin: GraphPinReflectionData
Returns GraphPin

findPin

findPin(graphPin): GraphPinReflectionData
Finds a find reflection pin of the specified pinType by a graphPin instance.
Parameters
- graphPin: GraphPin
  The pin to lookup for.
Returns GraphPinReflectionData
The reflection pin or null if no such pin exists.

findPinByName

findPinByName(name, pinType): GraphPinReflectionData
Finds a find pin of the specified pinType by its name.
Parameters
- name: string
  The name of the pin to lookup for.
- pinType: EnumValueTyped<GraphPinType, number>
Returns GraphPinReflectionData
The pin named name or null if no such pin exists.

getInputOfType

getInputOfType(type): GraphPinReflectionData
Gets the first input GraphPin whose type matches the type or is a subclass of type.
Parameters
- type: GraphType
Returns GraphPinReflectionData

getOutputOfType

getOutputOfType(type): GraphPinReflectionData
Gets the first output GraphPin whose type matches the type or is a subclass of type.
Parameters
- type: GraphType
Returns GraphPinReflectionData

iterateAllPins

iterateAllPins(): Generator<GraphPinReflectionData, any, any>
Enumerate all pins connected by edges to this pin

Returns Generator<GraphPinReflectionData, any, any>

toString

toString(): string
Returns string

Class GraphNodeReflectionData

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GraphNodeReflectionData

Properties

category

ReadonlyclassType

Readonlycompatability

Readonlydescription

Readonlyflags

ReadonlyiconAttribute

ReadonlyinputPins

ReadonlyinspectableFields

ReadonlyisHiddenInInspector

Readonlyname

ReadonlyoutputPins

ReadonlytemplateObject

ReadonlytemplateType

Static ReadonlyarithmeticNodeBooleanSynonyms

Note

Static ReadonlyarithmeticNodeScalarSynonyms

Note

Static ReadonlyarithmeticNodeSynonyms

Static ReadonlyfieldStoragePrefix

Accessors

friendlyCategory

Returns string

friendlyName

Returns string

hasConditionallyVisiblePins

Returns boolean

inputPinCount

Returns number

isMoveable

Returns boolean

isPersistent

Returns boolean

outputPinCount

Returns number

Methods

ProtectedaddInputPin

Parameters

Returns void

ProtectedaddOutputPin

Parameters

Returns void

createInstance

Returns GraphNode

createPinInstanceForNode

Parameters

Returns GraphPin

findPin

Parameters

Returns GraphPinReflectionData

findPinByName

Parameters

Returns GraphPinReflectionData

getInputOfType

Parameters

Returns GraphPinReflectionData

getOutputOfType

Parameters

Returns GraphPinReflectionData

iterateAllPins

Returns Generator<GraphPinReflectionData, any, any>

toString

Returns string

Settings

On This Page

`Readonly`classType

`Readonly`compatability

`Readonly`description

`Readonly`flags

`Readonly`iconAttribute

`Readonly`inputPins

`Readonly`inspectableFields

`Readonly`isHiddenInInspector

`Readonly`name

`Readonly`outputPins

`Readonly`templateObject

`Readonly`templateType

`Static` `Readonly`arithmeticNodeBooleanSynonyms

`Static` `Readonly`arithmeticNodeScalarSynonyms

`Static` `Readonly`arithmeticNodeSynonyms

`Static` `Readonly`fieldStoragePrefix

`Protected`addInputPin

`Protected`addOutputPin