API Docs for:
Show:

LS.Draw Class

Defined in: ../src/render/draw.js:5
Module: LS

LS.Draw allows to render basic primitives, similar to the OpenGL Fixed pipeline. It reuses local meshes when possible to avoid fragmenting the VRAM.

Constructor

LS.Draw

()

Defined in ../src/render/draw.js:5

Methods

createSurfaceShader

(
  • surface_function
  • macros
  • uniforms
)
GL.Shader

Defined in ../src/render/draw.js:304

A helper to create shaders when you only want to specify some basic shading

Parameters:

  • surface_function String

    GLSL code like: "vec4 surface_function( vec3 pos, vec3 normal, vec2 coord ) { return vec4(1.0); } ";

  • macros Object

    [optional] object containing the macros and value

  • uniforms Object

    [optional] object with name and type

Returns:

GL.Shader:

the resulting shader

identity

()

Defined in ../src/render/draw.js:1364

clears the transform matrix setting it to an identity

init

()

Defined in ../src/render/draw.js:21

Sets up everything (prepare meshes, shaders, and so)

lookAt

(
  • position
  • target
  • up
)

Defined in ../src/render/draw.js:1437

moves an object to a given position and forces it to look to another direction Warning: it doesnt changes the camera in any way, only the transform matrix

Parameters:

  • position Vec3
  • target Vec3
  • up Vec3

multMatrix

(
  • matrix
)

Defined in ../src/render/draw.js:511

Multiplies the current matrix by a given one

Parameters:

  • matrix Mat4

project

(
  • position
  • dest
)
Vec3

Defined in ../src/render/draw.js:1462

projects a point from 3D space to 2D space (multiply by MVP)

Parameters:

  • position Vec3
  • dest Vec3

    [optional]

Returns:

Vec3:

the point in screen space (in normalized coordinates)

push

()

Defined in ../src/render/draw.js:1337

pushes the transform matrix into the stack to save the state

push

()

Defined in ../src/render/draw.js:1352

takes the matrix from the top position of the stack to restore the last saved state

renderCircle

(
  • radius
  • segments
  • in_z
  • filled
)

Defined in ../src/render/draw.js:711

Renders a circle

Parameters:

  • radius Number
  • segments Number
  • in_z Boolean

    [optional] if the circle is aligned with the z plane

  • filled Boolean

    [optional] renders the interior

renderCone

(
  • radius
  • height
  • segments
  • in_z
)

Defined in ../src/render/draw.js:957

Renders a cone

Parameters:

  • radius Number
  • height Number
  • segments Number
  • in_z Boolean

    aligned with z axis

renderCylinder

(
  • radius
  • height
  • segments
  • in_z
)

Defined in ../src/render/draw.js:994

Renders a cylinder

Parameters:

  • radius Number
  • height Number
  • segments Number
  • in_z Boolean

    aligned with z axis

renderGrid

(
  • dist
  • num
)

Defined in ../src/render/draw.js:921

Renders a grid of lines

Parameters:

  • dist Number

    distance between lines

  • num Number

    number of lines

renderImage

(
  • position
  • image
  • size
  • fixed_size
)

Defined in ../src/render/draw.js:1008

Renders an image

Parameters:

  • position Vec3
  • image Image | Texture | String

    from an URL, or a texture

  • size Number

    [optional=10]

  • fixed_size Boolean

    [optional=false] (camera distance do not affect size)

renderLines

(
  • points
  • colors
  • strip
  • loop
)

Defined in ../src/render/draw.js:521

Render lines given a set of points

Parameters:

  • points Float32Array | Array
  • colors Float32Array | Array

    [optional]

  • strip Bool

    [optional] if the lines are a line strip (one consecutive line)

  • loop Bool

    [optional] if strip, close loop

renderMesh

(
  • mesh
  • primitive
  • indices
  • range_start
  • range_length
)

Defined in ../src/render/draw.js:1074

Renders a given mesh applyting the stack transformations

Parameters:

  • mesh GL.Mesh
  • primitive Enum

    [optional=gl.TRIANGLES] GL.TRIANGLES, gl.LINES, gl.POINTS, ...

  • indices String

    [optional="triangles"] the name of the buffer in the mesh with the indices

  • range_start Number

    [optional] in case of rendering a range, the start primitive

  • range_length Number

    [optional] in case of rendering a range, the number of primitives

renderMeshesInstanced

(
  • mesh
  • matrices
  • primitive
  • indices
)

Defined in ../src/render/draw.js:1120

Renders several meshes in one draw call, keep in mind the shader and the browser should support instancing

Parameters:

  • mesh GL.Mesh
  • matrices Array

    an array containing all the matrices

  • primitive Enum

    [optional=gl.TRIANGLES] GL.TRIANGLES, gl.LINES, gl.POINTS, ...

  • indices String

    [optional="triangles"] the name of the buffer in the mesh with the indices

renderPlane

(
  • position
  • size
  • texture
  • shader
)

Defined in ../src/render/draw.js:874

Renders a solid plane (could be textured or even with an specific shader)

Parameters:

  • position Vec3
  • size Vec2
  • texture GL.Texture
  • shader GL.Shader

renderPoints

