SoWinRenderArea Class |
Component for rendering Open Inventor scene graphs.
Namespace: OIV.Inventor.Win
The SoWinRenderArea type exposes the following members.
Name | Description | |
---|---|---|
![]() | SoWinRenderArea | Calls SoWinRenderArea((System.Windows.Forms.Control ^)nullptr, (System.String ^)nullptr, true, true, true). |
![]() | SoWinRenderArea(Control) | Calls SoWinRenderArea(parent, (System.String ^)nullptr, true, true, true). |
![]() | SoWinRenderArea(Control, String) | Calls SoWinRenderArea(parent, name, true, true, true). |
![]() | SoWinRenderArea(Control, String, Boolean) | Calls SoWinRenderArea(parent, name, buildInsideParent, true, true). |
![]() | SoWinRenderArea(Control, String, Boolean, Boolean) | Calls SoWinRenderArea(parent, name, buildInsideParent, getMouseInput, true). |
![]() | SoWinRenderArea(Control, String, Boolean, Boolean, Boolean) | Constructor which is passed arguments which tell it whether to register the mouse and keyboard devices by default (SoWinMouse and SoWinKeyboard). |
Name | Description | |
---|---|---|
![]() ![]() | AddHook |
Adds an event handler that receives all messages dispatched
to this window.
(Inherited from SoWinGLWidget.) |
![]() | BindNormalContext | Makes the normal rendering context the current context. |
![]() | CopyWindowBits | (Inherited from SoWinGLWidget.) |
![]() | Dispose | |
![]() | Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Flush | (Inherited from SoWinGLWidget.) |
![]() | GetAntialiasing | Obsolete. Gets the antialiasing used for rendering. |
![]() | GetAntialiasingMode | Returns the antialiasing mode set using the setAntialiasing(float,AntialiasingMode) method. |
![]() | GetAntialiasingParameters | Returns the antialiasing parameters set using the setAntialiasing(SoAntialiasingParameters*) method. |
![]() | GetAntialiasingQuality | Returns the antialiasing quality set using the setAntialiasing(float,AntialiasingMode) method. |
![]() | GetBackgroundColor | Gets the background color for this window. |
![]() | GetBackgroundIndex | Gets the window background color when in color index mode. |
![]() | GetBorderSize | Included for portability only. |
![]() | GetClassName | Returns the class name. |
![]() | GetCursor | Obsolete. Returns the current cursor. |
![]() ![]() | GetDefaultRedrawPriority | Gets the default priority number of the redraw sensor. |
![]() | GetFastEditSavePolicy | Returns fast editing save policy used when rendering. |
![]() | GetFloatingColorBuffer | Returns true if floating point rendering is used and its precision. |
![]() | GetFullSceneAntialiasing | Obsolete. Returns true if FSAA is currently enabled. |
![]() | GetGLRenderAction | Gets the GL render action to use. |
![]() | GetGraphicConfigTemplate | (Inherited from SoWinGLWidget.) |
![]() | GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
![]() | GetIconTitle | Included for portability only. |
![]() | GetInvalidateCacheMode | Returns the current cache invalidation mode. |
![]() | GetMPEGRecorder | Returns the recorder used for MPEG encoding. |
![]() | GetNormalDC | Returns the device context (which is needed for SbGlContextHelper.makeCurrent). |
![]() | GetNormalSoContext | (Inherited from SoWinGLWidget.) |
![]() | GetOverlayBackgroundIndex | Obsolete. Gets the overlay window background color index. |
![]() | GetOverlayDC | Obsolete. Returns the overlay device context (which is needed for SbGlContextHelper.makeCurrent). |
![]() | GetOverlayGLRenderAction | Obsolete. Gets the GL render action for the overlay window. |
![]() | GetOverlaySceneGraph | Obsolete. Gets the scene graph to be rendered in the overlay plane. |
![]() | GetOverlaySceneManager | Obsolete. Gets the overlay plane scene manager. |
![]() | GetOverlaySoContext | Obsolete. Obsoletesince Open Inventor 9610 Overlay feature is legacy, and no longer makes sense with current hardware. |
![]() | GetPixelFormat | Returns the current pixel format. |
![]() | GetRedrawPriority | Gets the priority of the redraw sensor. |
![]() | GetSceneGraph | Gets the scene graph to be rendered in this component's window. |
![]() | GetSceneManager | Gets the normal scene manager. |
![]() | GetShareContext | |
![]() | GetSize | Convenience routine on the window handle. |
![]() | GetSortedTrianglesNumCaches | Returns the maximum number of caches allowed for the sorted triangles transparency types. |
![]() | GetSortedTrianglesSortFrequency | Returns the sort frequency used for the SORTED_TRIANGLES_XXX and SORTED_OBJECT_TRIANGLES_XXX transparency types. |
![]() | GetTitle | Gets window title. |
![]() | GetTransparencyType | Gets the algorithm for rendering transparent objects. |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetViewportRegion | Gets current viewport region to use for rendering. |
![]() | GetWidgetName | Returns the window handle name. |
![]() | Hide | This hides the component. |
![]() | IsAutoRedraw | Queries whether the render area will automatically redraw whenever something in the scene graph changes. |
![]() | IsBorder | Included for portability only. |
![]() | IsClearBeforeOverlayRender | Obsolete. Queries whether the overlay window will be cleared before rendering starts. |
![]() | IsClearBeforeRender | Queries whether the window will be cleared before rendering starts. |
![]() | IsClearZBufferBeforeRender | Queries whether the depth buffer (sometimes called the Z buffer) will be cleared before rendering starts. |
![]() | IsDoubleBuffer | Returns whether double buffering is on or off. |
![]() | IsDrawToFrontBufferEnable | Returns whether drawing to the front buffer is enabled. |
![]() ![]() | IsFloatingColorBufferSupported | Returns true if floating point rendering is available. |
![]() | IsFsaaSupported | Obsolete. Obsoletesince Open Inventor 8100 Method has been renamed. |
![]() | IsFullSceneAntialiasingAvailable | Obsolete. Returns true if FSAA is supported by current pixel format. |
![]() | IsFullSceneAntialiasingEnabled | Obsolete. Returns true, if full-scene antialiasing (FSAA) is enabled. |
![]() | IsFullSceneAntialiasingHQAvailable | Obsolete. Returns true if high quality full-scene antialiasing (FSAA) is available. |
![]() | IsFullSceneAntialiasingHQEnabled | Obsolete. Returns true if the high quality mode for full-scene antialiasing (FSAA) is enabled. |
![]() | IsFullScreen | Queries if the viewer is in fullscreen mode. |
![]() | IsFullScreenEnable | Queries if it is possible to put the viewer in fullscreen mode. |
![]() | IsTopLevelShell | Returns true if this component is a top level shell component (has its own window). |
![]() | IsVisible | Returns true if this component is mapped onto the screen. |
![]() | MakeNormalCurrent | Obsolete. Makes the normal rendering context the current context. |
![]() | RedrawOnSelectionChange | Call this convenience method to have this render area redraw whenever the selection list changes in the passed node. |
![]() | RedrawOverlayOnSelectionChange | Obsolete. Call this convenience method to have this render area overlay planes redraw whenever the selection list changes in the passed node. |
![]() | RegisterDevice | Registers interest in devices. |
![]() | RemoveHook |
Removes the event handlers that were added by
AddHook.
(Inherited from SoWinGLWidget.) |
![]() | Render | Calling this forces the render area to be redrawn now. |
![]() | RenderOverlay | Obsolete. Calling this forces the render area overlay planes to be redrawn now. |
![]() | SaveSnapshot(String) | Calls SaveSnapshot(filename, true). (Inherited from SoWinGLWidget.) |
![]() | SaveSnapshot(String, Boolean) | Save a snapshot of the current image displayed in the viewer. |
![]() | ScheduleOverlayRedraw | Obsolete. Schedules a redraw of the overlay planes to happen sometime soon (as opposed to immediately). |
![]() | ScheduleRedraw | Schedules a redraw to happen sometime soon (as opposed to immediately). |
![]() | SetAntialiasing(Single) | Calls SetAntialiasing(quality, OIV.Inventor.SoSceneManager.AntialiasingModes( .SoSceneManager.AUTO )). (Inherited from SoWinGLWidget.) |
![]() | SetAntialiasing(SoAntialiasingParameters) | Enable (or disable) antialiasing with specific parameters. |
![]() | SetAntialiasing(Single, SoSceneManagerAntialiasingModes) | Enable (or disable) antialiasing with specified quality and mode. |
![]() | SetAntialiasing(Boolean, Int32) | Obsolete. Enables smoothing and/or multi-pass antialiasing for rendering. |
![]() | SetAutoRedraw | The render area will automatically redraw whenever something in the scene graph changes. |
![]() | SetBackgroundColor | Sets the background color for this window. |
![]() | SetBackgroundIndex | Sets the window background color when in color index mode. |
![]() | SetBorder | Included for portability only. |
![]() | SetClearBeforeOverlayRender | Obsolete. Enables/prevents overlay window clearing from happening before a rendering starts (default is clear true). |
![]() | SetClearBeforeRender(Boolean) | Calls SetClearBeforeRender(trueOrFalse, true). |
![]() | SetClearBeforeRender(Boolean, Boolean) | Enables/prevents window clearing from happening before a rendering starts (default is clear true). |
![]() | SetColorMap | Sets the colors to use when displaying in color index mode. |
![]() | SetCursor | Obsolete. Sets the current cursor. |
![]() | SetDoubleBuffer | Routine that dynamically changes between single and double buffering. |
![]() | SetDrawToFrontBufferEnable | Sets drawing to the front buffer. |
![]() | SetEventCallback(SoWinRenderAreaEventCallback) | Obsolete. |
![]() | SetEventCallback(SoWinRenderAreaEventUserDataCallback, Object) | Obsolete. |
![]() | SetFastEditSavePolicy(SoGLRenderActionFastEditSavePolicies) | Calls SetFastEditSavePolicy(policy, false). |
![]() | SetFastEditSavePolicy(SoGLRenderActionFastEditSavePolicies, Boolean) | Sets fast editing save policy to use when rendering. |
![]() | SetFloatingColorBuffer(Boolean) | Calls SetFloatingColorBuffer(enable, OIV.Inventor.Win.SoWinGLWidget.FloatColorBufferSizes( .SoWinGLWidget.FLOAT_16_COLOR_BUFFER )). |
![]() | SetFloatingColorBuffer(Boolean, SoWinGLWidgetFloatColorBufferSizes) | Enables/disables floating point rendering using 16- or 32-bit components. |
![]() | SetFullSceneAntialiasing(Boolean) | Obsolete. Calls SetFullSceneAntialiasing(enable, -1.0, SoFullSceneAntialiasing.ALL). (Inherited from SoWinGLWidget.) |
![]() | SetFullSceneAntialiasing(Boolean, Single) | Obsolete. Calls SetFullSceneAntialiasing(enable, quality, SoFullSceneAntialiasing.ALL). (Inherited from SoWinGLWidget.) |
![]() | SetFullSceneAntialiasing(Boolean, Single, Int32) | Obsolete. (Inherited from SoWinGLWidget.) |
![]() | SetFullSceneAntialiasingHQ | Obsolete. Enables or disables the high quality mode for full-scene antialiasing (FSAA). |
![]() | SetFullScreen | Switches the viewer into (or out of) fullscreen mode. |
![]() | SetFullScreenEnable | Enables/disables fullscreen mode. |
![]() | SetGLRenderAction | Sets the GL render action to use. |
![]() | SetGraphicConfigTemplate | Sets a new graphics configuration template. |
![]() | SetIconTitle | Included for portability only. |
![]() | SetInvalidateCacheMode | Enables or disables the invalidation of render caches. |
![]() | SetMPEGRecorder | Sets the recorder used for MPEG encoding. |
![]() | SetOverlayBackgroundIndex | Obsolete. Sets the overlay window background color index. |
![]() | SetOverlayColorMap | Obsolete. Sets the colors to use for overlay bit planes. |
![]() | SetOverlayGLRenderAction | Obsolete. Sets the GL render action for the overlay window. |
![]() | SetOverlaySceneGraph | Obsolete. Sets the scene graph to be rendered in the overlay plane. |
![]() | SetOverlaySceneManager | Obsolete. Sets the overlay plane scene manager. |
![]() | SetPixelFormat | Sets the current pixel format. |
![]() | SetPostRenderCallback(SoWinRenderAreaRenderCallback) | Obsolete.
Use PostRenderCallback property instead.
|
![]() | SetPostRenderCallback(SoWinRenderAreaRenderUserDataCallback, Object) | Obsolete. |
![]() | SetRedrawPriority | Sets the priority of the redraw sensor. |
![]() | SetSceneGraph | Sets the scene graph to be rendered in this component's window. |
![]() | SetSceneManager | Sets the normal scene manager. |
![]() | SetSize | Convenience routine on the window handle. |
![]() | SetSortedTrianglesNumCaches | Sets the number of caches to use when the transparency type is SORTED_TRIANGLES_XXX or SORTED_OBJECT_TRIANGLES_XXX. |
![]() | SetSortedTrianglesSortFrequency | This method specifies the angle between each sorting axis when using the transparency type SORTED_TRIANGLES_XXX or SORTED_OBJECT_TRIANGLES_XXX. |
![]() | SetStealFocus | By default the GLWidget "steals" focus whenever the cursor moves over it. |
![]() | SetTitle | Sets window title. |
![]() | SetTransparencyType | Sets the algorithm for rendering transparent objects. |
![]() | SetViewportRegion | Sets viewport region to use for rendering. |
![]() | Show | This shows the component. |
![]() | SwapNormalBuffers | Swaps the normal front and back buffers. |
![]() | SwapOverlayBuffers | Obsolete. Swaps the overlay front and back buffers. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | UnbindNormalContext | unbind the current context (previously bind with bindNormalContext ); |
![]() | UnregisterDevice | Unregisters interest in devices. |
Name | Description | |
---|---|---|
![]() | Cursor | Sets the current cursor. |
![]() | EventFunction |
Sets the event delegate that will be called
before viewer process keyboard or mouse event.
|
![]() | Handle |
Implements Handle.
(Inherited from SoWinComponent.) |
![]() | PostRenderCallback | Specifies a function to be called after the Open Inventor render traversal and immediately before the OpenGL buffer swap. |
![]() | WindowCloseCallback | Sets the delegate to invoke when the user closes this component (double click in the upper left corner) - by default Hide() is called on this component, unless a delegate is specified. |
This class provides Open Inventor rendering and message handling inside a Windows window. There is a routine to specify the scene to render. The scene is automatically rendered whenever anything under it changes (a data sensor is attached to the root of the scene), unless explicitly told not to do so (manual redraws). Users can also set Open Inventor rendering attributes such as the transparency algorithm, antialiasing on or off, etc. This class employs an SoSceneManager to manage rendering and message handling.
Windows messages that occur in the render area can be handled by the application, by the viewer (if this is really a viewer), or by the nodes in the scene graph. When a message occurs, it is first passed to the application message delegate function registered with the setEventCallback() method on SoWinRenderArea. If this function does not exist or returns false, the message is either used directly by the viewer or translated to an SoEvent for further scene graph processing. If the viewer does not handle the message, and an overlay scene graph exists, the SoEvent is sent to that scene graph by way of an SoHandleEventAction. If no node in the overlay scene graph handles the message (i.e., calls setHandled() on the SoHandleEventAction), the SoEvent is passed to the normal scene graph in the same manner.
Overlay rendering:
This class supports overlay rendering on graphics boards with hardware overlay planes, for example NVIDIA Quadro boards. Open Inventor creates a 8 bit indexed overlay context when this option is enabled in the graphics hardware configuration of your system. To render a scene graph in the overlay context just call the setOverlaySceneGraph function.
For Linux based systems you must modify the section display of your Xorg.conf. Add the following lines and restart your X server:
Option "UBB" "1" Option "CIOverlay" "1"
For Microsoft Windows platforms just enable overlay support in the control panel for your graphics board.