VAPoR::RendererBase Class Reference

A base class for Renderer classes. More...

#include <Renderer.h>

Inheritance diagram for VAPoR::RendererBase:

Public Member Functions
	RendererBase (const ParamsMgr *pm, string winName, string dataSetName, string paramsType, string classType, string instName, DataMgr *dataMgr)
virtual	~RendererBase ()
virtual int	initializeGL (GLManager *glManager)
string	GetVisualizer ()
	Obtain the Visualizer associated with this Renderer.
string	GetMyName () const
string	GetInstanceName () const
string	GetMyType () const
string	GetMyParamsType () const
string	GetMyDatasetName () const
bool	IsGLInitialized () const
void	FlagForDeletion ()
bool	IsFlaggedForDeletion () const
	RendererBase ()
Public Member Functions inherited from Wasp::MyBase
	MyBase ()
const string &	getClassName () const

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

Protected Attributes
const ParamsMgr *	_paramsMgr
string	_winName
string	_dataSetName
string	_paramsType
string	_classType
string	_instName
DataMgr *	_dataMgr
GLManager *	_glManager

Additional Inherited Members
Public Types inherited from Wasp::MyBase
typedef void(*	ErrMsgCB_T) (const char *msg, int err_code)
typedef void(*	DiagMsgCB_T) (const char *msg)
Static Public Member Functions inherited from Wasp::MyBase
static void	SetErrMsg (const char *format,...)
	Record a formatted error message.
static void	SetErrMsg (int errcode, const char *format,...)
	Record a formatted error message and an error code.
static const char *	GetErrMsg ()
static void	SetErrCode (int err_code)
	Record an error code.
static int	GetErrCode ()
	Retrieve the current error code.
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.
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 bool	GetEnableErrMsg ()
Static Public Attributes inherited from Wasp::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 47 of file Renderer.h.

Constructor & Destructor Documentation

RendererBase() [1/2]

VAPoR::RendererBase::RendererBase	(	const ParamsMgr *	pm,
		string	winName,
		string	dataSetName,
		string	paramsType,
		string	classType,
		string	instName,
		DataMgr *	dataMgr
	)

~RendererBase()

virtual VAPoR::RendererBase::~RendererBase ( )

virtual

RendererBase() [2/2]

VAPoR::RendererBase::RendererBase ( )

inline

Definition at line 104 of file Renderer.h.

Member Function Documentation

_initializeGL()

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::ContourRenderer, VAPoR::HelloRenderer, VAPoR::ModelRenderer, VAPoR::ParticleRenderer, VAPoR::RayCaster, VAPoR::SliceRenderer, VAPoR::TwoDDataRenderer, VAPoR::TwoDRenderer, VAPoR::VolumeRenderer, and VAPoR::WireFrameRenderer.

FlagForDeletion()

void VAPoR::RendererBase::FlagForDeletion

(

)

Renderers need to be deleted during the draw loop to ensure the correct OpenGL context is bound

GetInstanceName()

string VAPoR::RendererBase::GetInstanceName ( ) const

inline

Definition at line 63 of file Renderer.h.

GetMyDatasetName()

string VAPoR::RendererBase::GetMyDatasetName ( ) const

inline

Identifiy the dataset associated with the current renderer

Returns

dataset name

Definition at line 75 of file Renderer.h.

GetMyName()

string VAPoR::RendererBase::GetMyName ( ) const

inline

Identify the name of the current renderer

Returns

name of renderer

Definition at line 62 of file Renderer.h.

GetMyParamsType()

string VAPoR::RendererBase::GetMyParamsType ( ) const

inline

Identify the params belonging to the current renderer

Returns

params for renderer

Definition at line 71 of file Renderer.h.

GetMyType()

string VAPoR::RendererBase::GetMyType ( ) const

inline

Identify the type of the current renderer

Returns

type of renderer

Definition at line 67 of file Renderer.h.

GetVisualizer()

string VAPoR::RendererBase::GetVisualizer ( )

inline

Obtain the Visualizer associated with this Renderer.

Definition at line 58 of file Renderer.h.

initializeGL()

virtual int VAPoR::RendererBase::initializeGL ( GLManager *  glManager )

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.

IsFlaggedForDeletion()

bool VAPoR::RendererBase::IsFlaggedForDeletion

(

)

const

IsGLInitialized()

bool VAPoR::RendererBase::IsGLInitialized ( ) const

inline

Return boolean indicating whether initializeGL has been successfully called

Definition at line 80 of file Renderer.h.

Member Data Documentation

_classType

string VAPoR::RendererBase::_classType

protected

Definition at line 87 of file Renderer.h.

_dataMgr

DataMgr* VAPoR::RendererBase::_dataMgr

protected

Definition at line 89 of file Renderer.h.

_dataSetName

string VAPoR::RendererBase::_dataSetName

protected

Definition at line 85 of file Renderer.h.

_glManager

GLManager* VAPoR::RendererBase::_glManager

protected

Definition at line 91 of file Renderer.h.

_instName

string VAPoR::RendererBase::_instName

protected

Definition at line 88 of file Renderer.h.

_paramsMgr

const ParamsMgr* VAPoR::RendererBase::_paramsMgr

protected

Definition at line 83 of file Renderer.h.

_paramsType

string VAPoR::RendererBase::_paramsType

protected

Definition at line 86 of file Renderer.h.

_winName

string VAPoR::RendererBase::_winName

protected

Definition at line 84 of file Renderer.h.

---

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

• /Users/pearse/VAPOR/include/vapor/Renderer.h