Class NodeGeometry

constructor

• new NodeGeometry(name: string): NodeGeometry

  Creates a new geometry

  Parameters

  • name: string

    defines the name of the geometry

  Returns NodeGeometry

attachedBlocks

comment

editorData

name

onBuildObservable

outputBlock

snippetId

StaticEditorURL

StaticSnippetUrl

buildExecutionTime

• get buildExecutionTime(): number

  Gets the time spent to build this block (in ms)

  Returns number

vertexData

• get vertexData(): Nullable<VertexData>

  Gets the vertex data. This needs to be done after build() was called. This is used to access vertexData when creating a mesh is not required.

  Returns Nullable<VertexData>

build

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

  Build the final geometry. Please note that the geometry MAY not be ready until the onBuildObservable is raised.

  Parameters

  • verbose: boolean = false

    defines if the build should log activity

  • updateBuildId: boolean = true

    defines if the internal build Id should be updated (default is true)

  • autoConfigure: boolean = false

    defines if the autoConfigure method should be called when initializing blocks (default is false)

  Returns void

clear

• clear(): void

  Clear the current geometry

  Returns void

clone

• clone(name: string): NodeGeometry

  Makes a duplicate of the current geometry.

  Parameters

  • name: string

    defines the name to use for the new geometry

  Returns NodeGeometry

  the new geometry

createMesh

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

  Creates a mesh from the geometry blocks

  Parameters

  • name: string

    defines the name of the mesh

  • scene: Nullable<Scene> = null

    The scene the mesh is scoped to

  Returns Nullable<Mesh>

  The new mesh

dispose

• dispose(): void

  Disposes the resources

  Returns void

edit

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

  Launch the node geometry editor

  Parameters

  • Optionalconfig: INodeGeometryEditorOptions

    Define the configuration of the editor

  Returns Promise<void>

  a promise fulfilled when the node editor is visible

generateCode

• generateCode(): string

  Generate a string containing the code declaration required to create an equivalent of this geometry

  Returns string

  a string

getBlockByName

• getBlockByName(name: string): NodeGeometryBlock | null

  Get a block by its name

  Parameters

  • name: string

    defines the name of the block to retrieve

  Returns NodeGeometryBlock | null

  the required block or null if not found

getBlockByPredicate

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

  Get a block using a predicate

  Parameters

  • predicate: (block: NodeGeometryBlock) => boolean

    defines the predicate used to find the good candidate

  Returns NodeGeometryBlock | null

  the required block or null if not found

getClassName

• getClassName(): string

  Gets the current class name of the geometry e.g. "NodeGeometry"

  Returns string

  the class name

getInputBlocks

• getInputBlocks(): GeometryInputBlock[]

  Gets the list of input blocks attached to this material

  Returns GeometryInputBlock[]

  an array of InputBlocks

parseSerializedObject

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

  Clear the current graph and load a new one from a serialization object

  Parameters

  • source: any

    defines the JSON representation of the geometry

  • merge: boolean = false

    defines whether or not the source must be merged or replace the current content

  Returns void

removeBlock

• removeBlock(block: NodeGeometryBlock): void

  Remove a block from the current geometry

  Parameters

  • block: NodeGeometryBlock

    defines the block to remove

  Returns void

serialize

• serialize(selectedBlocks?: NodeGeometryBlock[]): any

  Serializes this geometry in a JSON representation

  Parameters

  • OptionalselectedBlocks: NodeGeometryBlock[]

    defines the list of blocks to save (if null the whole geometry will be saved)

  Returns any

  the serialized geometry object

setToDefault

• setToDefault(): void

  Clear the current geometry and set it to a default state

  Returns void

updateMesh

• updateMesh(mesh: Mesh): false | Mesh

  Creates a mesh from the geometry blocks

  Parameters

  • mesh: Mesh

    the mesh to update

  Returns false | Mesh

  True if successfully updated

StaticCreateDefault

• CreateDefault(name: string): NodeGeometry

  Creates a new node geometry set to default basic configuration

  Parameters

  • name: string

    defines the name of the geometry

  Returns NodeGeometry

  a new NodeGeometry

StaticParse

• Parse(source: any): NodeGeometry

  Creates a node geometry from parsed geometry data

  Parameters

  • source: any

    defines the JSON representation of the geometry

  Returns NodeGeometry

  a new node geometry

StaticParseFromSnippetAsync

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

  Creates a node geometry from a snippet saved by the node geometry editor

  Parameters

  • snippetId: string

    defines the snippet to load

  • OptionalnodeGeometry: NodeGeometry

    defines a node geometry to update (instead of creating a new one)

  • skipBuild: boolean = false

    defines whether to build the node geometry

  Returns Promise<NodeGeometry>

  a promise that will resolve to the new node geometry