API Docs

Current Voxelent version: 0.90.2. Download it here

vxl

Voxelent Main Namespace

vxl.api

Application Programing Interface namespace.

vxl.c

Voxelent Current Objects

vxl.def

Voxelent Default/Definition Objects

vxl.def.actor

Default values and constants that can be used with the vxlActor class.

vxl.def.camera

Default values for cameras

vxl.def.essl

GLSL constants

vxl.def.interactor

Default values for view interactors

vxl.def.lut

Lookup Table Definitions

vxl.def.material

Default values for vxlMaterial

vxl.def.model

Default values for models

vxl.def.renderer

Default values for renderers

vxl.def.texture

Constants to handle textures

vxl.def.view

Default values for views

vxl.events

Voxelent Events

vxl.go

Voxelent Global Objects

vxl.util

Voxelent Util methods

vxl.version

Voxelent Version

vxlActor

Actors represent models (assets) in a Scene

vxlAxis

Visible three-dimensional system of coordinates

vxlBakeEngine

Implements a basic rendering strategy that works with the following programs: vxl.def.essl.bake TODO: Does not deal with model scalars well.

vxlBoundingBox

Cuboid that encloses the visible extent of a vxlScene

vxlCamera

Determines which region of the scene will be visible to the user.

vxlCameraManager

The camera manager is responsible for controlling the cameras associated with a view

vxlCell

Provides cell definitions

vxlCellPickerInteractor

Interactor that implements a picking mechanism.

vxlEngine

Defines the behaviour of a rendering engine

vxlExternalEngine

Enables customized rendering strategies

vxlFloor

Visible grid that sets the floor reference and its extension

vxlFrameAnimation

Manages a frame-to-frame animation

vxlLambertProgram

Defines a Lambert shading program in ESSL

vxlLandmark

Stores the camera state so it can be retrieved later

vxlLookupTable

Contains a mapping between scalars and a color palette

vxlLookupTableManager

Manages the lookup tables

vxlMaterial

Material associated to an actor

vxlMesh

Provides cell by cell operations on models

vxlModel

Represents a geometric object.

vxlModelManager

Controls the loading and network transfer of models into memory

vxlNotifier

Hub for the publish-subscribe mechanism among Voxelent entities

vxlPhongProgram

Defines a Phong shading program in ESSL

vxlPicker

Picking in voxelent is based on colors.

vxlPickerInteractor

Interactor that implements a picking mechanism.

vxlProgram

Represents the ESSL source code of each program

vxlRenderable

A Renderable is an intermediary object between an actor and the rendering strategy that allows rendering very complex models.

vxlRenderEngine

Voxelent default rendering engine

vxlRendererException

Encapsulates a renderer exception

vxlSceneToys

Manages the axis, the bounding box and the floorThese are auxiliary objects or 'toys'

vxlTexture

A vxlTexture is a representation of a raster image in Voxelent.

vxlTrackerInteractor

Determines the application behaviour originated by mouse and keyboard events.

vxlTransforms

Encapsulates the matrices required to perform 3D rendering

vxlView

the class that manages what it is rendered the HTML5 canvas on the web page

vxlVTKReader

Reads VTK files (ASCII) and creates JSON objects that can be used as models