VAPoR  0.1
Public Member Functions | Static Public Member Functions | List of all members
VAPoR::RenderParams Class Referenceabstract

A Params subclass for managing parameters used by Renderers. More...

#include <params.h>

Inheritance diagram for VAPoR::RenderParams:
VAPoR::Params VetsUtil::MyBase VAPoR::ParamsBase VAPoR::ParsedXml

Public Member Functions

 RenderParams (XmlNode *parent, const string &name, int winnum)
 
bool isEnabled ()
 
virtual void setEnabled (bool value)
 
virtual bool usingVariable (const std::string &varname)=0
 
virtual void SetRefinementLevel (int level)
 
virtual int GetRefinementLevel ()
 
virtual int GetCompressionLevel ()
 
virtual int GetFidelityLevel ()
 
virtual void SetFidelityLevel (int level)
 
virtual bool GetIgnoreFidelity ()
 
virtual void SetIgnoreFidelity (bool val)
 
virtual void SetCompressionLevel (int val)
 
virtual const float * getSelectedPointLocal ()
 
virtual bool IsOpaque ()=0
 
void setBypass (int timestep)
 
void setPartialBypass (int timestep)
 
void setAllBypass (bool val)
 
bool doBypass (int ts)
 
bool doAlwaysBypass (int ts)
 
virtual bool UsesMapperFunction ()
 
- 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 ParamsdeepCopy (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 BoxGetBox ()
 
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)
 
ParamNodeGetRootNode ()
 
virtual ParamNodebuildNode ()
 
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 float getCameraDistance (ViewpointParams *vpp, const double exts[6])
 Static method specifies the distance from camera to an axis-aligned box. More...
 
- 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 ParamsGetParamsInstance (int pType, int winnum=-1, int instance=-1)
 
static ParamsGetParamsInstance (const std::string tag, int winnum=-1, int instance=-1)
 
static ParamsGetCurrentParamsInstance (int pType, int winnum)
 
static ParamsGetDefaultParams (ParamsBase::ParamsBaseType pType)
 
static ParamsGetDefaultParams (const string &tag)
 
static void SetDefaultParams (int pType, Params *p)
 
static void SetDefaultParams (const string &tag, Params *p)
 
static ParamsCreateDefaultParams (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 ParamsBaseCreateDefaultParamsBase (int pType)
 
static ParamsBaseCreateDefaultParamsBase (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
ParsedXmlpreviousClass
 
- 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 ParamNodegetCurrentParamNode ()
 
virtual void setCurrentParamNode (ParamNode *pn)
 
ParamNodeGetCurrentNode ()
 
ParamNodePush (string &tag, ParamsBase *pBase=0)
 
ParamNodePop ()
 
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 Params subclass for managing parameters used by Renderers.

Author
Alan Norton
Version
$Revision$
Date
$Date$

Definition at line 564 of file params.h.

Constructor & Destructor Documentation

VAPoR::RenderParams::RenderParams ( XmlNode parent,
const string &  name,
int  winnum 
)

Standard RenderParams constructor.

Parameters
[in]parentXmlNode corresponding to this Params class instance
[in]namestd::string name, can be the tag
[in]winNuminteger visualizer num, -1 for global or default params

Member Function Documentation

bool VAPoR::RenderParams::doAlwaysBypass ( int  ts)
inline

This method is used in the presence of partial bypass. Indicates that the rendering should be bypassed at all resolutions.

Parameters
[in]intts Time step
Return values
boolvalue of flag

Definition at line 665 of file params.h.

bool VAPoR::RenderParams::doBypass ( int  ts)
inline

This method returns the status of the bypass flag.

Parameters
[in]intts Time step
Return values
boolvalue of flag

Definition at line 659 of file params.h.

static float VAPoR::RenderParams::getCameraDistance ( ViewpointParams vpp,
const double  exts[6] 
)
static

Static method specifies the distance from camera to an axis-aligned box.

virtual int VAPoR::RenderParams::GetCompressionLevel ( )
virtual

virtual method indicates current Compression level.

Return values
integercompression level, 0 is most compressed
virtual int VAPoR::RenderParams::GetFidelityLevel ( )
virtual

virtual method indicates current fidelity level

Return values
floatbetween 0 and 1
virtual bool VAPoR::RenderParams::GetIgnoreFidelity ( )
virtual

virtual method indicates fidelity is ignored

Return values
bool
virtual int VAPoR::RenderParams::GetRefinementLevel ( )
inlinevirtual

Definition at line 590 of file params.h.

virtual const float* VAPoR::RenderParams::getSelectedPointLocal ( )
inlinevirtual

virtual method used only by params that support selecting points in 3D space, and displaying those points with a 3D cursor. Default implementation returns null. Selected point is in local coordinates

Return values
constfloat* pointer to 3D point.

Definition at line 624 of file params.h.

bool VAPoR::RenderParams::isEnabled ( )
inline

Indicate if the renderer is enabled

Return values
trueif enabled

Definition at line 576 of file params.h.

virtual bool VAPoR::RenderParams::IsOpaque ( )
pure virtual
void VAPoR::RenderParams::setAllBypass ( bool  val)

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

Parameters
[in]valindicates whether it is being turned on or off.
void VAPoR::RenderParams::setBypass ( int  timestep)
inline

Bypass flag is used to indicate a renderer should not render until its state is changed. Should be called when a rendering fails in a way that might repeat.

Parameters
[in]timestepthat should be bypassed

Definition at line 642 of file params.h.

virtual void VAPoR::RenderParams::SetCompressionLevel ( int  val)
virtual

virtual method sets current Compression level.

Parameters
[in]valcompression level, 0 is most compressed
virtual void VAPoR::RenderParams::setEnabled ( bool  value)
inlinevirtual

Set renderer to be enabled

Parameters
[in]valuetrue if enabled

Definition at line 580 of file params.h.

virtual void VAPoR::RenderParams::SetFidelityLevel ( int  level)
virtual

virtual method sets current fidelity level

Parameters
[in]floatlevel
virtual void VAPoR::RenderParams::SetIgnoreFidelity ( bool  val)
virtual

virtual method sets whether fidelity is ignored

Parameters
[in]bool
void VAPoR::RenderParams::setPartialBypass ( int  timestep)
inline

Partial bypass is similar to the bypass flag. It is currently only set by DVR. This indicates a renderer should be bypassed at full resolution but not at interactive resolution.

Parameters
[in]timestepthat should be bypassed

Definition at line 648 of file params.h.

virtual void VAPoR::RenderParams::SetRefinementLevel ( int  level)
inlinevirtual

Definition at line 586 of file params.h.

virtual bool VAPoR::RenderParams::UsesMapperFunction ( )
inlinevirtual

Indicate that this class supports use of the VAPOR MapperFunction Default is false. Currently needed to use colorbars.

Return values
booltrue if this RenderParams can have a MapperFunction

Definition at line 671 of file params.h.

virtual bool VAPoR::RenderParams::usingVariable ( const std::string &  varname)
pure virtual

Pure virtual method indicates if a particular variable name is currently used by the renderer.

Parameters
[in]varnamename of the variable

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