API Docs for:
Show:

LS.RenderInstance Class

Defined in: ../src/render/renderInstance.js:2
Module: LS

RenderInstance contains info of one object to be rendered on the scene. It shouldnt contain ids to resources (strings), instead if must contain the direct reference (to mesh, material)

Constructor

LS.RenderInstance

()

Defined in ../src/render/renderInstance.js:2

Methods

applyTransform

(
  • matrix
  • normal_matrix
)

Defined in ../src/render/renderInstance.js:120

applies a transformation to the current matrix

Parameters:

  • matrix Mat4
  • normal_matrix Mat4

    [optional]

computeNormalMatrix

()

Defined in ../src/render/renderInstance.js:101

Updates the normal matrix using the matrix

enableFlag

(
  • flag
)
Boolean

Defined in ../src/render/renderInstance.js:249

Tells if a flag is enabled

Parameters:

  • flag Number

    id

Returns:

Boolean:

flag value

enableFlag

(
  • flag
)

Defined in ../src/render/renderInstance.js:238

Disable flag in the flag bit field

Parameters:

  • flag Number

    id

enableFlag

(
  • flag
)

Defined in ../src/render/renderInstance.js:227

Enable flag in the flag bit field

Parameters:

  • flag Number

    id

render

(
  • shader
)

Defined in ../src/render/renderInstance.js:283

Calls render taking into account primitive and range

Parameters:

  • shader Shader

setBoundinbBox

(
  • bbox
)

Defined in ../src/render/renderInstance.js:203

Sets the object oriented bounding box using the BBox format (usually is the mesh bounding but in some cases could be different like with skinning or submeshes)

Parameters:

  • bbox BBox

    bounding in bbox format

setRange

(
  • start
  • length
)

Defined in ../src/render/renderInstance.js:214

specifies the rendering range for the mesh (from where and how many primitives), if -1 then ignored

Parameters:

  • start Number
  • length Number

update

()

Defined in ../src/render/renderInstance.js:271

Used to update the RI info without having to go through the collectData process, it is faster but some changes may take a while

updateAABB

()

Defined in ../src/render/renderInstance.js:261

Computes the instance bounding box in world space from the one in local space

wasVisibleByCamera

(
  • camera
)
Boolean

Defined in ../src/render/renderInstance.js:446

Checks if this object was visible by a camera during the last frame

Parameters:

  • camera LS.Camera

    [optional] if a camera is supplied it checks if it was visible by that camera, otherwise tells you if it was visible by any camera

Returns:

Boolean:

true if it was visible by the camera (or any camera if no camera supplied), false otherwise