SoBackground

InventorModule

genre	View3D
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	SoUtils
definition	utils.def
see also	SoMLLUT, SoLUTEditor

Purpose

The module SoBackground renders a color ramp in the background of an Open Inventor scene. The module uses OpenGL coordinates thus the “Start” color is by default applied in the OpenGL coordinate origin in the bottom-left corner.

The ramp can be flipped (Flip) and rotated 90 degrees (Rotate), allowing to orient the ramp in 4 directions.

A LUT module attached to the scene graph before the SoBackground modifies the color ramp.

The SoBackground module should be one of the first modules in a scene graph, especially if the Depth Buffer field is disabled.

Details

The ramp is drawn as 256 rectangles. All rectangles are always drawn, this will lead to occlusion of rectangles in any image smaller than 256 in the ramp dimension.

Windows

Default Panel

Output Fields

self

name: self, type: SoNode

Parameter Fields

Visible Fields

Rotate

name: rotate, type: Bool, default: TRUE

If checked, the LUT ramp is rotated.

• TRUE: Apply ramp in Y dimension.

• FALSE: Apply ramp in X dimension.

Flip

name: flip, type: Bool, default: FALSE

If checked, the LUT ramp is flipped.

On

name: on, type: Bool, default: TRUE

If checked, the module renders a background in an Open Inventor scene.

Depth Buffer

name: depthBuffer, type: Bool, default: TRUE

If checked, the module uses the depth buffer and draws itself at a very distant depth.

This can be used to render the background without SoBackground being in the front of the scene.