Renders a scene graph using OpenGL. More...

#include <Inventor/actions/SoGLRenderAction.h>

Inheritance diagram for SoGLRenderAction:

Public Types
enum	TransparencyType { SCREEN_DOOR, ADD, DELAYED_ADD, SORTED_OBJECT_ADD, BLEND, DELAYED_BLEND, SORTED_OBJECT_BLEND }
	Various levels of transparency rendering quality. More...
enum	AbortCode { CONTINUE, ABORT, PRUNE, DELAY }
	Possible return codes from a render abort callback. More...
typedef AbortCode	SoGLRenderAbortCB (void *userData)
	Callback functions for render abort should be of this type.
Public Member Functions
	SoGLRenderAction (const SbViewportRegion &viewportRegion)
	Constructor.
virtual	~SoGLRenderAction ()
	Destructor.
void	setViewportRegion (const SbViewportRegion &newRegion)
	Changes viewport region to use for rendering.
const SbViewportRegion &	getViewportRegion () const
	Returns viewport region to use for rendering.
void	setUpdateArea (const SbVec2f &origin, const SbVec2f &size)
void	getUpdateArea (SbVec2f &origin, SbVec2f &size) const
	Sets/returns the current update area, which is the rectangular area of the viewport region that will actually be rendered into.
void	setAbortCallback (SoGLRenderAbortCB func, void userData)
	Sets callback to call during rendering to test for an abort condition.
void	setTransparencyType (TransparencyType type)
TransparencyType	getTransparencyType () const
	Sets/returns transparency quality level to use when rendering.
void	setSmoothing (SbBool smooth)
SbBool	isSmoothing () const
	Sets/returns smoothing flag.
void	setNumPasses (int num)
int	getNumPasses () const
	Sets/returns number of rendering passes for multipass rendering.
void	setPassUpdate (SbBool flag)
SbBool	isPassUpdate () const
	Sets/returns a flag indicating whether intermediate results are displayed after each antialiasing pass for progressive improvement (default is FALSE).
void	setPassCallback (SoGLRenderPassCB func, void userData)
	Sets a callback function to invoke between passes when antialiasing.
void	setCacheContext (uint32_t context)
uint32_t	getCacheContext () const
	Sets/returns the OpenGL cache context.
void	setRenderingIsRemote (SbBool flag)
SbBool	getRenderingIsRemote () const
	Sets/gets whether or not "remote" rendering is happening.
virtual void	invalidateState ()
	Invalidate the state, forcing it to be recreated at the next apply.
int	getCurPass () const
	Returns current rendering pass number.
SbBool	abortNow ()
	Returns TRUE if render action should abort - checks user callback.
SbBool	handleTransparency (SbBool isTransparent=FALSE)
	Returns TRUE if render action handles processing of a transparent object (if it is to be sorted and rendered later).
SbBool	isDelaying () const
	Returns TRUE if rendering is being delayed because of transparency sorting or delaying.
void	addDelayedPath (SoPath *path)
	Adds to the list of paths to render after all other stuff (including delayed/sorted transparent objects) have been rendered.
SbBool	isRenderingDelayedPaths () const
	Returns TRUE if currently rendering delayed paths.
int	getCullTestResults ()
void	setCullTestResults (int b)
Static Public Member Functions
static void	initClass ()
Protected Member Functions
virtual void	beginTraversal (SoNode *node)
	Initiates action on graph.

Detailed Description

This class traverses a scene graph and renders it using the OpenGL graphics library. It assumes that a valid window has been created and initialized for proper OpenGL rendering. The SoQtRenderArea class or any of its subclasses may be used to create such a window.

See Also

: SoSeparator, SoQtRenderArea

Definition at line 86 of file SoGLRenderAction.h.

Member Typedef Documentation

typedef AbortCode SoGLRenderAction::SoGLRenderAbortCB(void *userData)

This typedef is defined within the class, since it needs to refer to the AbortCode enumerated type.

Definition at line 114 of file SoGLRenderAction.h.

Member Enumeration Documentation

enum SoGLRenderAction::AbortCode

Enumerator:

CONTINUE	Continue as usual.
ABORT	Stop traversing the rest of the graph.
PRUNE	Do not traverse this node or its children.
DELAY	Delay rendering of this node.

Definition at line 104 of file SoGLRenderAction.h.

enum SoGLRenderAction::TransparencyType

Enumerator:

SCREEN_DOOR	Use GL patterns for screen-door transparency.
ADD	Use additive GL alpha blending.
DELAYED_ADD	Use additive blending, do transp objs last.
SORTED_OBJECT_ADD	Use additive blending, sort objects by bbox.
BLEND	Use GL alpha blending.
DELAYED_BLEND	Use GL alpha blending, do transp objs last.
SORTED_OBJECT_BLEND	Use GL alpha blending, sort objects by bbox.

Definition at line 93 of file SoGLRenderAction.h.

Constructor & Destructor Documentation

SoGLRenderAction::SoGLRenderAction ( const SbViewportRegion & viewportRegion )

The parameter defines the viewport region into which rendering will take place.

virtual SoGLRenderAction::~SoGLRenderAction ( ) [virtual]

Member Function Documentation

SbBool SoGLRenderAction::abortNow ( ) [inline]

