SoWinRenderArea Class Reference
[Win]

VSG extension Component for rendering Open Inventor scene graphs. More...

#include <Inventor/Win/SoWinRenderArea.h>

Inheritance diagram for SoWinRenderArea:
SoWinGLWidget SoWinComponent SoWinViewer SoWinFullViewer SoWinConstrainedViewer SoWinExaminerViewer SoWinPlaneViewer SoWinFlyViewer SoWinWalkViewer

List of all members.

Public Member Functions

 SoWinRenderArea (SoWidget parent=NULL, const char *name=NULL, SbBool buildInsideParent=TRUE, SbBool getMouseInput=TRUE, SbBool getKeyboardInput=TRUE)
 ~SoWinRenderArea ()
virtual void setSceneGraph (SoNode *newScene)
virtual SoNodegetSceneGraph ()
void registerDevice (SoWinDevice *d)
void unregisterDevice (SoWinDevice *d)
void setBackgroundColor (const SbColor &c)
SbColor getBackgroundColor () const
void setBackgroundIndex (int index)
int getBackgroundIndex () const
void setColorMap (int startIndex, int num, const SbColor *colors)
void setViewportRegion (const SbViewportRegion &newRegion)
const SbViewportRegiongetViewportRegion () const
void setTransparencyType (SoGLRenderAction::TransparencyType type)
SoGLRenderAction::TransparencyType getTransparencyType () const
void setFastEditSavePolicy (SoGLRenderAction::FastEditSavePolicy policy, SbBool fastEditDelayedObjects=FALSE)
SoGLRenderAction::FastEditSavePolicy getFastEditSavePolicy () const
void setInvalidateCacheMode (SoGLRenderAction::InvalidateCacheMode icm)
SoGLRenderAction::InvalidateCacheMode getInvalidateCacheMode ()
void setClearBeforeRender (SbBool trueOrFalse, SbBool zbTrueOrFalse=TRUE)
SbBool isClearBeforeRender () const
SbBool isClearZBufferBeforeRender () const
void setAutoRedraw (SbBool trueOrFalse)
SbBool isAutoRedraw () const
void setRedrawPriority (unsigned long priority)
unsigned long getRedrawPriority () const
void render ()
void scheduleRedraw ()
void redrawOnSelectionChange (SoSelection *s)
void setEventCallback (SoWinRenderAreaEventCB *fcn, void *userData=NULL)
void setSceneManager (SoSceneManager *sm)
SoSceneManagergetSceneManager () const
void setGLRenderAction (SoGLRenderAction *ra)
SoGLRenderActiongetGLRenderAction () const
const SbGLShareContext getShareContext ()
void setPostRenderCallback (SoWinRenderAreaRenderCB *fcn, void *userData=NULL)
SoWinRenderAreaRenderCBgetPostRenderCallback (const void *&userData) const
void setFloatingColorBuffer (SbBool enable, FloatColorBufferSize size=FLOAT_16_COLOR_BUFFER)
void getFloatingColorBuffer (SbBool &enable, FloatColorBufferSize &size)
void sendEvent (XAnyEvent *anEvent)
virtual void setMPEGRecorder (SoMPEGRenderer *recorder)
virtual SoMPEGRenderergetMPEGRecorder () const

Static Public Member Functions

static unsigned long getDefaultRedrawPriority ()
static SbBool isFloatingColorBufferSupported ()

Detailed Description

VSG extension Component for rendering Open Inventor scene graphs.

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 callback 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, the SoEvent is sent to the scene graph by way of an SoHandleEventAction.

SEE ALSO

SoWinGLWidget, SoWinComponent, SoWinViewer, SoSceneManager, SoBoxHighlightRenderAction, SoHaloHighlightRenderAction, SoLineHighlightRenderAction


Constructor & Destructor Documentation

SoWinRenderArea::SoWinRenderArea ( SoWidget  parent = NULL,
const char *  name = NULL,
SbBool  buildInsideParent = TRUE,
SbBool  getMouseInput = TRUE,
SbBool  getKeyboardInput = TRUE 
)

