A class for describing visual features displayed in the visualizer. More...

#include <AnnotationsParams.h>

Inheritance diagram for VAPoR::AnnotationsParams:

Public Member Functions
	AnnotationsParams (ParamsBase::StateSave *ssave)
	Create a AnnotationsParams object from scratch.

	AnnotationsParams (ParamsBase::StateSave ssave, XmlNode node)
	Create a AnnotationsParams object from an existing XmlNode tree.

	AnnotationsParams (const AnnotationsParams &rhs)
	Copy from already existing instance.

virtual	~AnnotationsParams ()

void	GetDomainColor (double color[3]) const
	Obtain domain frame color.

void	GetDomainColor (std::vector< double > &color) const

void	SetDomainColor (vector< double > color)
	Set domain frame color.

bool	GetUseDomainFrame () const

void	SetUseDomainFrame (bool onOff)

bool	GetUseRegionFrame () const

void	SetUseRegionFrame (bool onOff)

void	GetRegionColor (double color[3]) const
	Obtain region frame color.

void	GetRegionColor (std::vector< double > &color) const

void	SetRegionColor (vector< double > color)
	Set region frame color.

void	GetBackgroundColor (double color[3]) const
	Obtain background color.

void	GetBackgroundColor (std::vector< double > &color) const

void	SetBackgroundColor (std::vector< double > color)
	Set background color.

string	GetCurrentAxisDataMgrName () const

void	SetCurrentAxisDataMgrName (string dataMgr)

AxisAnnotation *	GetAxisAnnotation (string dataMgr="")

void	SetAxisArrowCoords (std::vector< double > coords)

std::vector< double >	GetAxisArrowCoords () const

bool	GetShowAxisArrows () const

void	SetShowAxisArrows (bool val)

void	SetAxisFontSize (int size)

int	GetAxisFontSize ()

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 visual features displayed in the visualizer.

The AnnotationsParams class controls various features displayed in the visualizers There is a global AnnotationsParams, that is shared by all windows whose vizfeature is set to "global". There is also a local AnnotationsParams 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 AnnotationsParams class also has several methods that are useful in setting up data requests from the DataMgr.

Author: Alan Norton

Version: 3.0

Date: June 2015

Definition at line 50 of file AnnotationsParams.h.

Constructor & Destructor Documentation

◆ AnnotationsParams() [1/3]

VAPoR::AnnotationsParams::AnnotationsParams ( ParamsBase::StateSave * ssave )

Create a AnnotationsParams object from scratch.

◆ AnnotationsParams() [2/3]

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

Create a AnnotationsParams object from an existing XmlNode tree.

◆ AnnotationsParams() [3/3]

VAPoR::AnnotationsParams::AnnotationsParams ( const AnnotationsParams & rhs )

Copy from already existing instance.

◆ ~AnnotationsParams()

virtual VAPoR::AnnotationsParams::~AnnotationsParams ( )

inlinevirtual

Definition at line 64 of file AnnotationsParams.h.

Member Function Documentation

◆ GetAxisAnnotation()

AxisAnnotation * VAPoR::AnnotationsParams::GetAxisAnnotation ( string dataMgr = "" )

◆ GetAxisArrowCoords()

std::vector< double > VAPoR::AnnotationsParams::GetAxisArrowCoords ( ) const

◆ GetAxisFontSize()

int VAPoR::AnnotationsParams::GetAxisFontSize ( )

◆ GetBackgroundColor() [1/2]

void VAPoR::AnnotationsParams::GetBackgroundColor ( double color[3] ) const

Obtain background color.

◆ GetBackgroundColor() [2/2]

void VAPoR::AnnotationsParams::GetBackgroundColor ( std::vector< double > & color ) const

inline

Definition at line 88 of file AnnotationsParams.h.

◆ GetClassType()

static string VAPoR::AnnotationsParams::GetClassType ( )

inlinestatic

