A class that performs rendering in the GLWindow. More...

#include <renderer.h>

Inheritance diagram for VAPoR::Renderer:

Public Member Functions
	Renderer (GLWindow vw, RenderParams rp, string name)

virtual	~Renderer ()

virtual void	initializeGL ()=0

virtual void	paintGL ()=0
	All OpenGL rendering is performed in the pure virtual paintGL method. More...

virtual void	setRenderParams (RenderParams *rp)

RenderParams *	getRenderParams ()

bool	isInitialized ()

void	setBypass (int timestep)

void	setPartialBypass (int timestep)

void	setAllBypass (bool val)

bool	doBypass (int timestep)

bool	doAlwaysBypass (int timestep)

virtual void	setAllDataDirty ()=0

Public Member Functions inherited from VetsUtil::MyBase
	MyBase ()

const string &	getClassName () const

Additional Inherited Members
Public Types inherited from VetsUtil::MyBase
typedef void(*	ErrMsgCB_T) (const char *msg, int err_code)

typedef void(*	DiagMsgCB_T) (const char *msg)

Static Public Member Functions inherited from VetsUtil::MyBase
static void	SetErrMsg (const char *format,...)
	Record a formatted error message. More...

static void	SetErrMsg (int errcode, const char *format,...)
	Record a formatted error message and an error code. More...

static const char *	GetErrMsg ()

static void	SetErrCode (int err_code)
	Record an error code. More...

static int	GetErrCode ()
	Retrieve the current error code. More...

static void	SetErrMsgCB (ErrMsgCB_T cb)

static ErrMsgCB_T	GetErrMsgCB ()

static void	SetErrMsgFilePtr (FILE *fp)

static const FILE *	SetErrMsgFilePtr ()

static void	SetDiagMsg (const char *format,...)
	Record a formatted diagnostic message. More...

static const char *	GetDiagMsg ()

static void	SetDiagMsgCB (DiagMsgCB_T cb)

static DiagMsgCB_T	GetDiagMsgCB ()

static void	SetDiagMsgFilePtr (FILE *fp)

static bool	EnableErrMsg (bool enable)

Static Public Attributes inherited from VetsUtil::MyBase
static char *	ErrMsg

static int	ErrCode

static int	ErrMsgSize

static FILE *	ErrMsgFilePtr

static ErrMsgCB_T	ErrMsgCB

static char *	DiagMsg

static int	DiagMsgSize

static FILE *	DiagMsgFilePtr

static DiagMsgCB_T	DiagMsgCB

static bool	Enabled

Protected Member Functions inherited from VetsUtil::MyBase
void	SetClassName (const string &name)

Detailed Description

A class that performs rendering in the GLWindow.

Author: Alan Norton

Version: $Revision$

Date: $Date$

Renderer class is a pure virtual class that supports OpenGL rendering in the VAPOR visualizer window. All renderers must derive from this class.

Definition at line 45 of file renderer.h.

Constructor & Destructor Documentation

VAPoR::Renderer::Renderer	(	GLWindow *	vw,
		RenderParams *	rp,
		string	name
	)

Constructor should be invoked by any derived renderers. It is invoked when the user enables a renderer. Provides any needed setup of renderer state, but not of OpenGL state.

virtual VAPoR::Renderer::~Renderer ( )

virtual

Member Function Documentation

bool VAPoR::Renderer::doAlwaysBypass ( int timestep )

inline

doAlwaysBypass is used in the presence of partial bypass. Indicates that the rendering should be bypassed at any resolution

Parameters

[in] int timestep Time step

Return values

bool	value of flag

Definition at line 105 of file renderer.h.

bool VAPoR::Renderer::doBypass ( int timestep )

inline

doBypass indicates the state of the bypass flag.

Parameters

[in] timestep indicates the timestep being checked

Return values

bool	indicates that the rendering at the timestep should be bypassed.

Definition at line 99 of file renderer.h.

RenderParams* VAPoR::Renderer::getRenderParams ( )

inline

Obtain the current RenderParams instance

Return values

RenderParams* current render params

Definition at line 73 of file renderer.h.

virtual void VAPoR::Renderer::initializeGL ( )

pure virtual

Pure virtual method Any OpenGL initialization is performed in initializeGL It will be called from an OpenGL rendering context. Sets initialized to true if successful.

bool VAPoR::Renderer::isInitialized ( )

inline

Identify whether the renderer has been initialized

Return values

bool	initialized

Definition at line 77 of file renderer.h.

virtual void VAPoR::Renderer::paintGL ( )

pure virtual

All OpenGL rendering is performed in the pure virtual paintGL method.

void VAPoR::Renderer::setAllBypass ( bool val )

inline

SetAllBypass is set to indicate all (or no) timesteps should be bypassed Should be set true when render failure is independent of timestep Should be set false when state changes and rendering should be reattempted.

Parameters

[in] val indicates whether it is being turned on or off.

Definition at line 94 of file renderer.h.

virtual void VAPoR::Renderer::setAllDataDirty ( )

pure virtual

General method to force a renderer to re-obtain its data. Must be implemented, although does not need to do anything if no state or cache is retained between renderings.

void VAPoR::Renderer::setBypass ( int timestep )

inline

Call setBypass to indicate that the renderer will not work until the state of the params is changed This will result in the renderer not being invoked for the specified timestep

Parameters

[in] int timestep The timestep when the renderer fails

Definition at line 82 of file renderer.h.

void VAPoR::Renderer::setPartialBypass ( int timestep )

inline

Partial bypass is currently only used by DVR and Isosurface renderers. Indicates a renderer that should be bypassed at full resolution but not at interactive resolution.

Parameters

[in] timestep Time step that should be bypassed

Definition at line 88 of file renderer.h.

virtual void VAPoR::Renderer::setRenderParams ( RenderParams * rp )

inlinevirtual

Whenever the Params associated with the renderer is changed, setRenderParams must be called. This virtual method should be overridden if there are any dirty flags registered by the renderer.

Parameters

[in] RenderParams* rp Pointer to the current RenderParams instance

Definition at line 69 of file renderer.h.

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

/Users/clyne/src/vapor/lib/render/renderer.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation