FlowGraphBranchBlock | Babylon.js API documentation

Class FlowGraphBranchBlock

A block that evaluates a condition and activates one of two branches.

Hierarchy (View Summary)

FlowGraphExecutionBlock
- FlowGraphBranchBlock

Index

Constructors

constructor

new FlowGraphBranchBlock(
config?: IFlowGraphBlockConfiguration,
): FlowGraphBranchBlock
Parameters
- Optionalconfig: IFlowGraphBlockConfiguration
Returns FlowGraphBranchBlock
Overrides FlowGraphExecutionBlock.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:107380

Properties

`Readonly`condition

condition: FlowGraphDataConnection<boolean>

Input connection: The condition to evaluate.

`Optional`config

config?: IFlowGraphBlockConfiguration

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.

metadata

metadata: any

Metadata that can be used by the block.

name

name: string

The name of the block.

`Readonly`onFalse

onFalse: FlowGraphSignalConnection

Output connection: The branch to execute if the condition is false.

`Readonly`onTrue

onTrue: FlowGraphSignalConnection

Output connection: The branch to execute if the condition is true.

`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

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

getClassName

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

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

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

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

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

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

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

serialize

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

Class FlowGraphBranchBlock

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FlowGraphBranchBlock

Properties

Readonlycondition

Optionalconfig

dataInputs

dataOutputs

Readonlyerror

Readonlyin

metadata

name

ReadonlyonFalse

ReadonlyonTrue

Readonlypriority

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

Settings

On This Page

`Readonly`condition

`Optional`config

`Readonly`error

`Readonly`in

`Readonly`onFalse

`Readonly`onTrue

`Readonly`priority