VAPoR  3.0.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
VAPoR::RendererBase Class Referenceabstract

A base class for Renderer classes. More...

#include <renderer.h>

Inheritance diagram for VAPoR::RendererBase:
VetsUtil::MyBase VAPoR::Renderer VAPoR::ArrowRenderer VAPoR::HelloRenderer VAPoR::IsolineRenderer

Public Member Functions

 RendererBase (Visualizer *vw, Params *p, string name)
 
virtual ~RendererBase ()
 
virtual int initializeGL ()
 
VisualizerGetVisualizer ()
 Obtain the Visualizer associated with this Renderer. More...
 
bool isInitialized ()
 
const string getMyName () const
 
virtual void invalidateCache ()
 
- Public Member Functions inherited from VetsUtil::MyBase
 MyBase ()
 
const string & getClassName () const
 

Protected Member Functions

virtual int _initializeGL ()=0
 
- Protected Member Functions inherited from VetsUtil::MyBase
void SetClassName (const string &name)
 

Protected Attributes

Visualizer_visualizer
 
bool _initialized
 
size_t _timestep
 
string _rendererName
 
Params_params
 

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
 

Detailed Description

A base class for Renderer classes.

Author
Alan Norton
Version
3.0
Date
July 2015

RendererBase is a base class of Renderer, for special rendering tasks that are not associated with RenderParams instances. For example the VizFeatureRenderer has a special role during Visualizer OpenGL rendering. RendererBase instances perform rendering in a VAPOR Visualizer but are not associated with RenderParams instances.

Definition at line 48 of file renderer.h.

Constructor & Destructor Documentation

VAPoR::RendererBase::RendererBase ( Visualizer vw,
Params p,
string  name 
)
virtual VAPoR::RendererBase::~RendererBase ( )
virtual

Member Function Documentation

virtual int VAPoR::RendererBase::_initializeGL ( )
protectedpure virtual

Pure virtual method Any OpenGL initialization is performed in initializeGL It will be called from an OpenGL rendering context.

Implemented in VAPoR::IsolineRenderer, and VAPoR::HelloRenderer.

const string VAPoR::RendererBase::getMyName ( ) const
inline

Identify the name of the current renderer (for error messages)

Returns
name (i.e. tag) of renderer

Definition at line 67 of file renderer.h.

Visualizer* VAPoR::RendererBase::GetVisualizer ( )
inline

Obtain the Visualizer associated with this Renderer.

Definition at line 59 of file renderer.h.

virtual int VAPoR::RendererBase::initializeGL ( )
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.

virtual void VAPoR::RendererBase::invalidateCache ( )
inlinevirtual

Invalidate all caches associated with a Renderer instance Default does nothing

Reimplemented in VAPoR::Renderer, and VAPoR::IsolineRenderer.

Definition at line 71 of file renderer.h.

bool VAPoR::RendererBase::isInitialized ( )
inline

Identify whether the renderer has been initialized

Return values
bool_initialized

Definition at line 63 of file renderer.h.

Member Data Documentation

bool VAPoR::RendererBase::_initialized
protected

Definition at line 79 of file renderer.h.

Params* VAPoR::RendererBase::_params
protected

Definition at line 82 of file renderer.h.

string VAPoR::RendererBase::_rendererName
protected

Definition at line 81 of file renderer.h.

size_t VAPoR::RendererBase::_timestep
protected

Definition at line 80 of file renderer.h.

Visualizer* VAPoR::RendererBase::_visualizer
protected

Definition at line 78 of file renderer.h.


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