(
  • points
  • colors
  • shader
)

Defined in ../src/render/draw.js:550

Render points given a set of positions (and colors)

Parameters:

  • points Float32Array | Array
  • colors Float32Array | Array

    [optional]

  • shader GL.Shader

    [optional]

renderPointsWithSize

(
  • points
  • colors
  • sizes
  • texture
  • shader
)

Defined in ../src/render/draw.js:616

Render points with color, size, and texture binded in 0

Parameters:

  • points Float32Array | Array
  • colors Float32Array | Array

    [optional]

  • sizes Float32Array | Array

    [optional]

  • texture GL.Texture

    [optional]

  • shader GL.Shader

    [optional]

renderRectangle

(
  • width
  • height
  • in_z
)

Defined in ../src/render/draw.js:664

Render a wireframe rectangle of width x height

Parameters:

  • width Number
  • height Number
  • in_z Boolean

    [optional] if the plane is aligned with the z plane

renderRoundPoints

(
  • points
  • colors
  • shader
)

Defined in ../src/render/draw.js:586

Render round points given a set of positions (and colors)

Parameters:

  • points Float32Array | Array
  • colors Float32Array | Array

    [optional]

  • shader GL.Shader

    [optional]

renderSolidBox

(
  • sizex
  • sizey
  • sizez
)

Defined in ../src/render/draw.js:841

Renders a solid box

Parameters:

  • sizex Number
  • sizey Number
  • sizez Number

renderSolidCircle

(
  • radius
  • segments
  • in_z
)

Defined in ../src/render/draw.js:725

Render a filled circle

Parameters:

  • radius Number
  • segments Number
  • in_z Boolean

    [optional] if the circle is aligned with the z plane

renderSolidCube

(
  • size
)

Defined in ../src/render/draw.js:864

Renders a solid cube of size size

Parameters:

  • size Number

renderSolidSphere

(
  • radius
)

Defined in ../src/render/draw.js:783

Renders an sphere

Parameters:

  • radius Number

renderText

(
  • text
  • position
)

Defined in ../src/render/draw.js:1169

Renders a text in 3D, in the XY plane, using the current matrix position

Parameters:

  • text String
  • position Vec3

    [optional] 3D coordinate in relation to matrix

renderWireBox

(
  • sizex
  • sizey
  • sizez
)

Defined in ../src/render/draw.js:815

Renders a wire box (box made of lines, not filled)

Parameters:

  • sizex Number
  • sizey Number
  • sizez Number

renderWireCube

(
  • size
)

Defined in ../src/render/draw.js:854

Renders a wire cube of size size

Parameters:

  • size Number

renderWireSphere

(
  • radius
  • segments
)

Defined in ../src/render/draw.js:771

Renders three circles to form a simple spherical shape

Parameters:

  • radius Number
  • segments Number

reset

()

Defined in ../src/render/draw.js:363

clears the stack

rotate

(
  • angle
  • x
  • y
  • z
)

Defined in ../src/render/draw.js:1417

applies a translation to the transform matrix

Parameters:

  • angle Number

    in degrees

  • x Number | Vec3

    could be the x component or the full axis

  • y Number
  • z Number

scale

(
  • x
  • y
  • z
)

Defined in ../src/render/draw.js:1373

changes the scale of the transform matrix. The parameters could be a vec3, a single number (then the scale is uniform in all axis) or three numbers

Parameters:

  • x Vec3 | Array | Number

    could be an array of 3, one value (if no other values are specified then it is an uniform scaling)

  • y Number
  • z Number

setAlpha

(
  • alpha
)

Defined in ../src/render/draw.js:409

Sets the alpha used to paint primitives

Parameters:

  • alpha Number

setCamera

(
  • camera
)

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

Sets the camera to use during the rendering, this is already done by LS.Renderer

Parameters:

  • camera LS.Camera

setCameraPosition

(
  • center
)

Defined in ../src/render/draw.js:462

Specifies the camera position (used to compute point size)

Parameters:

  • center Vec3

setColor

(
  • color
)

Defined in ../src/render/draw.js:389

Sets the color used to paint primitives

Parameters:

  • color Vec3 | Vec4

setLineWidth

(
  • v
)

Defined in ../src/render/draw.js:432

Sets the line width

Parameters:

  • v Number

    width in pixels

setMatrix

(
  • matrix
)

Defined in ../src/render/draw.js:501

Specifies the transformation matrix to apply to the mesh

Parameters:

  • matrix Mat4

setPointSize

(
  • v
  • perspective
)

Defined in ../src/render/draw.js:419

Sets the point size

Parameters:

  • v Number

    size of points

  • perspective Number

    [optional] if set to true, the points will be affected by perspective

setViewProjectionMatrix

(
  • view
  • projection
  • vp
)

Defined in ../src/render/draw.js:484

Specifies the camera view and projection matrices

Parameters:

  • view Mat4
  • projection Mat4
  • vp Mat4

    viewprojection matrix [optional]

translate

(
  • x
  • y
  • z
)

Defined in ../src/render/draw.js:1398

applies a translation to the transform matrix

Parameters:

  • x Vec3 | Number

    could be an array of 3 or the x transform

  • y Number
  • z Number