Options
All
  • Public
  • Public/Protected
  • All
Menu

Defines the base object used for fluid rendering. It is based on a list of vertices (particles)

Hierarchy

Index

Constructors

  • Instantiates a fluid rendering object

    Parameters

    • scene: Scene

      The scene the object is part of

    Returns FluidRenderingObject

Properties

onParticleSizeChanged: Observable<FluidRenderingObject>

Observable triggered when the size of the particle is changed

particleThicknessAlpha: number

Defines the alpha value of a particle

priority: number

Defines the priority of the object. Objects will be rendered in ascending order of priority

Accessors

  • Gets the index buffer (or null if the object is using instancing)

    Returns Nullable<DataBuffer>

  • get numParticles(): number
  • Gets the number of particles (vertices) of this object

    Returns number

    The number of particles

  • get particleSize(): number
  • set particleSize(size: number): void
  • Gets or sets the size of the particle

    Returns number

  • Gets or sets the size of the particle

    Parameters

    • size: number

    Returns void

  • get useInstancing(): boolean
  • Indicates if the object uses instancing or not

    Returns boolean

  • get useVelocity(): boolean
  • set useVelocity(use: boolean): void
  • Indicates if velocity of particles should be used when rendering the object. The vertex buffer set must contain a "velocity" buffer for this to work!

    Returns boolean

  • Indicates if velocity of particles should be used when rendering the object. The vertex buffer set must contain a "velocity" buffer for this to work!

    Parameters

    • use: boolean

    Returns void

  • get vertexBuffers(): {}
  • Gets the vertex buffers

    Returns {}

Methods

  • dispose(): void
  • Releases the ressources used by the class

    Returns void

  • getClassName(): string
  • Gets the name of the class

    Returns string

  • isReady(): boolean
  • Indicates if the object is ready to be rendered

    Returns boolean

    True if everything is ready for the object to be rendered, otherwise false

  • renderDepthTexture(): void
  • Render the depth texture for this object

    Returns void

  • renderDiffuseTexture(): void
  • Render the diffuse texture for this object

    Returns void

  • renderThicknessTexture(): void
  • Render the thickness texture for this object

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Property
  • Method
  • Static method

Settings

Theme