VAPoR::RegionParams Class Reference

A class for describing a 3D axis-aligned region in user space. More...

#include <regionparams.h>

Inheritance diagram for VAPoR::RegionParams:

Public Member Functions
	RegionParams (ParamsBase::StateSave *ssave)
	RegionParams (ParamsBase::StateSave *ssave, XmlNode *node)
	RegionParams (const RegionParams &rhs)
RegionParams &	operator= (const RegionParams &rhs)
virtual	~RegionParams ()
virtual Box *	GetBox () const
Public Member Functions inherited from VAPoR::ParamsBase
	ParamsBase (StateSave *ssave, const string &classname)
	ParamsBase (StateSave *ssave, XmlNode *node)
	ParamsBase (const ParamsBase &rhs)
	Copy constructor.
ParamsBase &	operator= (const ParamsBase &rhs)
	ParamsBase (ParamsBase &&)=delete
ParamsBase &	operator= (ParamsBase &)=delete
bool	operator== (const ParamsBase &rhs) const
	Equivalence operator.
bool	operator!= (const ParamsBase &rhs) const
virtual	~ParamsBase ()
void	SetParent (ParamsBase *parent)
XmlNode *	GetNode () const
void	BeginGroup (const string &description)
void	EndGroup ()
void	IntermediateChange ()
virtual vector< long >	GetValueLongVec (const string tag) const
virtual vector< long >	GetValueLongVec (const string tag, const vector< long > &defaultVal) const
virtual long	GetValueLong (const string tag, long defaultVal) const
virtual vector< double >	GetValueDoubleVec (const string tag) const
virtual vector< double >	GetValueDoubleVec (const string tag, const vector< double > &defaultVal) const
virtual double	GetValueDouble (const string tag, double defaultVal) const
virtual vector< string >	GetValueStringVec (const string tag) const
virtual vector< string >	GetValueStringVec (const string tag, const vector< string > &defaultVal) const
virtual string	GetValueString (const string tag, string defaultVal) const
virtual void	SetValueLongVec (const string &tag, string description, const vector< long > &values)
virtual void	SetValueLong (const string &tag, string description, long value)
virtual void	SetValueDoubleVec (const string &tag, string description, const vector< double > &values)
virtual void	SetValueDouble (const string &tag, string description, double value)
virtual void	SetValueStringVec (const string &tag, string description, const vector< string > &values)
virtual void	SetValueString (const string &tag, string description, const string &value)
string	GetName () const
Public Member Functions inherited from Wasp::MyBase
	MyBase ()
const string &	getClassName () const

Static Public Member Functions
static string	GetClassType ()
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 ()

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 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
Protected Member Functions inherited from VAPoR::ParamsBase
	ParamsBase (StateSave *ssave)
void	Remove (const string &name)
const map< string, string > &	GetAttributes ()
void	Clear ()
Protected Member Functions inherited from Wasp::MyBase
void	SetClassName (const string &name)
Protected Attributes inherited from VAPoR::ParamsBase
StateSave *	_ssave
XmlNode *	_node

Detailed Description

A class for describing a 3D axis-aligned region in user space.

The RegionParams class controls the extents of a 3D box of data for visualization. The DVR, Isosurface and Flow renderers use only the data specified by the current RegionParams. There is a global RegionParams, that is shared by all windows whose region is set to "global". There is also a local RegionParams for each window, that users can select whenever there are multiple windows. When local settings are used, they only affect one currently active visualizer. The RegionParams class also has several methods that are useful in setting up data requests from the DataMgr.

Author

Alan Norton

Version

3.0

Date

February 2014

Definition at line 44 of file regionparams.h.

Constructor & Destructor Documentation

RegionParams() [1/3]

VAPoR::RegionParams::RegionParams

(

ParamsBase::StateSave *

ssave

)

RegionParams() [2/3]

VAPoR::RegionParams::RegionParams	(	ParamsBase::StateSave *	ssave,
		XmlNode *	node
	)

RegionParams() [3/3]

VAPoR::RegionParams::RegionParams

(

const RegionParams &

rhs

)

~RegionParams()

virtual VAPoR::RegionParams::~RegionParams ( )

virtual

Member Function Documentation

GetBox()

virtual Box * VAPoR::RegionParams::GetBox ( ) const

inlinevirtual

Method to obtain the current Box defining the region extents

Return values

Box*	current Box.

Definition at line 59 of file regionparams.h.

GetClassType()

static string VAPoR::RegionParams::GetClassType ( )

inlinestatic

Get the extents extent of the Box, in local coordinates

Parameters

[out]	double[6]	extents
[in]	int	timestep indicates the current timestep, used only with time-varying extents.

Definition at line 133 of file regionparams.h.

operator=()

RegionParams & VAPoR::RegionParams::operator=

(

const RegionParams &

rhs

)

---

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

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