FlowGraphSwitchBlock | Babylon.js API documentation

Class FlowGraphSwitchBlock<T>

A block that executes a branch based on a selection.

Type Parameters

T extends FlowGraphNumber

Hierarchy (View Summary)

FlowGraphExecutionBlock
- FlowGraphSwitchBlock

Index

Constructors

constructor

new FlowGraphSwitchBlock<T extends FlowGraphNumber>(
config: IFlowGraphSwitchBlockConfiguration<T>,
): FlowGraphSwitchBlock<T>
Type Parameters
- T extends FlowGraphNumber
Parameters
- config: IFlowGraphSwitchBlockConfiguration<T>
  the configuration of the block
Returns FlowGraphSwitchBlock<T>
Overrides FlowGraphExecutionBlock.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:107164

Properties

`Readonly`case

case: FlowGraphDataConnection<T>

Input connection: The value of the selection.

config

config: IFlowGraphSwitchBlockConfiguration<T>

the configuration of the block

dataInputs

dataInputs: FlowGraphDataConnection<any>[]

The data inputs of the block.

dataOutputs

dataOutputs: FlowGraphDataConnection<any>[]

The data outputs of the block.

`Readonly`default

default: FlowGraphSignalConnection

The default case to execute if no other case is found.

`Readonly`error

error: FlowGraphSignalConnection

An output connection that can be used to signal an error, if the block defines it.

`Readonly`in

in: FlowGraphSignalConnection

Input connection: The input signal of the block.

metadata

metadata: any

Metadata that can be used by the block.

name

name: string

The name of the block.

`Readonly`priority

priority: number

The priority of the block. Higher priority blocks will be executed first. Note that priority cannot be change AFTER the block was added as sorting happens when the block is added to the execution queue.

signalInputs

signalInputs: FlowGraphSignalConnection[]

Input connections that activate the block.

signalOutputs

signalOutputs: FlowGraphSignalConnection[]

Output connections that can activate downstream blocks.

uniqueId

uniqueId: string

A randomly generated GUID for each block.

Methods

addCase

addCase(newCase: T): void
Adds a new case to the switch block.
Parameters
- newCase: T
  the new case to add.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:107174

deserialize

deserialize(serializationObject: any): void
Deserializes from an object
Parameters
- serializationObject: any
  the object to deserialize from
Returns void
Inherited from FlowGraphExecutionBlock.deserialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:105478

getClassName

getClassName(): string
Returns string
class name of the block.
Overrides FlowGraphExecutionBlock.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:107187

getDataInput

getDataInput(name: string): undefined | FlowGraphDataConnection<any>
Given the name of a data input, returns the connection if it exists
Parameters
- name: string
  the name of the input
Returns undefined | FlowGraphDataConnection<any>
the connection if it exists, undefined otherwise
Inherited from FlowGraphExecutionBlock.getDataInput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:106246

getDataOutput

getDataOutput(name: string): undefined | FlowGraphDataConnection<any>
Given the name of a data output, returns the connection if it exists
Parameters
- name: string
  the name of the output
Returns undefined | FlowGraphDataConnection<any>
the connection if it exists, undefined otherwise
Inherited from FlowGraphExecutionBlock.getDataOutput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:106252

getSignalInput

getSignalInput(name: string): undefined | FlowGraphSignalConnection
Given a name of a signal input, return that input if it exists
Parameters
- name: string
  the name of the input
Returns undefined | FlowGraphSignalConnection
if the input exists, the input. Otherwise, undefined.
Inherited from FlowGraphExecutionBlock.getSignalInput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:105462

getSignalOutput

getSignalOutput(name: string): undefined | FlowGraphSignalConnection
Given a name of a signal output, return that input if it exists
Parameters
- name: string
  the name of the input
Returns undefined | FlowGraphSignalConnection
if the input exists, the input. Otherwise, undefined.
Inherited from FlowGraphExecutionBlock.getSignalOutput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:105468

registerDataInput

registerDataInput<T>(
    name: string,
    richType: RichType<T>,
    defaultValue?: T,
): FlowGraphDataConnection<T>
Registers a data input on the block.
Type Parameters
- T
Parameters
- name: string
  the name of the input
- richType: RichType<T>
  the type of the input
- OptionaldefaultValue: T
  optional default value of the input. If not set, the rich type's default value will be used.
Returns FlowGraphDataConnection<T>
the created connection
Inherited from FlowGraphExecutionBlock.registerDataInput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:106232

registerDataOutput

registerDataOutput<T>(
    name: string,
    richType: RichType<T>,
    defaultValue?: T,
): FlowGraphDataConnection<T>
Registers a data output on the block.
Type Parameters
- T
Parameters
- name: string
  the name of the input
- richType: RichType<T>
  the type of the input
- OptionaldefaultValue: T
  optional default value of the input. If not set, the rich type's default value will be used.
Returns FlowGraphDataConnection<T>
the created connection
Inherited from FlowGraphExecutionBlock.registerDataOutput
- Defined in .temp/typedoc/docdirectory/doc.d.ts:106240

removeCase

removeCase(caseToRemove: T): void
Removes a case from the switch block.
Parameters
- caseToRemove: T
  the case to remove.
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:107179

serialize

serialize(serializationObject?: any): void
Serialize the block to a JSON representation.
Parameters
- OptionalserializationObject: any
  the object to serialize to.
Returns void
Overrides FlowGraphExecutionBlock.serialize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:107192

Class FlowGraphSwitchBlock<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns FlowGraphSwitchBlock<T>

Properties

Readonlycase

config

dataInputs

dataOutputs

Readonlydefault

Readonlyerror

Readonlyin

metadata

name

Readonlypriority

signalInputs

signalOutputs

uniqueId

Methods

addCase

Parameters

Returns void

deserialize

Parameters

Returns void

getClassName

Returns string

getDataInput

Parameters

Returns undefined | FlowGraphDataConnection<any>

getDataOutput

Parameters

Returns undefined | FlowGraphDataConnection<any>

getSignalInput

Parameters

Returns undefined | FlowGraphSignalConnection

getSignalOutput

Parameters

Returns undefined | FlowGraphSignalConnection

registerDataInput

Type Parameters

Parameters

Returns FlowGraphDataConnection<T>

registerDataOutput

Type Parameters

Parameters

Returns FlowGraphDataConnection<T>

removeCase

Parameters

Returns void

serialize

Parameters

Returns void

Settings

On This Page

`Readonly`case

`Readonly`default

`Readonly`error

`Readonly`in

`Readonly`priority