com.openinventor.scaleviz.nodes

Class SoFlatScreen

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.inventor.nodes.SoNode

com.openinventor.scaleviz.nodes.SoBaseScreen

com.openinventor.scaleviz.nodes.SoFlatScreen

All Implemented Interfaces:

SafeDisposable

public class SoFlatScreen
extends SoBaseScreen

Defines a simple flat screen in a ScaleViz configuration file. The SoFlatScreen node is used in a ScaleViz configuration file. SoFlatScreen nodes provide a simple way of defining a display that is basically a very large desktop. The entire display configuration is treated as a single "logical" viewport, allowing the application's existing 2D interaction techniques to work as usual.

SoFlatScreen fields describe the portion of the view volume that will be rendered and where it will be rendered on the physical screen, as well as which render node will be used (for cluster rendering).

This class is used in both Cluster mode and MultiPipe mode, but different fields are used in each mode, as follows:

In MultiPipe mode there are two different ways to set the portion of the view volume to render: view and viewport values. Views are convenient keywords (e.g., NONE, LEFT, RIGHT...) that ScaleViz will interpret to compute the viewport values. Using viewport values is a more general and flexible way to describe the portion of the view volume to render.

In Cluster mode, use tileOrigin and tileSize to set the portion of the view volume to render, and use channelOrigin and channelSize to specify where it will be rendered on the physical screen.

File format/default:

FlatScreen {

channelOrigin	0.0 0.0
channelSize	1.0 1.0
tileOrigin	0.0 0.0
tileSize	1.0 1.0
softEdgeOverlap	0 0 0 0
softEdgeGamma	0 0 0 0
view	"NONE"
viewport	-1.0 -1.0 -1.0 -1.0
rightOverlap	0.0
leftOverlap	0.0
topOverlap	0.0
bottomOverlap	0.0
display	":0"
name	"screen"
hostname	"localhost"
position	-1.0 -1.0
size	-1.0 -1.0
cameraMode	MONOSCOPIC

}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoFlatScreen.CameraModes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFFloat	bottomOverlap bottomOverlap modifies the bottom of the MultiPipe window.
SoSFEnum<SoFlatScreen.CameraModes>	cameraMode Specifies the passive stereo rendering mode.
static int	LEFT_VIEW Deprecated. Use SoFlatScreen.CameraModes.LEFT_VIEW instead.
SoSFFloat	leftOverlap leftOverlap modifies the left side of the MultiPipe window.
static int	MONOSCOPIC Deprecated. Use SoFlatScreen.CameraModes.MONOSCOPIC instead.
static int	RIGHT_VIEW Deprecated. Use SoFlatScreen.CameraModes.RIGHT_VIEW instead.
SoSFFloat	rightOverlap rightOverlap modifies the right side of the MultiPipe window.
SoSFVec4f	softEdgeGamma Specifies the gamma factor for the soft-edge region.
SoSFVec4f	softEdgeOverlap This field specifies the size of the overlap on each side of the graphics window.
SoSFVec2f	tileOrigin This field specifies lower left corner of the rectangular part of the view volume to be rendered on this screen.
SoSFVec2f	tileSize This field specifies the size of the rectangular part of the view volume to be rendered on this screen.
SoSFFloat	topOverlap topOverlap modifies the top of the MultiPipe window.
SoSFString	view Specifies the portion of the view volume to be rendered on this screen.
SoSFVec4f	viewport Viewport values used to specify the portion of the scene to render within the MultiPipe window.

Fields inherited from class com.openinventor.scaleviz.nodes.SoBaseScreen

channelOrigin, channelSize, display, hostname, name, position, size

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoFlatScreen() Constructor.

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MONOSCOPIC

@Deprecated
public static final int MONOSCOPIC

Deprecated. Use SoFlatScreen.CameraModes.MONOSCOPIC instead.

LEFT_VIEW

@Deprecated
public static final int LEFT_VIEW

Deprecated. Use SoFlatScreen.CameraModes.LEFT_VIEW instead.

RIGHT_VIEW

@Deprecated
public static final int RIGHT_VIEW

Deprecated. Use SoFlatScreen.CameraModes.RIGHT_VIEW instead.

tileOrigin

public final SoSFVec2f tileOrigin

This field specifies lower left corner of the rectangular part of the view volume to be rendered on this screen. The origin can be any point between (0,0) and (1,1). Here (0,0) denotes the lower left corner of the view volume.

Cluster mode only, not used in MultiPipe mode. For MultiPipe mode, use the view or viewport field.

tileSize

public final SoSFVec2f tileSize

This field specifies the size of the rectangular part of the view volume to be rendered on this screen. The size can be a value between (0,0) and (1,1).

Cluster mode only, not used in MultiPipe mode. For MultiPipe mode, use the view or viewport field.

softEdgeOverlap

public final SoSFVec4f softEdgeOverlap

This field specifies the size of the overlap on each side of the graphics window. Values are positive for positive overlap, i.e., for extending the rendering. If values are between 0 and 1.0, they are interpreted as the soft-edge region on the left, right, bottom, and top border of the screen relative to the total width or height of the screen. If values are greater than 1.0 they are interpreted as pixels.

Cluster mode only, not used in MultiPipe mode. For MultiPipe mode, use the xxxOverlap fields.

softEdgeGamma

public final SoSFVec4f softEdgeGamma

Specifies the gamma factor for the soft-edge region. The gamma factor determines how the fading from full intensity to black is done. A gamma factor of one means a linear transition in terms of RGB values. For most projectors, gamma values bigger than 1 are required to achieve good results.

view

public final SoSFString view

Specifies the portion of the view volume to be rendered on this screen. Valid choices are LEFT, CENTER, RIGHT, TOP, BOTTOM, TOP_RIGHT, TOP_LEFT, BOTTOM_RIGHT, BOTTOM_LEFT, NONE (default), STEREO_RIGHT, and STEREO_LEFT. If view and viewport are both specified (not recommended), viewport takes precedence.

MultiPipe mode only, not used in Cluster mode. For Cluster mode, use the tileOrigin and tileSize fields.

viewport

public final SoSFVec4f viewport

Viewport values used to specify the portion of the scene to render within the MultiPipe window. (0,0) is the lower-left corner of the virtual viewport. The values are minX, minY, maxX, maxY. The viewport values range from 0.0 to 1.0. If view and viewport are both specified (not recommended), viewport takes precedence.

MultiPipe mode only, not used in Cluster mode. For Cluster mode, use the tileOrigin and tileSize fields.

rightOverlap

public final SoSFFloat rightOverlap

rightOverlap modifies the right side of the MultiPipe window. It modifies the right limit of the viewport of the region of the scene (that is rendered in this MP window). Valid range for values is 0..1.

MultiPipe mode only, not used in Cluster mode. For Cluster mode use the softEdgeOverlap field.

leftOverlap

public final SoSFFloat leftOverlap

leftOverlap modifies the left side of the MultiPipe window. It modifies the left limit of the viewport of the region of the scene (that is rendered in this MP window). Valid range for values is 0..1.

MultiPipe mode only, not used in Cluster mode. For Cluster mode use the softEdgeOverlap field.

topOverlap

public final SoSFFloat topOverlap

topOverlap modifies the top of the MultiPipe window. It modifies the top limit of the viewport of the region of the scene (that is rendered in this MP window). Valid range for values is 0..1.

MultiPipe mode only, not used in Cluster mode. For Cluster mode use the softEdgeOverlap field.

bottomOverlap

public final SoSFFloat bottomOverlap

bottomOverlap modifies the bottom of the MultiPipe window. It modifies the bottom of the viewport of the region of the scene (that is rendered in this MP window). Valid range for values is 0..1.

MultiPipe mode only, not used in Cluster mode. For Cluster mode use the softEdgeOverlap field.

cameraMode

public final SoSFEnum<SoFlatScreen.CameraModes> cameraMode

Specifies the passive stereo rendering mode. Use enum CameraMode. Default is MONOSCOPIC.

Since:

Open Inventor 7.0

Constructor Detail

SoFlatScreen

public SoFlatScreen()

Constructor.