Class NodeGeometry

Defines a node based geometry

see: demo at https://playground.babylonjs.com#PYY6XE#69

Hierarchy

NodeGeometry

Constructors

constructor

new NodeGeometry(name: string): NodeGeometry

- Defined in .temp/docdirectory/doc.d.ts:74426
Creates a new geometry

Parameters
- name: string
  
  defines the name of the geometry
Returns NodeGeometry

Properties

attachedBlocks Search playground for attachedBlocks

attachedBlocks: NodeGeometryBlock[]

Gets an array of blocks that needs to be serialized even if they are not yet connected

comment Search playground for comment

comment: string

A free comment about the geometry

editorData Search playground for editorData

editorData: any

Gets or sets data used by visual editor

see: https://nge.babylonjs.com

name Search playground for name

name: string

The name of the geometry

onBuildObservable Search playground for onBuildObservable

onBuildObservable: Observable<NodeGeometry>

Observable raised when the geometry is built

outputBlock Search playground for outputBlock

outputBlock: Nullable<GeometryOutputBlock>

Gets or sets the GeometryOutputBlock used to gather the final geometry data

snippetId Search playground for snippetId

snippetId: string

Snippet ID if the material was created from the snippet server

Static EditorURL Search playground for EditorURL

EditorURL: string

Define the Url to load node editor script

Static SnippetUrl Search playground for SnippetUrl

SnippetUrl: string

Define the Url to load snippets

Accessors

buildExecutionTime

get buildExecutionTime(): number

- Defined in .temp/docdirectory/doc.d.ts:74394
Gets the time spent to build this block (in ms)

Returns number

Methods

build Search playground for build

