FlowGraphMultiGateBlock | Babylon.js API documentation

Class FlowGraphMultiGateBlock

A block that has an input flow and routes it to any potential output flows, randomly or sequentially

Hierarchy (View Summary)

FlowGraphExecutionBlock
- FlowGraphMultiGateBlock

Constructors

constructor

new FlowGraphMultiGateBlock(
config: IFlowGraphMultiGateBlockConfiguration,
): FlowGraphMultiGateBlock
Parameters
- config: IFlowGraphMultiGateBlockConfiguration
  the configuration of the block
Returns FlowGraphMultiGateBlock
Overrides FlowGraphExecutionBlock.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:107679

Properties

config

config: IFlowGraphMultiGateBlockConfiguration

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

`Readonly`lastIndex

lastIndex: FlowGraphDataConnection<FlowGraphInteger>

Output connection: The index of the current output flow.

metadata

metadata: any

Metadata that can be used by the block.

name

name: string

The name of the block.

`Readonly`outputSignals

outputSignals: FlowGraphSignalConnection[]

Output connections: The output signals.

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

`Readonly`reset

reset: FlowGraphSignalConnection

Input connection: Resets the gate.

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

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:105856

getClassName

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

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:106624

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:106630

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:105840

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:105846

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:106610

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:106618

serialize

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

setNumberOfOutputSignals

setNumberOfOutputSignals(numberOutputSignals?: number): void
Sets the block's output signals. Would usually be passed from the constructor but can be changed afterwards.
Parameters
- OptionalnumberOutputSignals: number
  the number of output flows
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:107689

Class FlowGraphMultiGateBlock

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowGraphMultiGateBlock

Properties

config

dataInputs

dataOutputs

Readonlyerror

Readonlyin

ReadonlylastIndex

metadata

name

ReadonlyoutputSignals

Readonlypriority

Readonlyreset

signalInputs

signalOutputs

uniqueId

Methods

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>

serialize

Parameters

Returns void

setNumberOfOutputSignals

Parameters

Returns void

Settings

On This Page

`Readonly`error

`Readonly`in

`Readonly`lastIndex

`Readonly`outputSignals

`Readonly`priority

`Readonly`reset