Definition at line 215 of file SoGLRenderAction.h.

References SoAction::hasTerminated().

void SoGLRenderAction::addDelayedPath ( SoPath * path )

(Used for annotation nodes.)

virtual void SoGLRenderAction::beginTraversal ( SoNode * node ) [protected, virtual]

Reimplemented from SoAction.

uint32_t SoGLRenderAction::getCacheContext ( ) const

A cache context is just an integer identifying when OpenGL display lists (which are used for render caching) can be shared between render actions.

int SoGLRenderAction::getCullTestResults ( ) [inline]

Definition at line 244 of file SoGLRenderAction.h.

int SoGLRenderAction::getCurPass ( ) const [inline]

Definition at line 212 of file SoGLRenderAction.h.

int SoGLRenderAction::getNumPasses ( ) const [inline]

Specifying more than one pass will result in antialiasing of the rendered scene, using OpenGL's accumulation buffer. (Camera nodes typically move their viewpoints a little bit for each pass to achieve the antialiasing.) Each additional pass provides better antialiasing, but requires more rendering time The default is 1 pass.

Definition at line 175 of file SoGLRenderAction.h.

SbBool SoGLRenderAction::getRenderingIsRemote ( ) const

Inventor's auto-render-caching algorithm will choose to cache more often when rendering is remote (the assumption being that performance will be better with display lists stored on the remote machine). By default, it is assumed rendering is NOT remote.

TransparencyType SoGLRenderAction::getTransparencyType ( ) const [inline]

The default is SCREEN_DOOR. (Note that SCREEN_DOOR transparency does not work in the case where transparency values are specified for each vertex of a shape. If this is the case, use one of the other transparency types.)

Definition at line 158 of file SoGLRenderAction.h.

void SoGLRenderAction::getUpdateArea	(	SbVec2f &	origin,
		SbVec2f &	size
	)		const

This can be used for partial updates in applications that can manage them. The update area is specified in normalized viewport coordinates, where (0,0) is the lower left corner of the viewport and (1,1) is the upper right corner. The area is specified or returned as an origin and a size.

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

Definition at line 128 of file SoGLRenderAction.h.

SbBool SoGLRenderAction::handleTransparency ( SbBool isTransparent = FALSE )

If this returns FALSE, the object should just go ahead and render itself. The optional argument isTransparent ensures that the object being rendered will be taken as transparent, regardless of transparency in the state. If it is false, the state is checked for transparency.

static void SoGLRenderAction::initClass ( ) [static]

Reimplemented from SoAction.

Reimplemented in SoBoxHighlightRenderAction, and SoLineHighlightRenderAction.

virtual void SoGLRenderAction::invalidateState ( ) [virtual]

Reimplemented from SoAction.

SbBool SoGLRenderAction::isDelaying ( ) const [inline]

Definition at line 233 of file SoGLRenderAction.h.

SbBool SoGLRenderAction::isPassUpdate ( ) const [inline]

Definition at line 182 of file SoGLRenderAction.h.

SbBool SoGLRenderAction::isRenderingDelayedPaths ( ) const [inline]

Definition at line 241 of file SoGLRenderAction.h.

SbBool SoGLRenderAction::isSmoothing ( ) const [inline]

When on, smoothing uses OpenGL's line- and point-smoothing features to provide cheap antialiasing of lines and points. The default is FALSE.

Definition at line 165 of file SoGLRenderAction.h.

void SoGLRenderAction::setAbortCallback	(	SoGLRenderAbortCB *	func,
		void *	userData
	)		`[inline]`

It will be called for each node that is traversed. This allows applications to terminate rendering prematurely if some condition occurs. The callback function should return one of the AbortCode codes to indicate whether traversal should continue. Use of the various codes in a callback can allow applications to modify Inventor's default order of rendering objects in a scene graph.

Definition at line 148 of file SoGLRenderAction.h.

void SoGLRenderAction::setCacheContext ( uint32_t context )

See also:: getCacheContext

void SoGLRenderAction::setCullTestResults ( int b ) [inline]

Definition at line 245 of file SoGLRenderAction.h.

void SoGLRenderAction::setNumPasses ( int num ) [inline]

See also:: getNumPasses

Definition at line 168 of file SoGLRenderAction.h.

void SoGLRenderAction::setPassCallback	(	SoGLRenderPassCB *	func,
		void *	userData
	)		`[inline]`

Passing NULL (which is the default state) will cause a clear of the color and depth buffers to be performed.

Definition at line 187 of file SoGLRenderAction.h.

void SoGLRenderAction::setPassUpdate ( SbBool flag ) [inline]

See also:: isPassUpdate

Definition at line 178 of file SoGLRenderAction.h.

void SoGLRenderAction::setRenderingIsRemote ( SbBool flag )

See also:: getRenderingIsRemote

void SoGLRenderAction::setSmoothing ( SbBool smooth )

See also:: getSmoothing

void SoGLRenderAction::setTransparencyType ( TransparencyType type )

See also:: getTransparencyType

void SoGLRenderAction::setUpdateArea	(	const SbVec2f &	origin,
		const SbVec2f &	size
	)

See also:: getUpdateArea

void SoGLRenderAction::setViewportRegion ( const SbViewportRegion & newRegion )

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

MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/actions/SoGLRenderAction.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation