SoBaseScreen Class Reference
[Nodes]
Abstract base class for all screen classes used in a ScaleViz configuration file.
More...
#include <ScaleViz/nodes/SoBaseScreen.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoBaseScreen () | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Public Attributes | |
| SoSFString | display |
| SoSFString | name |
| SoSFString | hostname |
| SoSFVec2f | position |
| SoSFVec2f | size |
| SoSFVec2f | channelOrigin |
| SoSFVec2f | channelSize |
Detailed Description
Abstract base class for all screen classes used in a ScaleViz configuration file.
SoBaseScreen is the base class for ScaleViz screen descriptions and settings.
SoBaseScreen cannot be used directly in a configuration file, but its derived classes (SoScreen and SoFlatScreen) are used in a ScaleViz configuration file.
The SoBaseScreen derived classes are used in Cluster mode and MultiPipe mode. But note that some fields are only used in Cluster mode (e.g., hostname) and some fields are only used in MultiPipe mode (e.g., position).
FILE FORMAT/DEFAULT
- BaseScreen {
- ScaleViz/nodes/SoBaseScreen.h
| display | ":0" |
| name | "screen" |
| hostname | "localhost" |
| position | -1.0 -1.0 |
| size | -1.0 -1.0 |
| channelOrigin | 0.0 0.0 |
| channelSize | 1.0 1.0 |
Constructor & Destructor Documentation
| SoBaseScreen::SoBaseScreen | ( | ) |
Constructor.
Member Function Documentation
| static SoType SoBaseScreen::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoNode.
Reimplemented in SoDepthComposer, SoFlatScreen, SoScreen, and SoTileComposer.
| virtual SoType SoBaseScreen::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoNode.
Reimplemented in SoDepthComposer, SoFlatScreen, SoScreen, and SoTileComposer.
Member Data Documentation
Position of the graphics window on the physical screen.
Specifies the position of the upper left corner of the graphics window. 0,0 is always the upper left corner of the desktop. If the values are in the range [0.0, 1.0], they are interpreted as a fraction of the size of the display, where 1,1 is the lower right corner of the desktop. If values are greater than 1.0, they are interpreted as pixels and the lower right corner of the desktop depends on the display resolution.
Cluster mode only, not used in MultiPipe mode. For MultiPipe mode, see SoBaseScreen::position.
Size of the graphics window on the physical screen.
If the values are in the range [0.0, 1.0], they are interpreted as a fraction of the size of the display, where the size of the whole desktop is 1,1. If the values are greater than 1.0 they are interpreted as pixels and the maximum value depends on the display resolution.
Cluster mode only, not used in MultiPipe mode. For MultiPipe mode, see SoBaseScreen::size.
Name of the X Display to connect to (the Display where this screen should be rendered).
The default value is ":0". The display can specify a non-local machine simply by writing the field value in the form "machine:display", e.g., "node2:0.0". Note that IP addresses are also supported. This field is not used on Windows.
Hostname for current screen.
In a cluster configuration, the hostname specifies which node of the graphics cluster should render this screen. Hostname can either be specified as a name (machine name without or with full domain name information) or as a numeric IP address.
Cluster mode only, not used in MultiPipe mode.
Name of the screen.
Does not affect rendering, but can be used to make configuration files more readable.
Position of the graphics window on the physical screen.
Specifies the position of the upper left corner of the graphics window. 0,0 is always the upper left corner of the desktop. If the values are in the range [0.0, 1.0], they are interpreted as a fraction of the size of the display, where 1,1 is the lower right corner of the desktop. If values are greater than 1.0 they are interpreted as pixels and the lower right corner of the desktop depends on the display resolution.
MultiPipe mode only, not used in Cluster mode. For Cluster mode, use the SoFlatScreen::channelOrigin field.
Size of the graphics window on the physical screen.
If the values are in the range [0.0, 1.0], they are interpreted as a fraction of the size of the display, where the size of the whole desktop is 1,1. If the values are greater than 1.0 they are interpreted as pixels and the maximum value depends on the display resolution.
If no size is specified, the window will be set to full screen.
MultiPipe mode only, not used in Cluster mode. For Cluster mode, use the SoFlatScreen::channelSize field.
The documentation for this class was generated from the following file: