Packages - thothbot/parallax GitHub Wiki

Parallax packages

Parallax divided into few main packages.

images/modules.jpg

core

This is the main Parallax package. Usage is described on the Creating a new applicaion.

In the GWT configuration file add the following:


<inherits name="thothbot.parallax.core.Core"/>

  • core.client - contains code which can be launched on the client side only. For example, Canvas3d.
  • core.resources - contains css, images and other resources, used by client code.
  • core.shared - contains code which is independent from side of launching.

loader

Contains API to load external 3D objects which are saved in COLLADA and three.js JSON formats.

To use three.js JSON file you should use Blender export script.

To use loaders in your project you should import this package in the GWT configuration file:


<inherits name="thothbot.parallax.loader.Loader"/>

JSON loader uses GWT AutoBean. GWT 2.4 requires to import additional java package gwt-servlet-deps.jar in your project.

To do this:

  • Copy gwt-servlet-deps.jar from GWT SDK installation folder to war/WEB-INF/lib in your project.
  • Import that jar into project's build path. Go to Build path -> Configure Build path... -> Libraries -> Add external JARs

plugins

Here are different WebGL renderer plugins, which will be described separately.

To use plugins in your project you should import necessary plugin's package in the GWT configuration file:


<inherits name="thothbot.parallax.plugins.postprocessing.Postprocessing"/>
<inherits name="thothbot.parallax.plugins.lensflare.LensFlare"/>
<inherits name="thothbot.parallax.plugins.sprite.Sprite"/>

Or you can use one of the effects


<inherits name="thothbot.parallax.plugins.effects.Effects"/>