Babylon.js API documentation|

VectorConverterBlock

Class VectorConverterBlock

Block used to create a Vector2/3/4 out of individual or partial inputs

Hierarchy

NodeGeometryBlock
- VectorConverterBlock

Constructors

constructor

new VectorConverterBlock(name: string): VectorConverterBlock

Overrides NodeGeometryBlock.constructor
- Defined in .temp/docdirectory/doc.d.ts:75172
Create a new VectorConverterBlock

Parameters
- name: string
  
  defines the block name
Returns VectorConverterBlock

Properties

comments Search playground for comments

comments: string

A free comment about the block

onBuildObservable Search playground for onBuildObservable

onBuildObservable: Observable<NodeGeometryBlock>

Gets an observable raised when the block is built

uniqueId Search playground for uniqueId

uniqueId: number

Gets or sets the unique id of the node

visibleOnFrame Search playground for visibleOnFrame

visibleOnFrame: boolean

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

Accessors

buildExecutionTime

get buildExecutionTime(): number

Inherited from NodeGeometryBlock.buildExecutionTime
- Defined in .temp/docdirectory/doc.d.ts:75585
Gets the time spent to build this block (in ms)

Returns number

inputs

get inputs(): NodeGeometryConnectionPoint[]

Inherited from NodeGeometryBlock.inputs
- Defined in .temp/docdirectory/doc.d.ts:75589
Gets the list of input points

Returns NodeGeometryConnectionPoint[]

isDebug

get isDebug(): boolean

Inherited from NodeGeometryBlock.isDebug
- Defined in .temp/docdirectory/doc.d.ts:75616
Gets a boolean indicating if this block is a debug block

Returns boolean

isInput

get isInput(): boolean

Inherited from NodeGeometryBlock.isInput
- Defined in .temp/docdirectory/doc.d.ts:75604
Gets a boolean indicating if this block is an input

Returns boolean

isTeleportIn

get isTeleportIn(): boolean

Inherited from NodeGeometryBlock.isTeleportIn
- Defined in .temp/docdirectory/doc.d.ts:75612
Gets a boolean indicating if this block is a teleport in

Returns boolean

isTeleportOut

get isTeleportOut(): boolean

Inherited from NodeGeometryBlock.isTeleportOut
- Defined in .temp/docdirectory/doc.d.ts:75608
Gets a boolean indicating if this block is a teleport out

Returns boolean

isUnique

get isUnique(): boolean

Inherited from NodeGeometryBlock.isUnique
- Defined in .temp/docdirectory/doc.d.ts:75620
Gets a boolean indicating that this block can only be used once per NodeGeometry

Returns boolean

name

get name(): string
set name(value: string): void

Inherited from NodeGeometryBlock.name
- Defined in .temp/docdirectory/doc.d.ts:75599
Gets or set the name of the block

Returns string
Inherited from NodeGeometryBlock.name
- Defined in .temp/docdirectory/doc.d.ts:75600
Gets or set the name of the block

Parameters
- value: string
Returns void

outputs

get outputs(): NodeGeometryConnectionPoint[]

Inherited from NodeGeometryBlock.outputs
- Defined in .temp/docdirectory/doc.d.ts:75591
Gets the list of output points

Returns NodeGeometryConnectionPoint[]

wIn

get wIn(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75209
Gets the w component (input)

Returns NodeGeometryConnectionPoint

wOut

get wOut(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75241
Gets the w component (output)

Returns NodeGeometryConnectionPoint

xIn

get xIn(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75197
Gets the x component (input)

Returns NodeGeometryConnectionPoint

xOut

get xOut(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75229
Gets the x component (output)

Returns NodeGeometryConnectionPoint

xyIn

get xyIn(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75189
Gets the xy component (input)

Returns NodeGeometryConnectionPoint

xyOut

get xyOut(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75221
Gets the xy component (output)

Returns NodeGeometryConnectionPoint

xyzIn

get xyzIn(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75185
Gets the xyz component (input)

Returns NodeGeometryConnectionPoint

xyzOut

get xyzOut(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75217
Gets the xyz component (output)

Returns NodeGeometryConnectionPoint

xyzwIn

get xyzwIn(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75181
Gets the xyzw component (input)

Returns NodeGeometryConnectionPoint

xyzwOut

get xyzwOut(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75213
Gets the xyzw component (output)

Returns NodeGeometryConnectionPoint

yIn

get yIn(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75201
Gets the y component (input)

Returns NodeGeometryConnectionPoint

yOut

get yOut(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75233
Gets the y component (output)

Returns NodeGeometryConnectionPoint

zIn

get zIn(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75205
Gets the z component (input)

Returns NodeGeometryConnectionPoint

zOut

get zOut(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75237
Gets the z component (output)

Returns NodeGeometryConnectionPoint

zwIn

get zwIn(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75193
Gets the zw component (input)

Returns NodeGeometryConnectionPoint

zwOut

get zwOut(): NodeGeometryConnectionPoint

- Defined in .temp/docdirectory/doc.d.ts:75225
Gets the zw component (output)

Returns NodeGeometryConnectionPoint

Methods

autoConfigure Search playground for autoConfigure

autoConfigure(): void

Inherited from NodeGeometryBlock.autoConfigure
- Defined in .temp/docdirectory/doc.d.ts:75692
Lets the block try to connect some inputs automatically

Returns void

build Search playground for build

build(state: NodeGeometryBuildState): boolean

Inherited from NodeGeometryBlock.build
- Defined in .temp/docdirectory/doc.d.ts:75683
Build the current node and generate the vertex data

Parameters
- state: NodeGeometryBuildState
  
  defines the current generation state
Returns boolean
true if already built

clone Search playground for clone

clone(): null | NodeGeometryBlock

Inherited from NodeGeometryBlock.clone
- Defined in .temp/docdirectory/doc.d.ts:75729
Clone the current block to a new identical block

Returns null | NodeGeometryBlock
a copy of the current block

dispose Search playground for dispose

dispose(): void

Inherited from NodeGeometryBlock.dispose
- Defined in .temp/docdirectory/doc.d.ts:75733
Release resources

Returns void

getClassName Search playground for getClassName

getClassName(): string

Overrides NodeGeometryBlock.getClassName
- Defined in .temp/docdirectory/doc.d.ts:75177
Gets the current class name

Returns string
the class name

getDescendantOfPredicate Search playground for getDescendantOfPredicate

getDescendantOfPredicate(predicate: ((block: NodeGeometryBlock) => boolean)): Nullable<NodeGeometryBlock>

Inherited from NodeGeometryBlock.getDescendantOfPredicate
- Defined in .temp/docdirectory/doc.d.ts:75651
Get the first descendant using a predicate

Parameters
- predicate: ((block: NodeGeometryBlock) => boolean)
  
  defines the predicate to check
  - - (block: NodeGeometryBlock): boolean
    - Parameters
      - block: NodeGeometryBlock
      Returns boolean
Returns Nullable<NodeGeometryBlock>
descendant or null if none found

getInputByName Search playground for getInputByName

getInputByName(name: string): null | NodeGeometryConnectionPoint

Inherited from NodeGeometryBlock.getInputByName
- Defined in .temp/docdirectory/doc.d.ts:75698
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

getOutputByName Search playground for getOutputByName

getOutputByName(name: string): null | NodeGeometryConnectionPoint

Inherited from NodeGeometryBlock.getOutputByName
- Defined in .temp/docdirectory/doc.d.ts:75704
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

initialize Search playground for initialize

initialize(): void

Inherited from NodeGeometryBlock.initialize
- Defined in .temp/docdirectory/doc.d.ts:75688
Initialize the block and prepare the context for build

Returns void

isAnAncestorOf Search playground for isAnAncestorOf

isAnAncestorOf(block: NodeGeometryBlock): boolean

Inherited from NodeGeometryBlock.isAnAncestorOf
- Defined in .temp/docdirectory/doc.d.ts:75639
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

isAnAncestorOfType Search playground for isAnAncestorOfType

isAnAncestorOfType(type: string): boolean

Inherited from NodeGeometryBlock.isAnAncestorOfType
- Defined in .temp/docdirectory/doc.d.ts:75645
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

registerInput Search playground for registerInput

registerInput(name: string, type: NodeGeometryBlockConnectionPointTypes, isOptional?: boolean, value?: any, valueMin?: any, valueMax?: any): VectorConverterBlock

Inherited from NodeGeometryBlock.registerInput
- Defined in .temp/docdirectory/doc.d.ts:75667
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
- Optional isOptional: boolean
  
  defines a boolean indicating that this input can be omitted
- Optional value: any
  
  value to return if there is no connection
- Optional valueMin: any
  
  min value accepted for value
- Optional valueMax: any
  
  max value accepted for value
Returns VectorConverterBlock
the current block

registerOutput Search playground for registerOutput

registerOutput(name: string, type: NodeGeometryBlockConnectionPointTypes, point?: NodeGeometryConnectionPoint): VectorConverterBlock

Inherited from NodeGeometryBlock.registerOutput
- Defined in .temp/docdirectory/doc.d.ts:75675
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
- Optional point: NodeGeometryConnectionPoint
  
  an already created connection point. If not provided, create a new one
Returns VectorConverterBlock
the current block

serialize Search playground for serialize

serialize(_saveMeshData?: boolean): any

Inherited from NodeGeometryBlock.serialize
- Defined in .temp/docdirectory/doc.d.ts:75710
Serializes this block in a JSON representation

Parameters
- Optional _saveMeshData: boolean
  
  defines a boolean indicating that mesh data must be saved as well
Returns any
the serialized block object