build(verbose?: boolean, updateBuildId?: boolean, autoConfigure?: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:74463
Build the final geometry

Parameters
- Optional verbose: boolean
  
  defines if the build should log activity
- Optional updateBuildId: boolean
  
  defines if the internal build Id should be updated (default is true)
- Optional autoConfigure: boolean
  
  defines if the autoConfigure method should be called when initializing blocks (default is false)
Returns void

clear Search playground for clear

clear(): void

- Defined in .temp/docdirectory/doc.d.ts:74481
Clear the current geometry

Returns void

clone Search playground for clone

clone(name: string): NodeGeometry

- Defined in .temp/docdirectory/doc.d.ts:74508
Makes a duplicate of the current geometry.

Parameters
- name: string
  
  defines the name to use for the new geometry
Returns NodeGeometry

createMesh Search playground for createMesh

createMesh(name: string, scene?: Nullable<Scene>): Nullable<Mesh>

- Defined in .temp/docdirectory/doc.d.ts:74470
Creates a mesh from the geometry blocks

Parameters
- name: string
  
  defines the name of the mesh
- Optional scene: Nullable<Scene>
  
  The scene the mesh is scoped to
Returns Nullable<Mesh>
The new mesh

dispose Search playground for dispose

dispose(): void

- Defined in .temp/docdirectory/doc.d.ts:74519
Disposes the ressources

Returns void

edit Search playground for edit

edit(config?: INodeGeometryEditorOptions): Promise<void>

- Defined in .temp/docdirectory/doc.d.ts:74454
Launch the node geometry editor

Parameters
- Optional config: INodeGeometryEditorOptions
  
  Define the configuration of the editor
Returns Promise<void>
a promise fulfilled when the node editor is visible

generateCode Search playground for generateCode

generateCode(): string

- Defined in .temp/docdirectory/doc.d.ts:74498
Generate a string containing the code declaration required to create an equivalent of this geometry

Returns string
a string

getBlockByName Search playground for getBlockByName

getBlockByName(name: string): null | NodeGeometryBlock

- Defined in .temp/docdirectory/doc.d.ts:74437
Get a block by its name

Parameters
- name: string
  
  defines the name of the block to retrieve
Returns null | NodeGeometryBlock
the required block or null if not found

getBlockByPredicate Search playground for getBlockByPredicate

getBlockByPredicate(predicate: ((block: NodeGeometryBlock) => boolean)): null | NodeGeometryBlock

- Defined in .temp/docdirectory/doc.d.ts:74443
Get a block using a predicate

Parameters
- predicate: ((block: NodeGeometryBlock) => boolean)
  
  defines the predicate used to find the good candidate
  - - (block: NodeGeometryBlock): boolean
    - Parameters
      - block: NodeGeometryBlock
      Returns boolean
Returns null | NodeGeometryBlock
the required block or null if not found

getClassName Search playground for getClassName

getClassName(): string

- Defined in .temp/docdirectory/doc.d.ts:74431
Gets the current class name of the geometry e.g. "NodeGeometry"

Returns string
the class name

getInputBlocks Search playground for getInputBlocks

getInputBlocks(): GeometryInputBlock[]

- Defined in .temp/docdirectory/doc.d.ts:74448
Gets the list of input blocks attached to this material

Returns GeometryInputBlock[]
an array of InputBlocks

parseSerializedObject Search playground for parseSerializedObject

parseSerializedObject(source: any, merge?: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:74492
Clear the current graph and load a new one from a serialization object

Parameters
- source: any
  
  defines the JSON representation of the geometry
- Optional merge: boolean
  
  defines whether or not the source must be merged or replace the current content
Returns void

removeBlock Search playground for removeBlock

removeBlock(block: NodeGeometryBlock): void

- Defined in .temp/docdirectory/doc.d.ts:74486
Remove a block from the current geometry

Parameters
- block: NodeGeometryBlock
  
  defines the block to remove
Returns void

serialize Search playground for serialize

serialize(saveMeshData?: boolean, selectedBlocks?: NodeGeometryBlock[]): any

- Defined in .temp/docdirectory/doc.d.ts:74515
Serializes this geometry in a JSON representation

Parameters
- Optional saveMeshData: boolean
  
  defines a boolean indicating that mesh data must be saved as well
- Optional selectedBlocks: NodeGeometryBlock[]
  
  defines the list of blocks to save (if null the whole geometry will be saved)
Returns any
the serialized geometry object

setToDefault Search playground for setToDefault

setToDefault(): void

- Defined in .temp/docdirectory/doc.d.ts:74503
Clear the current geometry and set it to a default state

Returns void

updateMesh Search playground for updateMesh

updateMesh(mesh: Mesh): false | Mesh

- Defined in .temp/docdirectory/doc.d.ts:74476
Creates a mesh from the geometry blocks

Parameters
- mesh: Mesh
  
  the mesh to update
Returns false | Mesh
True if successfully updated

Static CreateDefault Search playground for CreateDefault

CreateDefault(name: string): NodeGeometry

- Defined in .temp/docdirectory/doc.d.ts:74525
Creates a new node geometry set to default basic configuration

Parameters
- name: string
  
  defines the name of the geometry
Returns NodeGeometry
a new NodeGeometry

Static Parse Search playground for Parse

Parse(source: any): NodeGeometry

- Defined in .temp/docdirectory/doc.d.ts:74531
Creates a node geometry from parsed geometry data

Parameters
- source: any
  
  defines the JSON representation of the geometry
Returns NodeGeometry
a new node geometry

Static ParseFromSnippetAsync Search playground for ParseFromSnippetAsync

ParseFromSnippetAsync(snippetId: string, nodeGeometry?: NodeGeometry, skipBuild?: boolean): Promise<NodeGeometry>

- Defined in .temp/docdirectory/doc.d.ts:74539
Creates a node geometry from a snippet saved by the node geometry editor

Parameters
- snippetId: string
  
  defines the snippet to load
- Optional nodeGeometry: NodeGeometry
  
  defines a node geometry to update (instead of creating a new one)
- Optional skipBuild: boolean
  
  defines whether to build the node geometry
Returns Promise<NodeGeometry>
a promise that will resolve to the new node geometry

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

Returns NodeGeometry

Properties

attachedBlocksSearch playground for attachedBlocks

commentSearch playground for comment

editorDataSearch playground for editorData

nameSearch playground for name

onBuildObservableSearch playground for onBuildObservable

outputBlockSearch playground for outputBlock

snippetIdSearch playground for snippetId

Static EditorURLSearch playground for EditorURL

Static SnippetUrlSearch playground for SnippetUrl

Accessors

buildExecutionTime

Returns number

Methods

buildSearch playground for build

Parameters

Optional verbose: boolean

Optional updateBuildId: boolean

Optional autoConfigure: boolean

Returns void

clearSearch playground for clear

Returns void

cloneSearch playground for clone

Parameters

name: string

Returns NodeGeometry

createMeshSearch playground for createMesh

Parameters

name: string

Optional scene: Nullable<Scene>

Returns Nullable<Mesh>

disposeSearch playground for dispose

Returns void

editSearch playground for edit

Parameters

Optional config: INodeGeometryEditorOptions

Returns Promise<void>

generateCodeSearch playground for generateCode

Returns string

getBlockByNameSearch playground for getBlockByName

Parameters

name: string

Returns null | NodeGeometryBlock

getBlockByPredicateSearch playground for getBlockByPredicate

Parameters

predicate: ((block: NodeGeometryBlock) => boolean)

Parameters

block: NodeGeometryBlock

Returns boolean

Returns null | NodeGeometryBlock

getClassNameSearch playground for getClassName

Returns string

getInputBlocksSearch playground for getInputBlocks

Returns GeometryInputBlock[]

parseSerializedObjectSearch playground for parseSerializedObject

Parameters

source: any

Optional merge: boolean

Returns void

removeBlockSearch playground for removeBlock

Parameters

block: NodeGeometryBlock

Returns void

serializeSearch playground for serialize

Parameters

Optional saveMeshData: boolean

Optional selectedBlocks: NodeGeometryBlock[]

Returns any

setToDefaultSearch playground for setToDefault

attachedBlocks Search playground for attachedBlocks

comment Search playground for comment

editorData Search playground for editorData

name Search playground for name

onBuildObservable Search playground for onBuildObservable

outputBlock Search playground for outputBlock

snippetId Search playground for snippetId

Static EditorURL Search playground for EditorURL

Static SnippetUrl Search playground for SnippetUrl

build Search playground for build

clear Search playground for clear

clone Search playground for clone

createMesh Search playground for createMesh

dispose Search playground for dispose

edit Search playground for edit

generateCode Search playground for generateCode

getBlockByName Search playground for getBlockByName

getBlockByPredicate Search playground for getBlockByPredicate

getClassName Search playground for getClassName

getInputBlocks Search playground for getInputBlocks

parseSerializedObject Search playground for parseSerializedObject

removeBlock Search playground for removeBlock

serialize Search playground for serialize

setToDefault Search playground for setToDefault

updateMesh Search playground for updateMesh

Static CreateDefault Search playground for CreateDefault

Static Parse Search playground for Parse

Static ParseFromSnippetAsync Search playground for ParseFromSnippetAsync