Class NodeGeometryConnectionPoint

Defines a connection point for a block

Hierarchy

NodeGeometryConnectionPoint

Constructors

constructor

new NodeGeometryConnectionPoint(name: string, ownerBlock: NodeGeometryBlock, direction: NodeGeometryConnectionPointDirection): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75865
Creates a new connection point

Parameters
- name: string
  
  defines the connection point name
- ownerBlock: NodeGeometryBlock
  
  defines the block hosting this connection point
- direction: NodeGeometryConnectionPointDirection
  
  defines the direction of the connection point
Returns NodeGeometryConnectionPoint

Properties

acceptedConnectionPointTypes Search playground for acceptedConnectionPointTypes

acceptedConnectionPointTypes: NodeGeometryBlockConnectionPointTypes[]

Gets or sets the additional types supported by this connection point

defaultValue Search playground for defaultValue

defaultValue: any

Gets the default value used for this point at creation time

displayName Search playground for displayName

displayName: string

Gets or sets the connection point display name

excludedConnectionPointTypes Search playground for excludedConnectionPointTypes

excludedConnectionPointTypes: NodeGeometryBlockConnectionPointTypes[]

Gets or sets the additional types excluded by this connection point

exposedPortPosition Search playground for exposedPortPosition

exposedPortPosition: number

Gets or sets number indicating the position that the port is exposed to on a frame

isExposedOnFrame Search playground for isExposedOnFrame

isExposedOnFrame: boolean

Gets or sets a boolean indicating that this connection point is exposed on a frame

isOptional Search playground for isOptional

isOptional: boolean

Gets or sets a boolean indicating that this connection point can be omitted

name Search playground for name

name: string

Gets or sets the connection point name

onConnectionObservable Search playground for onConnectionObservable

onConnectionObservable: Observable<NodeGeometryConnectionPoint>

Observable triggered when this point is connected

value Search playground for value

value: any

Gets or sets the default value used for this point if nothing is connected

valueMax Search playground for valueMax

valueMax: any

Gets or sets the max value accepted for this point if nothing is connected

valueMin Search playground for valueMin

valueMin: any

Gets or sets the min value accepted for this point if nothing is connected

Accessors

connectedBlocks

get connectedBlocks(): NodeGeometryBlock[]

- Defined in .temp/docdirectory/doc.d.ts:75846
Get the block connected on the endpoints of this connection (if any)

Returns NodeGeometryBlock[]

connectedPoint

get connectedPoint(): Nullable<NodeGeometryConnectionPoint>

- Defined in .temp/docdirectory/doc.d.ts:75840
Get the other side of the connection (if any)

Returns Nullable<NodeGeometryConnectionPoint>

direction

get direction(): NodeGeometryConnectionPointDirection

- Defined in .temp/docdirectory/doc.d.ts:75781
Gets the direction of the point

Returns NodeGeometryConnectionPointDirection

endpoints

get endpoints(): NodeGeometryConnectionPoint[]

- Defined in .temp/docdirectory/doc.d.ts:75848
Gets the list of connected endpoints

Returns NodeGeometryConnectionPoint[]

hasEndpoints

get hasEndpoints(): boolean

- Defined in .temp/docdirectory/doc.d.ts:75850
Gets a boolean indicating if that output point is connected to at least one input

Returns boolean

innerType

get innerType(): NodeGeometryBlockConnectionPointTypes

- Defined in .temp/docdirectory/doc.d.ts:75852
Get the inner type (ie AutoDetect for instance instead of the inferred one)

Returns NodeGeometryBlockConnectionPointTypes

isConnected

get isConnected(): boolean

- Defined in .temp/docdirectory/doc.d.ts:75838
Gets a boolean indicating that the current point is connected to another NodeMaterialBlock

Returns boolean

ownerBlock

get ownerBlock(): NodeGeometryBlock

- Defined in .temp/docdirectory/doc.d.ts:75842
Get the block that owns this connection point

Returns NodeGeometryBlock

sourceBlock

get sourceBlock(): Nullable<NodeGeometryBlock>

- Defined in .temp/docdirectory/doc.d.ts:75844
Get the block connected on the other side of this connection (if any)

Returns Nullable<NodeGeometryBlock>

type

get type(): NodeGeometryBlockConnectionPointTypes
set type(value: NodeGeometryBlockConnectionPointTypes): void

- Defined in .temp/docdirectory/doc.d.ts:75821
Gets or sets the connection point type (default is float)

Returns NodeGeometryBlockConnectionPointTypes
- Defined in .temp/docdirectory/doc.d.ts:75822
Gets or sets the connection point type (default is float)

Parameters
- value: NodeGeometryBlockConnectionPointTypes
Returns void

Methods

addExcludedConnectionPointFromAllowedTypes Search playground for addExcludedConnectionPointFromAllowedTypes

addExcludedConnectionPointFromAllowedTypes(mask: number): void

- Defined in .temp/docdirectory/doc.d.ts:75900
Fill the list of excluded connection point types with all types other than those passed in the parameter

Parameters
- mask: number
  
  Types (ORed values of NodeMaterialBlockConnectionPointTypes) that are allowed, and thus will not be pushed to the excluded list
Returns void

canConnectTo Search playground for canConnectTo

canConnectTo(connectionPoint: NodeGeometryConnectionPoint): boolean

- Defined in .temp/docdirectory/doc.d.ts:75876
Gets a boolean indicating if the current point can be connected to another point

Parameters
- connectionPoint: NodeGeometryConnectionPoint
  
  defines the other connection point
Returns boolean
a boolean

checkCompatibilityState Search playground for checkCompatibilityState

