A class for describing mouse modes in use in VAPOR. More...

#include <mousemodeparams.h>

Inheritance diagram for VAPoR::MouseModeParams:

Static Public Member Functions
static int	RegisterMouseMode (std::string tag, int modeType, const char modeName, const char const xpmIcon[])

static int	AddMouseMode (const std::string paramsTag, int manipType, const char *name)

static int	getModeManipType (int modeIndex)

static std::string	getModeTag (int modeIndex)

static int	getModeFromParams (string tag)

static const string	getModeName (int index)

static void	RegisterMouseModes ()

static mouseModeType	GetCurrentMouseMode ()

static void	SetCurrentMouseMode (mouseModeType t)

static int	getNumMouseModes ()
	Static method indicates how many mouse modes are available. More...

Static Public Member Functions inherited from VAPoR::Params
static bool	IsRenderingEnabled (int winnum)

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 vector< Params * > &	GetAllParamsInstances (int pType, int winnum)

static int	GetAllParamsInstances (string tag, vector< Params * > &)

static int	DeleteVisualizer (int viznum)

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

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

static vector< Params * > *	cloneAllDefaultParams ()

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

static bool	IsParamsTag (const string &tag)

Internal
Internal methods not intended for general use
enum	mouseModeType { unknownMode =1000, navigateMode =0, regionMode =1, probeMode =3, twoDDataMode =4, twoDImageMode =5, rakeMode =2, barbMode =6, isolineMode =7 }

	MouseModeParams (XmlNode *parent, int winnum)

virtual	~MouseModeParams ()
	Destructor. More...

virtual void	Validate (int type)

virtual void	restart ()
	Method to initialize a new MouseModeParams instance. More...

const std::string	getShortName ()

static const char const	GetIcon (int modeIndex)
	Static method identifies pixmap icon for each mode. More...

static ParamsBase *	CreateDefaultInstance ()

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 Member Functions inherited from VAPoR::BasicParams
	BasicParams (XmlNode *parent, const string &name)

Public Member Functions inherited from VAPoR::Params
	Params (const Params &p)
	Default copy constructor. More...

virtual	~Params ()

bool	isRenderParams () const

bool	isBasicParams () const

virtual int	GetVizNum ()

virtual int	SetLocal (bool lg)

virtual bool	IsLocal ()

virtual Box *	GetBox ()

	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...

virtual int	GetInstanceIndex ()

virtual void	SetVizNum (int vnum)

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 ()
	destructor..destroys the xml tree based at the root node. More...

ParamNode *	GetRootNode () const

const string	GetName () const

virtual long	GetValueLong (const string &tag, const vector< long > &defaultVal=_emptyLongVec)

virtual double	GetValueDouble (const string &tag, const vector< double > &defaultVal=_emptyDoubleVec)

virtual const string	GetValueString (const string &tag, const string &defaultVal=_emptyString)

virtual const vector< long >	GetValueLongVec (const string &tag, const vector< long > &defaultVal=_emptyLongVec)

virtual const vector< double >	GetValueDoubleVec (const string &tag, const vector< double > &defaultVal=_emptyDoubleVec)

virtual void	GetValueStringVec (const string &tag, vector< string > &vec, const vector< string > &defaultVal=_emptyStringVec)

virtual int	SetValueLong (string tag, const char description, long value, Params p)

virtual int	SetValueLong (string tag, const char description, const vector< long > &value, Params p)

virtual int	SetValueDouble (string tag, const char description, double value, Params p)

virtual int	SetValueDouble (string tag, const char description, const vector< double > &value, Params p)

virtual int	SetValueString (string tag, const char description, const string &value, Params p)

virtual int	SetValueStringVec (string tag, const char description, const vector< string > &value, Params p)

ParamsBaseType	GetParamsBaseTypeId ()

virtual void	SetRootParamNode (ParamNode *pn)

ParamsBase *	GetParamsBase (const vector< string > &path) const

int	SetParamsBase (const vector< string > &path, ParamsBase *pbase)

int	RemoveParamsBase (const vector< string > &path, ParamsBase *pbase)

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)

virtual ParamNode *	buildNode ()

ParamNode *	GetCurrentNode ()

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

ParamNode *	Pop ()

void	Remove (const string &name)

const map< string, string > &	GetAttributes ()

void	Clear ()

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 VAPoR::Params
virtual int	SetValueLong (string tag, const char *description, long value)

virtual int	SetValueLong (string tag, const char *description, const vector< long > &value)

virtual int	SetValueDouble (string tag, const char *description, double value)

virtual int	SetValueDouble (string tag, const char *description, const vector< double > &value)

virtual int	SetValueString (string tag, const char *description, const string &value)

virtual int	SetValueStringVec (string tag, const char *description, const vector< string > &value)

Protected Member Functions inherited from VetsUtil::MyBase
void	SetClassName (const string &name)

Detailed Description

A class for describing mouse modes in use in VAPOR.

Author: Alan Norton

Version: 3.0

Date: April 2014

Definition at line 44 of file mousemodeparams.h.

Member Enumeration Documentation

enum VAPoR::MouseModeParams::mouseModeType

Enumerator
unknownMode
navigateMode
regionMode
probeMode
twoDDataMode
twoDImageMode
rakeMode
barbMode
isolineMode

Definition at line 67 of file mousemodeparams.h.

Constructor & Destructor Documentation

VAPoR::MouseModeParams::MouseModeParams	(	XmlNode *	parent,
		int	winnum
	)

Constructor

Parameters

[in] int winnum The window number, -1 since it's global

virtual VAPoR::MouseModeParams::~MouseModeParams ( )

virtual

Destructor.

Member Function Documentation

static int VAPoR::MouseModeParams::AddMouseMode	(	const std::string	paramsTag,
		int	manipType,
		const char *	name
	)

static

Static method used to add a new Mouse Mode to the list of available modes.

Parameters

[in]	const	string& tag associated with the Params class
[in]	int	Manipulator type (1,2,or 3)
[in]	const	char* name of mouse mode

Return values

int	Resulting mouse mode

static ParamsBase* VAPoR::MouseModeParams::CreateDefaultInstance ( )

inlinestatic

Required static method (for extensibility):

Return values

ParamsBase* pointer to a default Params instance

Definition at line 84 of file mousemodeparams.h.

static mouseModeType VAPoR::MouseModeParams::GetCurrentMouseMode ( )

inlinestatic

Static method indicates the current mouse mode

Return values

mouseModeType current mouse mode

Definition at line 138 of file mousemodeparams.h.

static const char* const* VAPoR::MouseModeParams::GetIcon ( int modeIndex )

inlinestatic

Static method identifies pixmap icon for each mode.

Definition at line 79 of file mousemodeparams.h.

static int VAPoR::MouseModeParams::getModeFromParams ( string tag )

inlinestatic

Static method that identifies the current mouse mode for a particular params type.

Parameters

[in] ParamsBase::ParamsBaseType t must be the type of a params with an associated mouse mode

Return values

int	Mouse mode

Definition at line 123 of file mousemodeparams.h.

Referenced by VAPoR::Visualizer::getManip().

static int VAPoR::MouseModeParams::getModeManipType ( int modeIndex )

inlinestatic

Static method that indicates the manipulator type that is associated with a mouse mode.

See also: VizWinMgr

Parameters

[in] modeIndex is a positive integer indexing the current mouse modes

Return values

int	manipulator type is 1 (region box) 2 (2D box) or 3 (rotated 3D box).

Definition at line 109 of file mousemodeparams.h.

static const string VAPoR::MouseModeParams::getModeName ( int index )

inlinestatic

Static method that identifies the name associated with a mouse mode. This is the text that is displayed in the mouse mode selector.

Parameters

[in] int Mouse Mode

Return values

const string& Name associated with mode

Definition at line 129 of file mousemodeparams.h.

static std::string VAPoR::MouseModeParams::getModeTag ( int modeIndex )

inlinestatic

Static method that returns the Params type associated with a mouse mode.

Parameters

[in] int modeIndex The mouse mode.

Return values

string The tag of the params associated with the mouse mode.

Definition at line 116 of file mousemodeparams.h.

static int VAPoR::MouseModeParams::getNumMouseModes ( )

inlinestatic

Static method indicates how many mouse modes are available.

Definition at line 147 of file mousemodeparams.h.

const std::string VAPoR::MouseModeParams::getShortName ( )

inlinevirtual

Pure virtual method on Params. Provide a short name suitable for use in the GUI

Return values

string name

Implements VAPoR::Params.

Definition at line 87 of file mousemodeparams.h.

static int VAPoR::MouseModeParams::RegisterMouseMode	(	std::string	tag,
		int	modeType,
		const char *	modeName,
		const char *const	xpmIcon[]
	)

static

Method to register a mouse mode. Called during startup.

Parameters

[in]	tag	Params tag associated with this mouse mode
[in]	modeType	integer identifying this mouse mode, used for selecting
[in]	modeName	name of the mode, identifying it during selection
[in]	xpm	Icon (as an xpm) used when displaying mode in GUI.

static void VAPoR::MouseModeParams::RegisterMouseModes ( )

static

Static method called at startup to register all the built-in mouse modes, by calling RegisterMouseMode() for each built-in mode. Also calls InstallExtensionMouseModes() to register extension modes.

virtual void VAPoR::MouseModeParams::restart ( )

virtual

Method to initialize a new MouseModeParams instance.

Implements VAPoR::Params.

static void VAPoR::MouseModeParams::SetCurrentMouseMode ( mouseModeType t )

inlinestatic

Static method sets the current mouse mode

Parameters

[in] mouseModeType t current mouse mode

Definition at line 143 of file mousemodeparams.h.

virtual void VAPoR::MouseModeParams::Validate ( int type )

virtual

Method to validate all values in a MouseModeParams instance

Parameters

[in] bool default indicates whether or not to set to default values associated with the current DataMgr

See also: DataMgr

Implements VAPoR::Params.

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

/Users/clyne/src/vapor-3.0/lib/params/mousemodeparams.h

Static Public Member Functions

Internal

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation