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 (int winnum)

	~RegionParams ()
	Destructor. More...

void	getRegionVoxelCoords (int reflevel, int lod, size_t min_dim[3], size_t max_dim[3], int timestep)

int	getAvailableVoxelCoords (int reflevel, int lod, size_t min_dim[3], size_t max_dim[3], size_t timestep, const int sesVarNums, int numVars, double regMin=0, double regMax=0)

float	fullRegionMBs (int refLevel)

Public Member Functions inherited from VAPoR::Params
	Params (XmlNode *parent, const string &name, int winNum)

	Params (int winNum, const string &name)
	Deprecated constructor, needed for built-in classes that do not have associated XML node: More...

	Params (const Params &p)
	Default copy constructor. More...

virtual	~Params ()

virtual const std::string &	getShortName ()=0

virtual bool	isRenderParams ()

virtual Params *	deepCopy (ParamNode *nd=0)

virtual void	restart ()=0
	Pure virtual method, sets a Params instance to its default state. More...

virtual int	getVizNum ()

virtual void	setLocal (bool lg)

bool	isLocal ()

virtual void	setVizNum (int vnum)

virtual void	SetVisualizerNum (int viznum)

virtual int	GetVisualizerNum ()

virtual bool	reinit (bool)

virtual Box *	GetBox ()

virtual int	getOrientation ()

virtual void	calcContainingStretchedBoxExtentsInCube (float extents[6], bool rotated=false)

void	calcRotatedStretchedBoxExtentsInCube (float extents[6])

virtual bool	isDomainConstrained ()

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

const string &	getClassName () const

Public Member Functions inherited from VAPoR::ParamsBase
	ParamsBase (XmlNode *parent, const string &name)

	ParamsBase (const string &name)
	Default constructor. More...

	ParamsBase (const ParamsBase &pbase)
	Copy constructor. More...

virtual	~ParamsBase ()

void	SetParent (XmlNode *parent)

virtual bool	elementStartHandler (ExpatParseMgr pm, int depth, string &tag, const char *attribs)

virtual bool	elementEndHandler (ExpatParseMgr *pm, int depth, string &tag)

ParamNode *	GetRootNode ()

virtual ParamNode *	buildNode ()

void	SetFlagDirty (const string &flag)

const string &	GetName ()

ParamsBaseType	GetParamsBaseTypeId ()

virtual void	SetRootParamNode (ParamNode *pn)

Public Member Functions inherited from VAPoR::ParsedXml
virtual	~ParsedXml ()

virtual bool	elementStartHandler (ExpatParseMgr , int, std::string &, const char *)=0

virtual bool	elementEndHandler (ExpatParseMgr *, int, std::string &)=0

virtual bool	charHandler (ExpatParseMgr , const XML_Char , int)

Static Public Member Functions
static int	PrepareCoordsForRetrieval (int numxforms, int lod, size_t timestep, const vector< string > &varnames, double regMin, double regMax, size_t min_dim[3], size_t max_dim[3])

static float	calcCurrentValue (const string &varname, const double point[3], int numRefinements, int lod, size_t timeStep)

Static Public Member Functions inherited from VAPoR::Params
static int	GetCurrentParamsInstanceIndex (int pType, int winnum)

static int	GetCurrentParamsInstanceIndex (const std::string tag, int winnum)

static void	SetCurrentParamsInstanceIndex (int pType, int winnum, int instance)

static Params *	GetParamsInstance (int pType, int winnum=-1, int instance=-1)

static Params *	GetParamsInstance (const std::string tag, int winnum=-1, int instance=-1)

static Params *	GetCurrentParamsInstance (int pType, int winnum)

static Params *	GetDefaultParams (ParamsBase::ParamsBaseType pType)

static Params *	GetDefaultParams (const string &tag)

static void	SetDefaultParams (int pType, Params *p)

static void	SetDefaultParams (const string &tag, Params *p)

static Params *	CreateDefaultParams (int pType)

static int	GetNumParamsInstances (int pType, int winnum)

static int	GetNumParamsInstances (const std::string tag, int winnum)

static void	AppendParamsInstance (int pType, int winnum, Params *p)

static void	AppendParamsInstance (const std::string tag, int winnum, Params *p)

static void	RemoveParamsInstance (int pType, int winnum, int instance)

static void	InsertParamsInstance (int pType, int winnum, int posn, Params *dp)

static vector< Params * > &	GetAllParamsInstances (int pType, int winnum)

static vector< Params * > &	GetAllParamsInstances (const std::string tag, int winnum)

static map< int, vector< Params * > > *	cloneAllParamsInstances (int winnum)

static vector< Params * > *	cloneAllDefaultParams ()

static bool	IsRenderingEnabled (int winnum)

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 Member Functions inherited from VAPoR::ParamsBase
static ParamsBaseType	GetTypeFromTag (const string &tag)

static const string &	GetTagFromType (ParamsBaseType t)

static ParamsBase *	CreateDefaultParamsBase (int pType)

static ParamsBase *	CreateDefaultParamsBase (const string &tag)

static int	RegisterParamsBaseClass (const string &tag, BaseCreateFcn fcn, bool isParams)

static int	ReregisterParamsBaseClass (const string &tag, const string &newtag, bool isParams)

static int	GetNumParamsClasses ()

static bool	IsParamsTag (const string &tag)

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)

Public Types inherited from VAPoR::ParamsBase
typedef int	ParamsBaseType

Public Attributes inherited from VAPoR::ParsedXml
ParsedXml *	previousClass

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)

Protected Member Functions inherited from VAPoR::ParamsBase
virtual ParamNode *	getCurrentParamNode ()

virtual void	setCurrentParamNode (ParamNode *pn)

ParamNode *	GetCurrentNode ()

ParamNode *	Push (string &tag, ParamsBase *pBase=0)

ParamNode *	Pop ()

void	Remove (const string &name)

const map< string, string > &	GetAttributes ()

void	Clear ()

Protected Attributes inherited from VAPoR::ParamsBase
string	_paramsBaseName

int	_parseDepth

Static Protected Attributes inherited from VAPoR::ParamsBase
static vector< ParamsBase * >	dummyParamsBaseInstances

static const string	_emptyString

static map< string, int >	classIdFromTagMap

static map< int, string >	tagFromClassIdMap

static map< int, BaseCreateFcn >	createDefaultFcnMap

static int	numParamsClasses

static int	numEmbedClasses

Static Protected Attributes inherited from VAPoR::ParsedXml
static const string	_stringType

static const string	_longType

static const string	_doubleType

static const string	_typeAttr

Detailed Description

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

Author: Alan Norton

Version: $Revision$

Date: $Date$ 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.

Definition at line 52 of file regionparams.h.

Constructor & Destructor Documentation

VAPoR::RegionParams::RegionParams ( int winnum )

Parameters

[in] int winnum The window number, or -1 for a global RegionParams

VAPoR::RegionParams::~RegionParams ( )

Destructor.

Member Function Documentation

static float VAPoR::RegionParams::calcCurrentValue	(	const string &	varname,
		const double	point[3],
		int	numRefinements,
		int	lod,
		size_t	timeStep
	)

static

Evaluate a variable at a point, as requested by a RenderParams

Parameters

[in]	string	varname requested variable name (2d or 3d)
[in]	double	point[3] User coordinates of requested value
[in]	int	numRefinements Refinement level of requested data
[in]	int	lod Compression level of requested data
[in]	int	timeStep Time step of data

float VAPoR::RegionParams::fullRegionMBs ( int refLevel )

Calculate the full size of the region in megabytes, at specified refinement level.

Parameters

[in] int reflevel Refinement level of data, use -1 for max refinement.

Return values

float size in megabytes.

int VAPoR::RegionParams::getAvailableVoxelCoords	(	int	reflevel,
		int *	lod,
		size_t	min_dim[3],
		size_t	max_dim[3],
		size_t	timestep,
		const int *	sesVarNums,
		int	numVars,
		double *	regMin = `0`,
		double *	regMax = `0`
	)

Method to obtain voxel and user coordinates of the available data in the region. The region extents may be shrunk so as to include only the portion of the region for which the specified variables are available. If the requested refinement level is not available, and the user allows use of lowered accuracy, then returns the highest refinement level that is available. Returns -1 if required data is unavailable. Optionally provides user data extents.

Return values

int	Available refinenement level, or -1 if no data available

Parameters

[in]	int	reflevel Refinement level of requested coordinates
[in]	int*	lod LOD of data (lowered if necessary)
[out]	size_t	min_dim[3] Minimum voxel coordinates of available region
[out]	size_t	max_dim[3] Maximum voxel coordinates of available region
[in]	size_t	timestep Time step at which the data is being requested.
[in]	int*	sesVarNums An array of integer session 3D variable nums for requested variables
[in]	int	numVars Number of variables, i.e. size of sesVarnums
[out]	double*	regMin Minimum user coordinates, if this pointer is non-null
[out]	double*	regMax Maximum user coordinates, if this pointer is non-null

void VAPoR::RegionParams::getRegionVoxelCoords	(	int	reflevel,
		int	lod,
		size_t	min_dim[3],
		size_t	max_dim[3],
		int	timestep
	)

Method to obtain voxel coords of a region, but doesn't verify the existence of data in the region.

Parameters

[in]	int	reflevel Refinement level of requested coordinates
[in]	int	lod LOD of data for requested coordinates, needed for ELEVATION
[out]	size_t	min_dim[3] Minimum voxel coordinates of region
[out]	size_t	max_dim[3] Maximum voxel coordinates of region
[in]	int	timestep Time step at which the coordinates are being requested.

static int VAPoR::RegionParams::PrepareCoordsForRetrieval	(	int	numxforms,
		int	lod,
		size_t	timestep,
		const vector< string > &	varnames,
		double *	regMin,
		double *	regMax,
		size_t	min_dim[3],
		size_t	max_dim[3]
	)

static

Static method to prepare for retrieval of data arrays from DataMgr.

Parameters

[in]	int	numxforms Requested refinement level of data
[in]	int	lod Requested LOD of data
[in]	size_t	timestep Time for which data is requested.
[in]	vector<string>&	varnames Vector of 2D or 3D variable names being requested
[in,out]	double*	regMin Minimum user coordinate extents requested (in) and actual available (out)
[in,out]	double*	regMax Maximum user coordinate extents requested (in) and actual available (out)
[out]	size_t	min_dim[3] Minimum voxel coordinates of available region
[out]	size_t	max_dim[3] Maximum voxel coordinates of available region

Return values

int	Actual refinement level available or -1 if not all variables available.

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

/Users/clyne/src/vapor/lib/params/regionparams.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation