NodeGeometryBlock | Babylon.js API documentation

Class NodeGeometryBlock

Defines a block that can be used inside a node based geometry

Hierarchy (View Summary)

NodeGeometryBlock

Constructors

constructor

new NodeGeometryBlock(name: string): NodeGeometryBlock
Creates a new NodeGeometryBlock
Parameters
- name: string
  defines the block name
Returns NodeGeometryBlock
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53447

Properties

comments

comments: string

A free comment about the block

onBuildObservable

onBuildObservable: Observable<NodeGeometryBlock>

Gets an observable raised when the block is built

uniqueId

uniqueId: number

Gets or sets the unique id of the node

visibleOnFrame

visibleOnFrame: boolean

Gets or sets a boolean indicating that this input can be edited from a collapsed frame

Accessors

buildExecutionTime

get buildExecutionTime(): number
Gets the time spent to build this block (in ms)

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53372

inputs

get inputs(): NodeGeometryConnectionPoint[]
Gets the list of input points

Returns NodeGeometryConnectionPoint[]
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53376

isDebug

get isDebug(): boolean
Gets a boolean indicating if this block is a debug block

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53403

isInput

get isInput(): boolean
Gets a boolean indicating if this block is an input

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53391

isTeleportIn

get isTeleportIn(): boolean
Gets a boolean indicating if this block is a teleport in

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53399

isTeleportOut

get isTeleportOut(): boolean
Gets a boolean indicating if this block is a teleport out

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53395

isUnique

get isUnique(): boolean
Gets a boolean indicating that this block can only be used once per NodeGeometry

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53407

name

get name(): string
Gets or set the name of the block

Returns string
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53386
set name(value: string): void
Parameters
- value: string
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53387

outputs

get outputs(): NodeGeometryConnectionPoint[]
Gets the list of output points

Returns NodeGeometryConnectionPoint[]
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53378

Methods

autoConfigure

autoConfigure(_nodeGeometry: NodeGeometry): void
Lets the block try to connect some inputs automatically
Parameters
- _nodeGeometry: NodeGeometry
  defines the node geometry to use for auto connection
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53484

build

build(state: NodeGeometryBuildState): boolean
Build the current node and generate the vertex data
Parameters
- state: NodeGeometryBuildState
  defines the current generation state
Returns boolean
true if already built
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53474

clone

clone(): null | NodeGeometryBlock
Clone the current block to a new identical block

Returns null | NodeGeometryBlock
a copy of the current block
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53520

dispose

dispose(): void
Release resources

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53524

getClassName

getClassName(): string
Gets the current class name e.g. "NodeGeometryBlock"

Returns string
the class name
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53418

getDescendantOfPredicate

getDescendantOfPredicate(
predicate: (block: NodeGeometryBlock) => boolean,
): Nullable<NodeGeometryBlock>
Get the first descendant using a predicate
Parameters
- predicate: (block: NodeGeometryBlock) => boolean
  defines the predicate to check
Returns Nullable<NodeGeometryBlock>
descendant or null if none found
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53438

getInputByName

getInputByName(name: string): null | NodeGeometryConnectionPoint
Find an input by its name
Parameters
- name: string
  defines the name of the input to look for
Returns null | NodeGeometryConnectionPoint
the input or null if not found
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53490

getOutputByName

getOutputByName(name: string): null | NodeGeometryConnectionPoint
Find an output by its name
Parameters
- name: string
  defines the name of the output to look for
Returns null | NodeGeometryConnectionPoint
the output or null if not found
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53496

initialize

initialize(): void
Initialize the block and prepare the context for build

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53479

isAnAncestorOf

isAnAncestorOf(block: NodeGeometryBlock): boolean
Checks if the current block is an ancestor of a given block
Parameters
- block: NodeGeometryBlock
  defines the potential descendant block to check
Returns boolean
true if block is a descendant
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53426

isAnAncestorOfType

isAnAncestorOfType(type: string): boolean
Checks if the current block is an ancestor of a given type
Parameters
- type: string
  defines the potential type to check
Returns boolean
true if block is a descendant
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53432

registerInput

registerInput(
    name: string,
    type: NodeGeometryBlockConnectionPointTypes,
    isOptional?: boolean,
    value?: any,
    valueMin?: any,
    valueMax?: any,
): this
Register a new input. Must be called inside a block constructor
Parameters
- name: string
  defines the connection point name
- type: NodeGeometryBlockConnectionPointTypes
  defines the connection point type
- OptionalisOptional: boolean
  defines a boolean indicating that this input can be omitted
- Optionalvalue: any
  value to return if there is no connection
- OptionalvalueMin: any
  min value accepted for value
- OptionalvalueMax: any
  max value accepted for value
Returns this
the current block
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53458

registerOutput

registerOutput(
    name: string,
    type: NodeGeometryBlockConnectionPointTypes,
    point?: NodeGeometryConnectionPoint,
): this
Register a new output. Must be called inside a block constructor
Parameters
- name: string
  defines the connection point name
- type: NodeGeometryBlockConnectionPointTypes
  defines the connection point type
- Optionalpoint: NodeGeometryConnectionPoint
  an already created connection point. If not provided, create a new one
Returns this
the current block
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53466

serialize

serialize(): any
Serializes this block in a JSON representation

Returns any
the serialized block object
- Defined in .temp/typedoc/docdirectory/doc.d.ts:53501

Class NodeGeometryBlock

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NodeGeometryBlock

Properties

comments

onBuildObservable

uniqueId

visibleOnFrame

Accessors

buildExecutionTime

Returns number

inputs

Returns NodeGeometryConnectionPoint[]

isDebug

Returns boolean

isInput

Returns boolean

isTeleportIn

Returns boolean

isTeleportOut

Returns boolean

isUnique

Returns boolean

name

Returns string

Parameters

Returns void

outputs

Returns NodeGeometryConnectionPoint[]

Methods

autoConfigure

Parameters

Returns void

build

Parameters

Returns boolean

clone

Returns null | NodeGeometryBlock

dispose

Returns void

getClassName

Returns string

getDescendantOfPredicate

Parameters

Returns Nullable<NodeGeometryBlock>

getInputByName

Parameters

Returns null | NodeGeometryConnectionPoint

getOutputByName

Parameters

Returns null | NodeGeometryConnectionPoint

initialize

Returns void

isAnAncestorOf

Parameters

Returns boolean

isAnAncestorOfType

Parameters

Returns boolean

registerInput

Parameters

Returns this

registerOutput

Parameters

Returns this

serialize

Returns any

Settings

On This Page