View Section


Summary

View Section Items

Camera Translate Item
Camera Rotate Item
Camera Orbit Item
Outline Color Item
Preset View Item
Fog Mode Item
View Mode Item
Field of View Item
Clipping Plane Item
Line Width Item
Shading Item
Bin Palette Select Item
Bin Palette Map Item
Bin Palette Min Max Item
Bin Palette Type Item
Lighting Item
Light Item
Ambient Light Item
Diffuse Light Item
Background Light Item
Gamma Item
Specular Item
Fog Item
Wireframe Item
Outlines Item

Two Sided Item
Transparent Item
Bin Palette Item
Antialias Item
Opaque Wireframe Item


View Section Items

Camera Translate Item (VCAM_TRANS tag)

This item translates the camera in the scene in scene coordinates. It can either be relative the current camera position, or be an absolute position. An absolute position could be treated as a relative translation from the origin.

Format:

unsigned char = <VRELATIVE | VRELATIVE>
float [3] = (x, y, z)

Camera Rotate Item (VCAM_ROTATE tag)

This item rotates the camera in the scene. It can either be relative the current camera rotation, or be an absolute rotation. An absolute rotation could be treated as a relative rotation from the camera aim (0, 0, -1) and camera up (0, 1, 0). The rotation is specified by an angle in degrees, followed by a vector about which it should rotate in a counterclockwise fashion. If either the angle or all the vector coordinates are 0's, then no rotation will occur.

Format:

unsigned char = <VRELATIVE | VRELATIVE>
float [4] = (theta, x, y, z)

Camera Orbit Item (VCAM_ORBIT tag)

This item orbits the camera around the objects in the scene. It can either be relative the current camera orbit, or be an absolute orbit. An absolute orbit could be treated as a relative rotation from the camera aim (0, 0, -1) and camera up (0, 1, 0) while at the origin. The orbit is specified by an angle in degrees, followed by a vector about which it should orbit in a counterclockwise fashion. If either the angle or all the vector coordinates are 0's, then no rotation will occur.

Format:

unsigned char = <VRELATIVE | VRELATIVE>
float [4] = (theta, x, y, z)

Outline Color Item (VOUTLINE_CLR tag)

This item changes the outline color. It takes 3 floats for colors, and each of those floats are capped to the range [0, 1].

Format:

float [3] = (R, G, B)

Preset View Item (VPRESET_VIEW tag)

This item does the same functionality as pressing the number keys. The distance the camera is away from the center of the object is: objectSize / (2 * tan(FOV / 2)) where objectSize is defined as being the diagonal length of the object's bounding box. If an undefined preset view is requested, then the last requested view is restored.

Format:

unsigned char = preset view

Fog Mode Item (VFOG_MODE tag)

Applies the fog effect to either the environment or the object.

Format:

unsigned char = < VFOG_OBJECT | VFOG_ENVIROMENT >

View Mode Item (VVIEW_MODE tag)

This item specifies whether to use orthogonal view or perspective view.

Format:

unsigned char = <VORHTO | VPERSPECTIVE>

Field of View Item (VFOV tag)

This item changes the field of view (in degrees). It is capped to the range [1, 179].

Format:

float = FOV

Clipping Plane Item (VCLIP_PLANE tag)

This item changes the clipping plane. There are two different clipping planes; one for orthogonal, and one for perspective. Orthogonal is specified in the fractional part of the object to show, e.g., 1 shows everything, and 0.5 would cut off half the object. Perspective is specified in object sizes away from the camera, e.g., if the value is 4, then everything closer than 4 object sizes to the camera would be clipped, and anything farther would be visible. The object's size is defined as being the diagonal length of the object's bounding box. The clipping plane that is being changed is dependent on which view mode is selected.

Format:

float = clipping plane

Line Width Item (VLINE_WIDTH tag)

This item changes the line width of all outlines.

Format:

unsigned char = line width

Shading Item (VSHADING tag)

This item chooses either smooth or flat shading to render the scene. Smooth shading takes longer to render since all normals are taken into account to give the effect of smoothed surfaces, and multiple vertex colors can be used in the process. Flat shading only takes into account the first defined normal and color of each shape, and uses that to define how light will be reflected off it, making the surface to appear flat.

