SoFlatScreen Class Reference
[Nodes]

Defines a simple flat screen in a ScaleViz configuration file. More...

#include <ScaleViz/nodes/SoFlatScreen.h>

Inheritance diagram for SoFlatScreen:

List of all members.

Public Types
enum	CameraMode {   MONOSCOPIC,   LEFT_VIEW,   RIGHT_VIEW }
Public Member Functions
virtual SoType	getTypeId () const
	SoFlatScreen ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFVec2f	tileOrigin
SoSFVec2f	tileSize
SoSFVec4f	softEdgeOverlap
SoSFVec4f	softEdgeGamma
SoSFString	view
SoSFVec4f	viewport
SoSFFloat	rightOverlap
SoSFFloat	leftOverlap
SoSFFloat	topOverlap
SoSFFloat	bottomOverlap
SoSFEnum	cameraMode

---

Detailed Description

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

}

---

Member Enumeration Documentation

enum SoFlatScreen::CameraMode

Enumerator:

MONOSCOPIC	Rendering is done for full view (i.e., with unmodified camera).
LEFT_VIEW	Rendering is done for left eye view.
RIGHT_VIEW	Rendering is done for right eye view.

---

Constructor & Destructor Documentation

SoFlatScreen::SoFlatScreen

(

)

Constructor.

---

Member Function Documentation

static SoType SoFlatScreen::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoBaseScreen.

virtual SoType SoFlatScreen::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoBaseScreen.

---

Member Data Documentation

SoSFFloat SoFlatScreen::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.

SoSFEnum SoFlatScreen::cameraMode

Specifies the passive stereo rendering mode.

Use enum CameraMode. Default is MONOSCOPIC.

NOTE: field available since Open Inventor 7.0

SoSFFloat SoFlatScreen::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.

SoSFFloat SoFlatScreen::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.

SoSFVec4f SoFlatScreen::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.

SoSFVec4f SoFlatScreen::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.

SoSFVec2f SoFlatScreen::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.

SoSFVec2f SoFlatScreen::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.

SoSFFloat SoFlatScreen::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.

SoSFString SoFlatScreen::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.

SoSFVec4f SoFlatScreen::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.

---

The documentation for this class was generated from the following file:
• ScaleViz/nodes/SoFlatScreen.h