Definition at line 109 of file AnnotationsParams.h.

◆ GetCurrentAxisDataMgrName()

string VAPoR::AnnotationsParams::GetCurrentAxisDataMgrName ( ) const

◆ GetDomainColor() [1/2]

void VAPoR::AnnotationsParams::GetDomainColor ( double color[3] ) const

Obtain domain frame color.

◆ GetDomainColor() [2/2]

void VAPoR::AnnotationsParams::GetDomainColor ( std::vector< double > & color ) const

inline

Definition at line 68 of file AnnotationsParams.h.

◆ GetRegionColor() [1/2]

void VAPoR::AnnotationsParams::GetRegionColor ( double color[3] ) const

Obtain region frame color.

◆ GetRegionColor() [2/2]

void VAPoR::AnnotationsParams::GetRegionColor ( std::vector< double > & color ) const

inline

Definition at line 81 of file AnnotationsParams.h.

◆ GetShowAxisArrows()

bool VAPoR::AnnotationsParams::GetShowAxisArrows ( ) const

◆ GetUseDomainFrame()

bool VAPoR::AnnotationsParams::GetUseDomainFrame ( ) const

inline

Definition at line 73 of file AnnotationsParams.h.

◆ GetUseRegionFrame()

bool VAPoR::AnnotationsParams::GetUseRegionFrame ( ) const

inline

Definition at line 76 of file AnnotationsParams.h.

◆ SetAxisArrowCoords()

void VAPoR::AnnotationsParams::SetAxisArrowCoords ( std::vector< double > coords )

◆ SetAxisFontSize()

void VAPoR::AnnotationsParams::SetAxisFontSize ( int size )

◆ SetBackgroundColor()

void VAPoR::AnnotationsParams::SetBackgroundColor ( std::vector< double > color )

Set background color.

◆ SetCurrentAxisDataMgrName()

void VAPoR::AnnotationsParams::SetCurrentAxisDataMgrName ( string dataMgr )

◆ SetDomainColor()

void VAPoR::AnnotationsParams::SetDomainColor ( vector< double > color )

Set domain frame color.

◆ SetRegionColor()

void VAPoR::AnnotationsParams::SetRegionColor ( vector< double > color )

Set region frame color.

◆ SetShowAxisArrows()

void VAPoR::AnnotationsParams::SetShowAxisArrows ( bool val )

◆ SetUseDomainFrame()

void VAPoR::AnnotationsParams::SetUseDomainFrame ( bool onOff )

inline

Definition at line 74 of file AnnotationsParams.h.

◆ SetUseRegionFrame()

void VAPoR::AnnotationsParams::SetUseRegionFrame ( bool onOff )

inline

Definition at line 77 of file AnnotationsParams.h.

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

/Users/pearse/VAPOR/include/vapor/AnnotationsParams.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AnnotationsParams() [1/3]

◆ AnnotationsParams() [2/3]

◆ AnnotationsParams() [3/3]

◆ ~AnnotationsParams()

Member Function Documentation

◆ GetAxisAnnotation()

◆ GetAxisArrowCoords()

◆ GetAxisFontSize()

◆ GetBackgroundColor() [1/2]

◆ GetBackgroundColor() [2/2]

◆ GetClassType()

◆ GetCurrentAxisDataMgrName()

◆ GetDomainColor() [1/2]

◆ GetDomainColor() [2/2]

◆ GetRegionColor() [1/2]

◆ GetRegionColor() [2/2]

◆ GetShowAxisArrows()

◆ GetUseDomainFrame()

◆ GetUseRegionFrame()

◆ SetAxisArrowCoords()

◆ SetAxisFontSize()

◆ SetBackgroundColor()

◆ SetCurrentAxisDataMgrName()

◆ SetDomainColor()

◆ SetRegionColor()

◆ SetShowAxisArrows()

◆ SetUseDomainFrame()

◆ SetUseRegionFrame()