| SoFlatScreen Class |
Defines a simple flat screen in a ScaleViz configuration file.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.ScaleViz.NodesSoBaseScreen
OIV.ScaleViz.NodesSoFlatScreen
Namespace: OIV.ScaleViz.Nodes
Assembly: OIV.ScaleViz (in OIV.ScaleViz.dll) Version: 9.9.36.0 (9.9.36.0)
SyntaxThe SoFlatScreen type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoFlatScreen | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoNode.) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Inherited from SoNode.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Inherited from SoNode.) |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Inherited from SoNode.) |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | (Inherited from SoNode.) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoNode.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoNode.) |
| RayPick | (Inherited from SoNode.) |
| Search | (Inherited from SoNode.) |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoNode.) |
Properties| Name | Description | |
|---|---|---|
 | bottomOverlap | bottomOverlap modifies the bottom of the MultiPipe window. |
| cameraMode | Specifies the passive stereo rendering mode. |
| channelOrigin | Position of the graphics window on the physical screen. |
| channelSize | Size of the graphics window on the physical screen. |
| display | Name of the X Display to connect to (the Display where this screen should be rendered). |
| hostname | Hostname for current screen. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| leftOverlap | leftOverlap modifies the left side of the MultiPipe window. |
| name | Name of the screen. |
| position | Position of the graphics window on the physical screen. |
| rightOverlap | rightOverlap modifies the right side of the MultiPipe window. |
| size | Size of the graphics window on the physical screen. |
| softEdgeGamma | Specifies the gamma factor for the soft-edge region. |
| softEdgeOverlap | This field specifies the size of the overlap on each side of the graphics window. |
| tileOrigin | This field specifies lower left corner of the rectangular part of the view volume to be rendered on this screen. |
| tileSize | This field specifies the size of the rectangular part of the view volume to be rendered on this screen. |
| topOverlap | topOverlap modifies the top of the MultiPipe window. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
| view | Specifies the portion of the view volume to be rendered on this screen. |
| viewport | Viewport values used to specify the portion of the scene to render within the MultiPipe window. |
RemarksThe 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 |
See Also