Format:

unsigned char = <VFLAT | VSMOOTH>

Bin Palette Select Item (VBIN_PAL_SEL tag)

This item selects which bin window palette to use. The entire unsigned char range is valid. If an unused palette is selected, and the scene is rendered with bin window on, bin window will be turned off, and the scene will be rendered normally.

Format:

unsigned char = bin window palette number

Bin Palette Map Item (VBIN_PAL_MAP tag)

This item creates/changes/deletes bin window palettes. This command does not have an interactive counterpart. This item can select any palette to operate on (the entire unsigned char range is valid). If it is an unused palette, and colors are requested to be saved, a new palette will be created with those colors; if no colors are requested, then nothing happens. If a used palette is selected, and colors are requested to be saved, that palette will be replaced with the requested one; if no colors are requested, then that palette will be deleted. Colors are in the RGB colorspace, and are defined by floats capped to the range [0, 1]. When defining the map, all colors to map from must be described first, then all the colors to map to. Colors to map to must always be present.

Format:

unsigned char = bin window palette number
unsigned int = color count (number of RGB triplet pairs)
float [3][color count] = colors to map from
float [3][color count] = colors to map to

Bin Palette Min Max Item (VBIN_PAL_MIN_MAX tag)

This item corresponds to the lowest and highest float values on the palette. example: palette may be a temperature scale (min 0 deg C, max 200 deg C)

Format
float = lower bound of bin palette range
float = upper bound of bin palette range

Bin Palette Type Item (VBIN_PAL_TYPE tag)

This string represents the units for the corresponding float values. example: palette may be a temperature scale (units of Kelvins or Celcius)

Format:
a string of chars (byte)
'\0' terminating char

Lighting Item (VLIGHTING tag)

This item turns lighting on and off.

Format:

unsigned char = <VOFF | VON>

Light Item (VLIGHT tag)

This item turns the diffuse light on and off.

Format:

unsigned char = <VOFF | VON>

Ambient Light Item (VAMB_LIGHT tag)

This item changes the intensity of the ambient light. It is capped to be >= 0.

Format:

float = intensity

Diffuse Light Item (VDIFF_LIGHT tag)

This item changes the intensity of the diffuse light. It is capped to be >= 0.

Format:

float = intensity

Background Light Item (VBG_LIGHT tag)

This item changes the intensity of the background light. It is capped to the range [0, 1].

Format:

float = intensity

Gamma Item (VGAMMA and VGAMMA_LEVEL tag)

Toggles gamma lighting on or off
This item adjusts the gamma curve of the image (some detail is lost in the process). It is capped to the range [0.1, 10].

Format:    

float = gamma         (VGAMMA_LEVEL)
unsigned char = < VON|VOFF >   (VGAMMA)

Specular Item (VSPECULAR_LEVEL tag)

Sets the specular light level. Useful values range between [0.1, 25]

Format: 

float = specular

Fog Item (VFOG_LEVEL and VFOG tag)

When the fog property is on, a linear decaying fog effect is produced with the same colour as the background's.

Format:

float = fog density      (fog level)
unsigned char = <VOFF | VON>   (vfog tag)

Wireframe Item (VWIREFRAME tag)

This item turns on and off wireframe view.

Format:

unsigned char = <VOFF | VON>

Outlines Item (VOUTLINES tag)

This item turns on and off outlines.

Format:

unsigned char = <VOFF | VON>

Two Sided Item (VTWO_SIDED tag)

This item turns on and off two-sided view.

Format:

unsigned char = <VOFF | VON>

Transparent Item (VTRANSPARENT tag)

This item turns on and off transparency.

Format:

unsigned char = <VOFF | VON>

Bin Palette Item (VBIN_PAL tag)

This item turns on and off binned palette.

Format:

unsigned char = <VOFF | VON>

Antialias Item (VANTIALIAS tag)

This item turns on and off antialiasing.

Format:

unsigned char = <VOFF | VON>

Opaque Wireframe Item (VOPAQUE_WIRE tag)

In wireframe mode only, all normal surfaces are painted with the same colour as the background.

unsigned char = <VOFF | VON>










.