Class NodeParticleSystemSet

constructor

• new NodeParticleSystemSet(name: string): NodeParticleSystemSet

  Creates a new set

  Parameters

  • name: string

    defines the name of the set

  Returns NodeParticleSystemSet

attachedBlocks

comment

editorData

name

onBuildObservable

snippetId

StaticEditorURL

StaticSnippetUrl

inputBlocks

• get inputBlocks(): ParticleInputBlock[]

  Gets the list of input blocks attached to this material

  Returns ParticleInputBlock[]

  an array of InputBlocks

systemBlocks

• get systemBlocks(): SystemBlock[]

  Gets the system blocks

  Returns SystemBlock[]

buildAsync

• buildAsync(scene: Scene, verbose?: boolean): Promise<ParticleSystemSet>

  Builds the particle system set from the defined blocks.

  Parameters

  • scene: Scene

    defines the hosting scene

  • verbose: boolean = false

    defines whether to log detailed information during the build process (false by default)

  Returns Promise<ParticleSystemSet>

  a promise that resolves to the built particle system set

clear

• clear(): void

  Clear the current node particle set

  Returns void

clone

• clone(name: string): NodeParticleSystemSet

  Makes a duplicate of the current particle system set.

  Parameters

  • name: string

    defines the name to use for the new particle system set

  Returns NodeParticleSystemSet

  the cloned particle system set

dispose

• dispose(): void

  Disposes the resources

  Returns void

editAsync

• editAsync(config?: INodeParticleEditorOptions): Promise<void>

  Launch the node particle editor

  Parameters

  • Optionalconfig: INodeParticleEditorOptions

    Define the configuration of the editor

  Returns Promise<void>

  a promise fulfilled when the node editor is visible

getBlockByName

• getBlockByName(name: string): NodeParticleBlock | null

  Get a block by its name

  Parameters

  • name: string

    defines the name of the block to retrieve

  Returns NodeParticleBlock | null

  the required block or null if not found

getBlockByPredicate

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

  Get a block using a predicate

  Parameters

  • predicate: (block: NodeParticleBlock) => boolean

    defines the predicate used to find the good candidate

  Returns NodeParticleBlock | null

  the required block or null if not found

getClassName

• getClassName(): string

  Gets the current class name of the node particle set e.g. "NodeParticleSystemSet"

  Returns string

  the class name

getInputBlockByPredicate

• getInputBlockByPredicate(
      predicate: (block: ParticleInputBlock) => boolean,
  ): Nullable<ParticleInputBlock>

  Get an input block using a predicate

  Parameters

  • predicate: (block: ParticleInputBlock) => boolean

    defines the predicate used to find the good candidate

  Returns Nullable<ParticleInputBlock>

  the required input block or null if not found

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 particle set

  • merge: boolean = false

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

  Returns void

removeBlock

• removeBlock(block: NodeParticleBlock): void

  Remove a block from the current system set

  Parameters

  • block: NodeParticleBlock

    defines the block to remove

  Returns void

serialize

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

  Serializes this node particle set in a JSON representation

  Parameters

  • OptionalselectedBlocks: NodeParticleBlock[]

    defines the list of blocks to save (if null the whole node particle set will be saved)

  Returns any

  the serialized particle system set object

setToDefault

• setToDefault(): void

  Clear the current set and restore it to a default state

  Returns void

StaticCreateDefault

• CreateDefault(name: string): NodeParticleSystemSet

  Creates a new node particle set set to default basic configuration

  Parameters

  • name: string

    defines the name of the particle set

  Returns NodeParticleSystemSet

  a new NodeParticleSystemSet

StaticParse

• Parse(source: any): NodeParticleSystemSet

  Creates a node particle set from parsed data

  Parameters

  • source: any

    defines the JSON representation of the particle set

  Returns NodeParticleSystemSet

  a new node particle set

StaticParseFromFileAsync

• ParseFromFileAsync(
      name: string,
      url: string,
      nodeParticleSet?: NodeParticleSystemSet,
  ): Promise<NodeParticleSystemSet>

  Creates a node particle set from a snippet saved in a remote file

  Parameters

  • name: string

    defines the name of the node particle set to create

  • url: string

    defines the url to load from

  • OptionalnodeParticleSet: NodeParticleSystemSet

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

  Returns Promise<NodeParticleSystemSet>

  a promise that will resolve to the new node particle set

StaticParseFromSnippetAsync

• ParseFromSnippetAsync(
      snippetId: string,
      nodeParticleSet?: NodeParticleSystemSet,
  ): Promise<NodeParticleSystemSet>

  Creates a node particle set from a snippet saved by the node particle editor

  Parameters

  • snippetId: string

    defines the snippet to load

  • OptionalnodeParticleSet: NodeParticleSystemSet

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

  Returns Promise<NodeParticleSystemSet>

  a promise that will resolve to the new node particle set