Constructor which is passed arguments which tell it whether to register the mouse and keyboard devices by default (SoWinMouse and SoWinKeyboard).

NOTES

    On Windows, the constructor will not create a new top level window -- you must pass a valid window handle for the parent parameter and pass TRUE for buildInsideParent .

SoWinRenderArea::~SoWinRenderArea (  ) 

Destructor.


Member Function Documentation

SbColor SoWinRenderArea::getBackgroundColor (  )  const [inline]

Gets the background color for this window.

int SoWinRenderArea::getBackgroundIndex (  )  const [inline]

Gets the window background color when in color index mode.

static unsigned long SoWinRenderArea::getDefaultRedrawPriority (  )  [inline, static]

Gets the default priority number of the redraw sensor.

SoGLRenderAction::FastEditSavePolicy SoWinRenderArea::getFastEditSavePolicy (  )  const [inline]

Returns fast editing save policy used when rendering.

void SoWinRenderArea::getFloatingColorBuffer ( SbBool enable,
FloatColorBufferSize size 
) [virtual]

Returns TRUE if floating point rendering is used and its precision.

Reimplemented from SoWinGLWidget.

SoGLRenderAction* SoWinRenderArea::getGLRenderAction (  )  const [inline]

Gets the current GL render action.

SoGLRenderAction::InvalidateCacheMode SoWinRenderArea::getInvalidateCacheMode (  ) 

Returns the current cache invalidation mode.

virtual SoMPEGRenderer* SoWinRenderArea::getMPEGRecorder (  )  const [inline, virtual]

Returns the recorder used for MPEG encoding.

SoWinRenderAreaRenderCB* SoWinRenderArea::getPostRenderCallback ( const void *&  userData  )  const [inline]

Gets the post-render callback function and data.

Returns NULL if no callback has been specified by the application.

unsigned long SoWinRenderArea::getRedrawPriority (  )  const [inline]

Gets the priority of the redraw sensor.

virtual SoNode* SoWinRenderArea::getSceneGraph (  )  [virtual]

Gets the scene graph to be rendered in this component's window.

Reimplemented in SoWinViewer.

SoSceneManager* SoWinRenderArea::getSceneManager (  )  const [inline]

Gets the normal scene manager.

Note: For convenience most of the SoSceneManager methods have already been added to this class.

const SbGLShareContext SoWinRenderArea::getShareContext (  ) 

Returns the information needed to make OpenGL render contexts share OpenGL objects, for example, display lists and texture objects.

SoGLRenderAction::TransparencyType SoWinRenderArea::getTransparencyType (  )  const [inline]

Gets the algorithm for rendering transparent objects.

See SoGLRenderAction for possible transparency types.

const SbViewportRegion& SoWinRenderArea::getViewportRegion (  )  const [inline]

Gets current viewport region to use for rendering.

SbBool SoWinRenderArea::isAutoRedraw (  )  const [inline]

Queries whether the render area will automatically redraw whenever something in the scene graph changes.

SbBool SoWinRenderArea::isClearBeforeRender (  )  const [inline]

Queries whether the window will be cleared before rendering starts.

SbBool SoWinRenderArea::isClearZBufferBeforeRender (  )  const [inline]

Queries whether the depth buffer (sometimes called the Z buffer) will be cleared before rendering starts.

static SbBool SoWinRenderArea::isFloatingColorBufferSupported (  )  [static]

Returns TRUE if floating point rendering is available.

void SoWinRenderArea::redrawOnSelectionChange ( SoSelection s  ) 

Call this convenience method to have this render area redraw whenever the selection list changes in the passed node.

This is useful if using a highlight render action like the SoHaloHighlightRenderAction to correctly render whenever the selection changes. Pass NULL to turn this off.

This call increases the ref counter of the given SoSelection node, it will be automatically decreased when the selection node is replaced by another one, or if it is turned off.

void SoWinRenderArea::registerDevice ( SoWinDevice d  ) 

Registers interest in devices.

When a device is registered, messages from that device will be processed by the render area, and passed into the scene graph. Messages from unregistered devices will be ignored.

