Documentation

Readme

Changes

License (GPL)

 

Applet Parameters

 

RubikPlayer

Applet Parameters

The form below shows all parameters supported by the RubikPlayer applet. Change the values of the form and click at 'Generate HTML Code' to generate the HTML code that is required to embed the Applet in your web page.

Generated HTML code to be inserted into your HTML page:

 

 

Applet Parameters:

   
scriptLanguage

The language (notation) of the script. (see here for more details):
Choice of: "BandelowENG", "HarrisENG", "RandelshoferGER", "ScriptFRA", "SupersetENG", "TouchardDeledicqFRA", "Castella".
Default value: "SupersetENG"

 
scriptType

The type of the script.
A "Generator" transforms the cube from a source state to a target state. The source state of a generator is the initial state of the cube.
A "Solver" also transforms the cube from a source state to a target state. The source state is the initial state of the cube transformed by the inverse of the script.
Choice of: "Generator", "Solver"
Default value: "Generator"
Tip: Use generators to describe pretty patterns, use solvers to describe maneuvers.

 
script

The script.
Default value: no script.

 
scriptProgress

Position of the progress bar. Positive values are offsets from the start of the script, negative values are offsets from the end of the script.
Range: -9999..9999
Default value: -1 for generators, 0 for solvers, 0 when autoPlay is set to true.

 
initScript

An initScript is used to set up the initial position of the cube.
If you don't specify an initScript, the solved state of the cube is used.

Default value: no script

 
displayLines

Number of lines of the script to display.
Set to 0 to switch the display off.
Default value: 1
 

autoPlay

Turns automatic playback of the script on or off.
Values: true, false
Default value: false
colorTable

RGB color look up table. The colors in this table can be referenced by the faces and the stickers attribute. The table may contain up to 54 different values.
The default values represent the colors of the Arxon cube: blue, orange, white, green, red and yellow.
This results into the following color scheme:

   5     
 4   0   1   3 
   2     

Range: 0x000000..0xffffff
Default value: 0x003373,0xff4600,0xf8f8f8,0x00732f,0x8c000f,0xffd200

Tip: For ease of use, you can assign names to the colors.
Instead of writing 0x003373 you can write blue=0x003373 or b=0x003373.

 
faces

Maps colors from the color table to the faces of the cube.
6 integer values: front, right, down, back, left, up.
The values of the faces parameter are overriden by the stickers parameter if present.
Range: 0..54
Default value: 0,1,2,3,4,5

The face values are organized like this:

   5     
 4   0   1   3 
   2     

Tip: You can reference a color defined in "colorsTable" by its index or by its name.
 
stickersFront
stickersRight
stickersDown
stickersBack
stickersLeft
stickersUp

The stickers parameters map colors from the color table to the stickers of the cube;
25 integer values for each of the 6 faces: front, right, down, back, left, up.
The stickers parameters override the values of the faces parameter.

Default Values

Front:  0,0,0,0,0,0,0,0,0
Right: 1,1,1,1,1,1,1,1,1
Down:  2,2,2,2,2,2,2,2,2
Back: 3,3,3,3,3,3,3,3,3
Left: 4,4,4,4,4,4,4,4,4
Up: 5,5,5,5,5,5,5,5,5


 

The sticker values are organized like this:

Up: 1 2 3            
      4 5 6            
Left 7 8 9 Right Back
1 2 3 1 2 3 1 2 3 1 2 3
4 5 6 4 5 6 4 5 6 4 5 6
7 8 9 7 8 9 7 8 9 7 8 9
      1 2 3            
      4 5 6            
Down: 7 8 9            

Tip: You can reference a color defined in "colorsTable" by its index or by its name.
backgroundColor

Specifies the background color of the applet.
Range: 0x000000..0xffffff
Default value: 0xffffff

 
backgroundImage

Specifies the url of the background image.
Default value: no background image

 
alpha

Alpha view angle of the cube. Tilts the cube along the X-axis. Positive values tilt in clockwise direction, negative values in anticlockwise direction.
Range: -90..90
Default value: -25

 
beta

Beta view angle of the cube. Tilts the cube along the Y-axis. Positive values tilt in clockwise direction, negative values in anticlockwise direction.
Range: -90..90
Default value: 45
ambientLightIntensity

Specifies the intensity of the ambient light.
Range: 0.0..1.0
Default value: 0.6

 
lightSourceIntensity

Specifies the intensity of the light source.
Range: 0.0..1.0
Default value: 1.0

 
lightSourceLocation

Specifies the location of the light source using a right-handed X, Y, Z coordinate system. +X is horizontal to the right, +Y is the local gravitational up, +Z is directly toward the viewer.
Values: X, Y, Z
Default value: -500, 500, 1000
rearView

Turns rear view on or off.
Values: true, false
Default value: false

 
rearViewBackgroundColor

Background color of the rear view.
Range: 0x00000 (black) .. 0xffffff (white)
Default value: undefined (uses value of parameter backgroundColor)

 
rearViewBackgroundImage

Specifies the URL of the background image for the rear view.
Default value: undefined (uses value of parameter backgroundImage)

 
rearViewScaleFactor

Specifies the scale factor of the rear view relative to the front view.
Range: 0.1..1.0
Default value: 0.75
rearViewRotation

Specifies the rotation of the rear view along the X, Y and Z axis in degrees.
Values: X, Y, Z
Default value: 180, 0, 0