class that indicates location and direction of view More...

#include <AxisAnnotation.h>

Inheritance diagram for VAPoR::AxisAnnotation:

Public Types
enum	Flags

Public Types inherited from Wasp::MyBase
typedef void(*	ErrMsgCB_T) (const char *msg, int err_code)

typedef void(*	DiagMsgCB_T) (const char *msg)

Public Member Functions
	AxisAnnotation (ParamsBase::StateSave *ssave)

	AxisAnnotation (ParamsBase::StateSave ssave, XmlNode node)

virtual	~AxisAnnotation ()

void	Initialize ()

void	SetAxisAnnotationEnabled (bool val)

bool	GetAxisAnnotationEnabled () const

vector< double >	GetAxisBackgroundColor () const

void	GetAxisBackgroundColor (float bgColor[]) const

void	SetAxisBackgroundColor (vector< double > color)

vector< double >	GetAxisColor () const

void	SetAxisColor (vector< double > color)

void	SetNumTics (vector< double > ticnums)

vector< double >	GetNumTics () const

void	SetAxisOrigin (vector< double > orig)

vector< double >	GetAxisOrigin () const

void	SetMinTics (vector< double > ticmins)

vector< double >	GetMinTics () const

void	SetMaxTics (vector< double > ticmaxs)

vector< double >	GetMaxTics () const

void	SetTicSize (vector< double > ticsizes)

vector< double >	GetTicSize () const

void	SetXTicDir (double dir)

int	GetXTicDir () const

void	SetYTicDir (double dir)

int	GetYTicDir () const

void	SetZTicDir (double dir)

int	GetZTicDir () const

void	SetTicDirs (vector< double > ticdirs)

vector< double >	GetTicDirs () const

double	GetTicWidth () const

void	SetTicWidth (double val)

long	GetAxisTextHeight () const

void	SetAxisTextHeight (long val)

long	GetAxisDigits () const

void	SetAxisDigits (long val)

void	SetLatLonAxesEnabled (bool val)

bool	GetLatLonAxesEnabled () const

string	GetDataMgrName () const

void	SetDataMgrName (string dataMgr)

bool	GetShowAxisArrows () const

void	SetShowAxisArrows (bool val)

void	SetAxisFontSize (int size)

int	GetAxisFontSize () const

bool	GetAxisAnnotationInitialized () const

void	SetAxisAnnotationInitialized (bool val)

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

Static Public Attributes
static const string	_colorTag

static const string	_digitsTag

static const string	_textHeightTag

static const string	_fontSizeTag

static const string	_ticWidthTag

static const string	_ticDirsTag

static const string	_ticSizeTag

static const string	_minTicsTag

static const string	_maxTicsTag

static const string	_numTicsTag

static const string	_originTag

static const string	_backgroundColorTag

static const string	_annotationEnabledTag

static const string	_latLonAxesTag

static const string	_dataMgrTag

static const string	_initializedTag

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

Additional Inherited Members
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

class that indicates location and direction of view

: This class contains all the parameters associated with axis annotations, for a DataMgr or Renderer.

Author: Scott Pearse

Version: 3.0

Date: January 2018

Definition at line 21 of file AxisAnnotation.h.

Member Enumeration Documentation

◆ Flags

enum VAPoR::AxisAnnotation::Flags

Definition at line 23 of file AxisAnnotation.h.

Constructor & Destructor Documentation

◆ AxisAnnotation() [1/2]

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

◆ AxisAnnotation() [2/2]

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

◆ ~AxisAnnotation()

virtual VAPoR::AxisAnnotation::~AxisAnnotation ( )

virtual

Member Function Documentation

◆ GetAxisAnnotationEnabled()

bool VAPoR::AxisAnnotation::GetAxisAnnotationEnabled ( ) const

◆ GetAxisAnnotationInitialized()

bool VAPoR::AxisAnnotation::GetAxisAnnotationInitialized ( ) const

◆ GetAxisBackgroundColor() [1/2]

vector< double > VAPoR::AxisAnnotation::GetAxisBackgroundColor ( ) const

◆ GetAxisBackgroundColor() [2/2]

void VAPoR::AxisAnnotation::GetAxisBackgroundColor ( float bgColor[] ) const

◆ GetAxisColor()

vector< double > VAPoR::AxisAnnotation::GetAxisColor ( ) const

◆ GetAxisDigits()

long VAPoR::AxisAnnotation::GetAxisDigits ( ) const

◆ GetAxisFontSize()

int VAPoR::AxisAnnotation::GetAxisFontSize ( ) const

◆ GetAxisOrigin()

vector< double > VAPoR::AxisAnnotation::GetAxisOrigin ( ) const

◆ GetAxisTextHeight()

long VAPoR::AxisAnnotation::GetAxisTextHeight ( ) const

◆ GetClassType()

static string VAPoR::AxisAnnotation::GetClassType ( )

inlinestatic

Definition at line 92 of file AxisAnnotation.h.

◆ GetDataMgrName()

string VAPoR::AxisAnnotation::GetDataMgrName ( ) const

◆ GetLatLonAxesEnabled()

bool VAPoR::AxisAnnotation::GetLatLonAxesEnabled ( ) const

◆ GetMaxTics()

vector< double > VAPoR::AxisAnnotation::GetMaxTics ( ) const

◆ GetMinTics()

vector< double > VAPoR::AxisAnnotation::GetMinTics ( ) const

◆ GetNumTics()

vector< double > VAPoR::AxisAnnotation::GetNumTics ( ) const

◆ GetShowAxisArrows()

bool VAPoR::AxisAnnotation::GetShowAxisArrows ( ) const

◆ GetTicDirs()

vector< double > VAPoR::AxisAnnotation::GetTicDirs ( ) const

◆ GetTicSize()

vector< double > VAPoR::AxisAnnotation::GetTicSize ( ) const

◆ GetTicWidth()

double VAPoR::AxisAnnotation::GetTicWidth ( ) const

◆ GetXTicDir()

int VAPoR::AxisAnnotation::GetXTicDir ( ) const

◆ GetYTicDir()

int VAPoR::AxisAnnotation::GetYTicDir ( ) const

◆ GetZTicDir()

int VAPoR::AxisAnnotation::GetZTicDir ( ) const

◆ Initialize()

void VAPoR::AxisAnnotation::Initialize ( )

◆ SetAxisAnnotationEnabled()

void VAPoR::AxisAnnotation::SetAxisAnnotationEnabled ( bool val )

◆ SetAxisAnnotationInitialized()

void VAPoR::AxisAnnotation::SetAxisAnnotationInitialized ( bool val )

◆ SetAxisBackgroundColor()

void VAPoR::AxisAnnotation::SetAxisBackgroundColor ( vector< double > color )

◆ SetAxisColor()

void VAPoR::AxisAnnotation::SetAxisColor ( vector< double > color )

◆ SetAxisDigits()

void VAPoR::AxisAnnotation::SetAxisDigits ( long val )

◆ SetAxisFontSize()

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

◆ SetAxisOrigin()

void VAPoR::AxisAnnotation::SetAxisOrigin ( vector< double > orig )

◆ SetAxisTextHeight()

void VAPoR::AxisAnnotation::SetAxisTextHeight ( long val )

◆ SetDataMgrName()

void VAPoR::AxisAnnotation::SetDataMgrName ( string dataMgr )

◆ SetLatLonAxesEnabled()

void VAPoR::AxisAnnotation::SetLatLonAxesEnabled ( bool val )

◆ SetMaxTics()

void VAPoR::AxisAnnotation::SetMaxTics ( vector< double > ticmaxs )

◆ SetMinTics()

void VAPoR::AxisAnnotation::SetMinTics ( vector< double > ticmins )

◆ SetNumTics()

void VAPoR::AxisAnnotation::SetNumTics ( vector< double > ticnums )

◆ SetShowAxisArrows()

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

◆ SetTicDirs()

void VAPoR::AxisAnnotation::SetTicDirs ( vector< double > ticdirs )

◆ SetTicSize()

void VAPoR::AxisAnnotation::SetTicSize ( vector< double > ticsizes )

◆ SetTicWidth()

void VAPoR::AxisAnnotation::SetTicWidth ( double val )

◆ SetXTicDir()

void VAPoR::AxisAnnotation::SetXTicDir ( double dir )

◆ SetYTicDir()

void VAPoR::AxisAnnotation::SetYTicDir ( double dir )

◆ SetZTicDir()

void VAPoR::AxisAnnotation::SetZTicDir ( double dir )

Member Data Documentation

◆ _annotationEnabledTag

const string VAPoR::AxisAnnotation::_annotationEnabledTag

static

Definition at line 106 of file AxisAnnotation.h.

◆ _backgroundColorTag

const string VAPoR::AxisAnnotation::_backgroundColorTag

static

Definition at line 105 of file AxisAnnotation.h.

◆ _colorTag

const string VAPoR::AxisAnnotation::_colorTag

static

Definition at line 94 of file AxisAnnotation.h.

◆ _dataMgrTag

const string VAPoR::AxisAnnotation::_dataMgrTag

static

Definition at line 108 of file AxisAnnotation.h.

◆ _digitsTag

const string VAPoR::AxisAnnotation::_digitsTag

static

Definition at line 95 of file AxisAnnotation.h.

◆ _fontSizeTag

const string VAPoR::AxisAnnotation::_fontSizeTag

static

Definition at line 97 of file AxisAnnotation.h.

◆ _initializedTag

const string VAPoR::AxisAnnotation::_initializedTag

static

Definition at line 109 of file AxisAnnotation.h.

◆ _latLonAxesTag

const string VAPoR::AxisAnnotation::_latLonAxesTag

static

Definition at line 107 of file AxisAnnotation.h.

◆ _maxTicsTag

const string VAPoR::AxisAnnotation::_maxTicsTag

static

Definition at line 102 of file AxisAnnotation.h.

◆ _minTicsTag

const string VAPoR::AxisAnnotation::_minTicsTag

static

Definition at line 101 of file AxisAnnotation.h.

◆ _numTicsTag

const string VAPoR::AxisAnnotation::_numTicsTag

static

Definition at line 103 of file AxisAnnotation.h.

◆ _originTag

const string VAPoR::AxisAnnotation::_originTag

static

Definition at line 104 of file AxisAnnotation.h.

◆ _textHeightTag

const string VAPoR::AxisAnnotation::_textHeightTag

static

Definition at line 96 of file AxisAnnotation.h.

◆ _ticDirsTag

const string VAPoR::AxisAnnotation::_ticDirsTag

static

Definition at line 99 of file AxisAnnotation.h.

◆ _ticSizeTag

const string VAPoR::AxisAnnotation::_ticSizeTag

static

Definition at line 100 of file AxisAnnotation.h.

◆ _ticWidthTag

const string VAPoR::AxisAnnotation::_ticWidthTag

static

Definition at line 98 of file AxisAnnotation.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Flags

Constructor & Destructor Documentation

◆ AxisAnnotation() [1/2]

◆ AxisAnnotation() [2/2]

◆ ~AxisAnnotation()

Member Function Documentation

◆ GetAxisAnnotationEnabled()

◆ GetAxisAnnotationInitialized()

◆ GetAxisBackgroundColor() [1/2]

◆ GetAxisBackgroundColor() [2/2]

◆ GetAxisColor()

◆ GetAxisDigits()

◆ GetAxisFontSize()

◆ GetAxisOrigin()

◆ GetAxisTextHeight()

◆ GetClassType()

◆ GetDataMgrName()

◆ GetLatLonAxesEnabled()

◆ GetMaxTics()

◆ GetMinTics()

◆ GetNumTics()

◆ GetShowAxisArrows()

◆ GetTicDirs()

◆ GetTicSize()

◆ GetTicWidth()

◆ GetXTicDir()

◆ GetYTicDir()

◆ GetZTicDir()

◆ Initialize()

◆ SetAxisAnnotationEnabled()

◆ SetAxisAnnotationInitialized()

◆ SetAxisBackgroundColor()

◆ SetAxisColor()

◆ SetAxisDigits()

◆ SetAxisFontSize()

◆ SetAxisOrigin()

◆ SetAxisTextHeight()

◆ SetDataMgrName()

◆ SetLatLonAxesEnabled()

◆ SetMaxTics()

◆ SetMinTics()

◆ SetNumTics()

◆ SetShowAxisArrows()

◆ SetTicDirs()

◆ SetTicSize()

◆ SetTicWidth()

◆ SetXTicDir()

◆ SetYTicDir()

◆ SetZTicDir()

Member Data Documentation

◆ _annotationEnabledTag

◆ _backgroundColorTag

◆ _colorTag

◆ _dataMgrTag

◆ _digitsTag

◆ _fontSizeTag

◆ _initializedTag

◆ _latLonAxesTag

◆ _maxTicsTag

◆ _minTicsTag

◆ _numTicsTag

◆ _originTag

◆ _textHeightTag

◆ _ticDirsTag

◆ _ticSizeTag

◆ _ticWidthTag