void SoWinRenderArea::render (  )  [inline]

Calling this forces the render area to be redrawn now.

It is not necessary to call this method if auto redraw is enabled (which is the default).

void SoWinRenderArea::scheduleRedraw (  ) 

Schedules a redraw to happen sometime soon (as opposed to immediately).

This can be used to compress multiple redraws.

void SoWinRenderArea::sendEvent ( XAnyEvent *  anEvent  ) 

Sends the event to be processed by the renderArea.

void SoWinRenderArea::setAutoRedraw ( SbBool  trueOrFalse  ) 

The render area will automatically redraw whenever something in the scene graph changes.

Passing FALSE will disable this feature. NOTE: the render area will always redraw in response to window system events (e.g. resize, exposure) regardless of the setting of the auto redraw flag.

void SoWinRenderArea::setBackgroundColor ( const SbColor c  ) 

Sets the background color for this window.

Default is black (0,0,0).

The default value can be set using the environment variable OIV_BACKGROUND_COLOR (3 floats representing RGB values of the colors separated by space).

void SoWinRenderArea::setBackgroundIndex ( int  index  )  [inline]

Sets the window background color when in color index mode.

Default is black (index 0)).

void SoWinRenderArea::setClearBeforeRender ( SbBool  trueOrFalse,
SbBool  zbTrueOrFalse = TRUE 
) [inline]

Enables/prevents window clearing from happening before a rendering starts (default is clear TRUE).

This can be useful to limit flickering when doing single buffering and geometry covers the entire window (used in the material editor). Also controls whether the depth buffer (sometimes called the Z buffer) is cleared before rendering.

void SoWinRenderArea::setColorMap ( int  startIndex,
int  num,
const SbColor colors 
)

Sets the colors to use when displaying in color index mode.

This will load the color map with the given colors at the starting index.

void SoWinRenderArea::setEventCallback ( SoWinRenderAreaEventCB fcn,
void *  userData = NULL 
)

Windows messages which occur in the render area window are either directly handled by the viewer (when this is really a viewer) or automatically translated to SoEvents, then passed into the scene graph (via the SoHandleEventAction) so that live scene graph objects can handle the message (when viewers are not in viewing mode).

This method allows the application to register a callback for handling messages that occur in the window, instead of sending them to the viewers or down the graph. The callback is passed the Windows message, and should return TRUE if it handled the message. In this case the message will not be handled by the viewer and will not be sent to the scene graph. If the callback returns FALSE, then the message will be handled by the view and/or sent to the scene graph.

The following Windows events are sent to setEventCallback:

  • WM_LBUTTONDOWN
  • WM_MBUTTONDOWN
  • WM_RBUTTONDOWN
  • WM_LBUTTONUP
  • WM_MBUTTONUP
  • WM_RBUTTONUP
  • WM_MOUSEMOVE
  • WM_MOUSEWHEEL
  • WM_LBUTTONDBLCLK
  • WM_MBUTTONDBLCLK
  • WM_RBUTTONDBLCLK
  • WM_SETFOCUS
  • WM_KILLFOCUS
  • WM_COMMAND
  • WM_KEYDOWN
  • WM_SYSKEYDOWN
  • WM_KEYUP
  • WM_SYSKEYUP
  • WM_SIZE
  • WM_PAINT
void SoWinRenderArea::setFastEditSavePolicy ( SoGLRenderAction::FastEditSavePolicy  policy,
SbBool  fastEditDelayedObjects = FALSE 
)

Sets fast editing save policy to use when rendering.

The default is WHEN_NEEDED. Valid values are DISABLE, EACH_FRAME, and WHEN_NEEDED. See SoSeparator.

If fastEditDelayedObjects is set to TRUE, delayed objects won't be redrawn when editing the scene graph. It means that composition between delayed transparent objects and fast edit scene graph won't be correct but redrawing may be much faster. Default is FALSE.

void SoWinRenderArea::setFloatingColorBuffer ( SbBool  enable,
FloatColorBufferSize  size = FLOAT_16_COLOR_BUFFER 
) [virtual]

Enables/disables floating point rendering using 16- or 32-bit components. If TRUE, Open Inventor will automatically render to an offscreen floating point buffer, and copy the resulting image to the screen.To determine if floating point rendering was successfully enabled, use getFloatingColorBuffer, below.Using floating point rendering can improve image quality, particularly when many objects are being blended, for example, in volume rendering. This is a convenience method as you could accomplish the same results setting up a graphic template.

Reimplemented from SoWinGLWidget.

void SoWinRenderArea::setGLRenderAction ( SoGLRenderAction ra  ) 

Sets the GL render action to use.

This is used for example to set selection highlighting with the SoBoxHighlightRenderAction, SoHaloHighlightRenderAction and SoLineHighlightRenderAction classes.

Note: Properties of the previous render action, for example transparency type, are not automatically copied to the new render action. The application must explicitly set the desired properties of the new render action.

void SoWinRenderArea::setInvalidateCacheMode ( SoGLRenderAction::InvalidateCacheMode  icm  ) 

Enables or disables the invalidation of render caches.

  • When set to ALWAYS, the caches are invalidated for each SoSeparator node before its children are traversed. No new caches will be built. This value forces all nodes to be visited during each render traversal.
  • When set to ONCE, the caches are invalidated for each SoSeparator node before its children are traversed. The invalidate cache mode is automatically changed to OFF at the end of the traversal.
  • When set to OFF (default), caches are managed by their respective render caching nodes in the usual way.

This method is useful to force all nodes to be visited during render traversal.

virtual void SoWinRenderArea::setMPEGRecorder ( SoMPEGRenderer recorder  )  [inline, virtual]

Sets the recorder used for MPEG encoding.

Default is none.

Parameters:
recorder the recorder to be used.
void SoWinRenderArea::setPostRenderCallback ( SoWinRenderAreaRenderCB fcn,
void *  userData = NULL 
) [inline]

Specifies a function to be called after the Open Inventor render traversal and immediately before the OpenGL buffer swap.

Generally the application should not modify Open Inventor state in these callbacks, but they can be useful for special effects using OpenGL calls.

When the callback function is called, Open Inventor has completed normal rendering (including delayed transparent objects, multi-pass, etc), but no "end of frame" calls (glFlush, glFinish, SwapBuffers...) have been made. The function should return TRUE if "end of frame" handling has been done by the application (Open Inventor will do nothing in this case). If FALSE is returned, Open Inventor will do its normal end of frame calls (normally calling SwapBuffers).

void SoWinRenderArea::setRedrawPriority ( unsigned long  priority  )  [inline]

Sets the priority of the redraw sensor.

virtual void SoWinRenderArea::setSceneGraph ( SoNode newScene  )  [virtual]

Sets the scene graph to be rendered in this component's window.

Reimplemented in SoWinViewer.

void SoWinRenderArea::setSceneManager ( SoSceneManager sm  ) 

Sets the normal scene manager.

Note: For convenience most of the SoSceneManager methods have already been added to this class.

void SoWinRenderArea::setTransparencyType ( SoGLRenderAction::TransparencyType  type  ) 

Sets the algorithm for rendering transparent objects.

Default is NO_SORT. See SoGLRenderAction for possible transparency types. See also SoGLRenderAction::TransparencyType.

Note: When using OPAQUE_FIRST, SORTED_OBJECT or SORTED_PIXEL transparency, the depth buffer is not updated (depth buffer writes are disabled) while rendering transparent objects. As a result complex 3D shapes may not be rendered correctly.

void SoWinRenderArea::setViewportRegion ( const SbViewportRegion newRegion  )  [inline]

Sets viewport region to use for rendering.

void SoWinRenderArea::unregisterDevice ( SoWinDevice d  ) 

Unregisters interest in devices.

When a device is registered, messages from that device will be processed by the render area, and passed into the scene graph. Messages from unregistered devices will be ignored.


The documentation for this class was generated from the following file:

Open Inventor Toolkit reference manual, generated on 12 Nov 2020
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/