checkCompatibilityState(connectionPoint: NodeGeometryConnectionPoint): NodeGeometryConnectionPointCompatibilityStates

- Defined in .temp/docdirectory/doc.d.ts:75882
Gets a number indicating if the current point can be connected to another point

Parameters
- connectionPoint: NodeGeometryConnectionPoint
  
  defines the other connection point
Returns NodeGeometryConnectionPointCompatibilityStates
a number defining the compatibility state

connectTo Search playground for connectTo

connectTo(connectionPoint: NodeGeometryConnectionPoint, ignoreConstraints?: boolean): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75889
Connect this point to another connection point

Parameters
- connectionPoint: NodeGeometryConnectionPoint
  
  defines the other connection point
- Optional ignoreConstraints: boolean
  
  defines if the system will ignore connection type constraints (default is false)
Returns NodeGeometryConnectionPoint
the current connection point

disconnectFrom Search playground for disconnectFrom

disconnectFrom(endpoint: NodeGeometryConnectionPoint): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75895
Disconnect this point from one of his endpoint

Parameters
- endpoint: NodeGeometryConnectionPoint
  
  defines the other connection point
Returns NodeGeometryConnectionPoint
the current connection point

dispose Search playground for dispose

dispose(): void

- Defined in .temp/docdirectory/doc.d.ts:75910
Release resources

Returns void

getClassName Search playground for getClassName

getClassName(): string

- Defined in .temp/docdirectory/doc.d.ts:75870
Gets the current class name e.g. "NodeMaterialConnectionPoint"

Returns string
the class name

getConnectedValue Search playground for getConnectedValue

getConnectedValue(state: NodeGeometryBuildState): any

- Defined in .temp/docdirectory/doc.d.ts:75858
Gets the value represented by this connection point

Parameters
- state: NodeGeometryBuildState
  
  current evaluation state
Returns any
the connected value or the value if nothing is connected

serialize Search playground for serialize

serialize(isInput?: boolean): any

- Defined in .temp/docdirectory/doc.d.ts:75906
Serializes this point in a JSON representation

Parameters
- Optional isInput: boolean
  
  defines if the connection point is an input (default is true)
Returns any
the serialized point object

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

ownerBlock: NodeGeometryBlock

direction: NodeGeometryConnectionPointDirection

Returns NodeGeometryConnectionPoint

Properties

acceptedConnectionPointTypesSearch playground for acceptedConnectionPointTypes

defaultValueSearch playground for defaultValue

displayNameSearch playground for displayName

excludedConnectionPointTypesSearch playground for excludedConnectionPointTypes

exposedPortPositionSearch playground for exposedPortPosition

isExposedOnFrameSearch playground for isExposedOnFrame

isOptionalSearch playground for isOptional

nameSearch playground for name

onConnectionObservableSearch playground for onConnectionObservable

valueSearch playground for value

valueMaxSearch playground for valueMax

valueMinSearch playground for valueMin

Accessors

connectedBlocks

Returns NodeGeometryBlock[]

connectedPoint

Returns Nullable<NodeGeometryConnectionPoint>

direction

Returns NodeGeometryConnectionPointDirection

endpoints

Returns NodeGeometryConnectionPoint[]

hasEndpoints

Returns boolean

innerType

Returns NodeGeometryBlockConnectionPointTypes

isConnected

Returns boolean

ownerBlock

Returns NodeGeometryBlock

sourceBlock

Returns Nullable<NodeGeometryBlock>

type

Returns NodeGeometryBlockConnectionPointTypes

Parameters

value: NodeGeometryBlockConnectionPointTypes

Returns void

Methods

addExcludedConnectionPointFromAllowedTypesSearch playground for addExcludedConnectionPointFromAllowedTypes

Parameters

mask: number

Returns void

canConnectToSearch playground for canConnectTo

Parameters

connectionPoint: NodeGeometryConnectionPoint

Returns boolean

checkCompatibilityStateSearch playground for checkCompatibilityState

Parameters

connectionPoint: NodeGeometryConnectionPoint

Returns NodeGeometryConnectionPointCompatibilityStates

connectToSearch playground for connectTo

Parameters

connectionPoint: NodeGeometryConnectionPoint

Optional ignoreConstraints: boolean

Returns NodeGeometryConnectionPoint

disconnectFromSearch playground for disconnectFrom

Parameters

endpoint: NodeGeometryConnectionPoint

Returns NodeGeometryConnectionPoint

disposeSearch playground for dispose

Returns void

getClassNameSearch playground for getClassName

Returns string

getConnectedValueSearch playground for getConnectedValue

Parameters

state: NodeGeometryBuildState

Returns any

acceptedConnectionPointTypes Search playground for acceptedConnectionPointTypes

defaultValue Search playground for defaultValue

displayName Search playground for displayName

excludedConnectionPointTypes Search playground for excludedConnectionPointTypes

exposedPortPosition Search playground for exposedPortPosition

isExposedOnFrame Search playground for isExposedOnFrame

isOptional Search playground for isOptional

name Search playground for name

onConnectionObservable Search playground for onConnectionObservable

value Search playground for value

valueMax Search playground for valueMax

valueMin Search playground for valueMin

addExcludedConnectionPointFromAllowedTypes Search playground for addExcludedConnectionPointFromAllowedTypes

canConnectTo Search playground for canConnectTo

checkCompatibilityState Search playground for checkCompatibilityState

connectTo Search playground for connectTo

disconnectFrom Search playground for disconnectFrom

dispose Search playground for dispose

getClassName Search playground for getClassName

getConnectedValue Search playground for getConnectedValue

serialize Search playground for serialize