Class FluidRenderer

constructor

• new FluidRenderer(scene: Scene): FluidRenderer

  Initializes the class

  Parameters

  • scene: Scene

    Scene in which the objects are part of

  Returns FluidRenderer

ReadonlyrenderObjects

ReadonlytargetRenderers

shaderLanguage

• get shaderLanguage(): ShaderLanguage

  Gets the shader language used in this renderer

  Returns ShaderLanguage

addCustomParticles

• addCustomParticles(
      buffers: { [key: string]: FloatArray },
      numParticles: number,
      generateDiffuseTexture?: boolean,
      targetRenderer?: FluidRenderingTargetRenderer,
      camera?: any,
  ): IFluidRenderingRenderObject

  Adds a custom particle set to the fluid renderer.

  Parameters

  • buffers: { [key: string]: FloatArray }

    The list of buffers (should contain at least a "position" buffer!)

  • numParticles: number

    Number of particles in each buffer

  • OptionalgenerateDiffuseTexture: boolean

    True if you want to generate a diffuse texture from buffers and use it as part of the fluid rendering (default: false). For the texture to be generated correctly, you need a "color" buffer in the set!

  • OptionaltargetRenderer: FluidRenderingTargetRenderer

    The target renderer used to display the particle system as a fluid. If not provided, the method will create a new one

  • Optionalcamera: any

    The camera used by the target renderer (if the target renderer is created by the method)

  Returns IFluidRenderingRenderObject

  the render object corresponding to the custom particle set

addParticleSystem

• addParticleSystem(
      ps: IParticleSystem,
      generateDiffuseTexture?: boolean,
      targetRenderer?: FluidRenderingTargetRenderer,
      camera?: any,
  ): IFluidRenderingRenderObject

  Adds a particle system to the fluid renderer.

  Parameters

  • ps: IParticleSystem

    particle system

  • OptionalgenerateDiffuseTexture: boolean

    True if you want to generate a diffuse texture from the particle system and use it as part of the fluid rendering (default: false)

  • OptionaltargetRenderer: FluidRenderingTargetRenderer

    The target renderer used to display the particle system as a fluid. If not provided, the method will create a new one

  • Optionalcamera: any

    The camera used by the target renderer (if the target renderer is created by the method)

  Returns IFluidRenderingRenderObject

  the render object corresponding to the particle system

dispose

• dispose(): void

  Disposes of all the resources used by the class

  Returns void

getRenderObjectFromParticleSystem

• getRenderObjectFromParticleSystem(
      ps: IParticleSystem,
  ): Nullable<IFluidRenderingRenderObject>

  Gets the render object corresponding to a particle system (null if the particle system is not rendered as a fluid)

  Parameters

  • ps: IParticleSystem

    The particle system

  Returns Nullable<IFluidRenderingRenderObject>

  the render object corresponding to this particle system if any, otherwise null

recreate

• recreate(): void

  Reinitializes the class Can be used if you change the object priority (FluidRenderingObject.priority), to make sure the objects are rendered in the right order

  Returns void

removeRenderObject

• removeRenderObject(
      renderObject: IFluidRenderingRenderObject,
      removeUnusedTargetRenderer?: boolean,
  ): boolean

  Removes a render object from the fluid renderer

  Parameters

  • renderObject: IFluidRenderingRenderObject

    the render object to remove

  • removeUnusedTargetRenderer: boolean = true

    True to remove/dispose of the target renderer if it's not used anymore (default: true)

  Returns boolean

  True if the render object has been found and released, else false