SceneOrbiter Class |
The SceneOrbiter is an extension of the SceneInteractor node that provides camera and headlight manipulations like panning, zooming and orbiting similar to the classic Open Inventor "Examiner" viewer classes (e.g. SoWinExaminerViewer) and the SceneExaminer (in Orbit navigation mode).
Preview Feature: this class is fully supported and can be used in Open Inventor applications. Being tagged as a Preview Feature just means that the implementation is still subject to API changes and adjustments based on feedback from early adopters. Please be also aware that source compatibility might be broken regardless of the Open Inventor compatibility changes policy due to our commitment to bring needed changes to be sure the specifications of this Preview Feature match the expectations of our customers.
Namespace: OIV.Inventor.ViewerComponents.Nodes
The SceneOrbiter type exposes the following members.
Name | Description | |
---|---|---|
SceneOrbiter |
Default constructor.
|
Name | Description | |
---|---|---|
AddChild | Adds a child as last one in group. | |
AdjustClippingPlanes |
Adjust near and far clipping planes to minimize clipping of objects in the
scene. This adjustment, based on the bounding box of the scene, ensures
that shapes will not be clipped and also that depth buffer precision is
maximized. This method should be called before each render traversal.
(Inherited from SceneInteractor.) | |
AffectsState | Returns true if a node has an effect on the state during traversal. | |
Callback | (Inherited from SoSeparator.) | |
ClearCacheList | (Inherited from SoSeparator.) | |
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 SoSeparator.) | |
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. | |
FindChild | Finds index of given child within group. | |
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 SoSeparator.) | |
GetChild | Returns pointer the child node with the given index. | |
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 SoSeparator.) | |
GetName | Returns the name of an instance. | |
GetNumChildren | Returns number of children. | |
GetPrimitiveCount | (Inherited from SoSeparator.) | |
GetRenderEngineMode |
This override is mandatory to specify the custom node's render
engine mode. If not overridden, a warning message will be displayed.
(Inherited from SceneInteractor.) | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetStringName | (Inherited from SoBase.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GLRender | (Inherited from SoSeparator.) | |
GLRenderBelowPath | (Inherited from SoSeparator.) | |
GLRenderInPath | (Inherited from SoSeparator.) | |
GLRenderOffPath | (Inherited from SoSeparator.) | |
GrabEventsCleanup | (Inherited from SoNode.) | |
GrabEventsSetup | (Inherited from SoNode.) | |
HandleEvent | (Inherited from SoSeparator.) | |
HasDefaultValues | Returns true if all of the object's fields have their default values. | |
InsertChild | Adds a child so that it becomes the one with the given index. | |
IsBoundingBoxIgnoring | Used by BoundingBoxAction to known if bounding box computation should be ignored or not. | |
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 SoGroup.) | |
RayPick | (Inherited from SoSeparator.) | |
RemoveAllChildren | Removes all children from group. | |
RemoveChild(Int32) | Removes child with given index from group. | |
RemoveChild(SoNode) | Removes first instance of given child from group. | |
ReplaceChild(Int32, SoNode) | Replaces child with given index with new child. | |
ReplaceChild(SoNode, SoNode) | Replaces first instance of given child with new child. | |
Search | (Inherited from SoSeparator.) | |
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. | |
ViewAll |
Set the camera to view all the scene.
(Inherited from SceneInteractor.) | |
ViewAxis |
Moves the camera to be aligned with the given direction vector while
keeping the "up" direction of the camera parallel to the specified up
vector.
(Inherited from SceneInteractor.) | |
Write | (Inherited from SoGroup.) |
Name | Description | |
---|---|---|
boundingBoxCaching | (Inherited from SoSeparator.) | |
boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. | |
Camera |
Gets the current camera.
(Inherited from SceneInteractor.) | |
CameraInteractor |
Gets the current camera interactor.
(Inherited from SceneInteractor.) | |
CameraMode |
Gets/sets the camera mode.
(Inherited from SceneInteractor.) | |
ConstraintLevel |
Gets/sets the constraint level to limit the turntable rotation.
| |
fastEditing | Specifies the fast edit mode of the separator node. | |
HeadlightEnabled |
Enables/Disables the headlight.
(Inherited from SceneInteractor.) | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
pickCulling | Whether to cull during picking traversal. | |
renderCaching | Obsolete. Whether to cache during rendering traversal. | |
renderCulling | Whether to cull during rendering traversal. | |
renderUnitId | Used during the ScaleViz depth compositing process, this field specifies which render unit (OIRU) will render the sub scene graph below this separator. | |
RotationMethod |
Gets/sets the scene rotation method. Default is TURNTABLE.
| |
UpAxis |
Gets/sets the up axis of the scene. Default is Y.
Note that the up axis of the viewing cube is synchronized with the up axis of the SceneOrbiter.
| |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) | |
ViewingCube |
Gets viewing cube.
| |
ViewingCubeEnabled |
Enables/disables viewing cube. Default is true.
|
The SceneOrbiter provides a "mode-less" viewer that is very convenient for users. The Examiner viewer and SceneExaminer viewers are always in either viewing mode (mouse events control the camera) or in selection mode (mouse events are sent to the scene graph and objects can be selected). This often requires the user to frequently switch between viewing and selection mode (for example by pressing the ESC key) while interacting with the scene. SceneOrbiter does not have modes. For example, a mouse click without moving the mouse is interpreted as a selection and the event is sent to the scene graph, but a mouse click and "drag" is interpreted as controlling the camera.
The SceneOrbiter provides two different methods to control the rotation of the camera around the scene : trackball and turntable, see SceneOrbiterRotationMethods enum. The trackball method lets the camera move along any circular orbit around the scene and look in the direction of its center.The orbit orientation can change at any time while interpreting a mouse drag.Thus the trackball is known as an unconstrained orbiting mode. The trackball is the unique method used by the historical examiner viewer and by the SceneExaminer. The additional turntable method is a more constrained orbiting mode.It lets the camera move only along vertical orbits such as the earth meridians, and along horizontal circles such as the earth parallels.The vertical orbits and horizontal circles are related to an up axis, that can be changed with UpAxis property. The horizontal circles are centered around this up axis, and the vertical orbits share their south and north pole on this up axis. As the camera cannot move along any other circle, this mode is more constrained compared to the trackball mode. However that gives a more natural navigation experience when viewing scene that has strong vertical and horizontal references.For instance, when orbiting in turntable mode around a scene representing the Eiffel tower, this one looks always vertical on your screen.Compared to the trackball mode, the turntable mode does not need any tedious small mouse move correction to keep the scene well aligned to the borders of the screen.
The 'headlight', an SoDirectionalLight node, is automatically aligned with the camera's view direction. An SoViewingCube node is automatically added to the scene. The viewing cube can be hidden by changing value of the ViewingCubeEnabled property. Note that the up axis of the viewing cube is synchronized with the up axis of the SceneOrbiter. See parent class SceneInteractor for more details about the structure of the internal scene graph.
The SceneOrbiter uses an instance of SoCameraInteractor in order to manipulate the camera in response to OpenInventor events.
Notes:
Usage: