Class that supports drawing Barbs based on 2D or 3D vector field. More...

#include <arrowparams.h>

Inheritance diagram for VAPoR::ArrowParams:

Public Member Functions
	ArrowParams (XmlNode *parent, int winnum)

const std::string	getShortName ()

virtual	~ArrowParams ()

virtual void	restart ()

virtual Box *	GetBox ()

virtual void	Validate (int type)

virtual bool	IsOpaque ()

virtual bool	usingVariable (const std::string &varname)

double	GetLineThickness ()

int	SetLineThickness (double val)

double	GetVectorScale ()

int	SetVectorScale (double val)

int	SetConstantColor (const double rgb[3])

const vector< double >	GetConstantColor ()

int	SetVariables3D (bool val)

bool	VariablesAre3D ()

double	calcDefaultScale ()

Public Member Functions inherited from VAPoR::RenderParams
virtual bool	IsEnabled ()

virtual void	SetEnabled (bool val)

virtual void	SetVariableName (string varName)

const string	GetVariableName ()

const string	GetFirstVariableName ()

virtual void	SetFieldVariableNames (vector< string > varNames)

const vector< string >	GetFieldVariableNames ()

bool	IsTerrainMapped ()

int	SetTerrainMapped (bool val)

virtual void	SetRendererName (const string &renName)

virtual const string	GetRendererName ()

virtual int	SetRefinementLevel (int numrefinements)

virtual int	GetRefinementLevel ()

virtual int	GetCompressionLevel ()

virtual int	SetCompressionLevel (int val)

void	setBypass (int timestep)

void	setPartialBypass (int timestep)

void	setAllBypass (bool val)

bool	doBypass (int ts)

bool	doAlwaysBypass (int ts)

virtual int	GetFidelityLevel ()

virtual void	SetFidelityLevel (int level)

virtual bool	GetIgnoreFidelity ()

virtual void	SetIgnoreFidelity (bool val)

void	SetFidelityToDefaults ()

void	SetHistoStretch (float factor)

float	GetHistoStretch ()

double	getMinEditBound ()

double	getMaxEditBound ()

void	setMinEditBound (double val)

void	setMaxEditBound (double val)

void	SetEditBounds (vector< double >bounds)

virtual MapperFunction *	GetMapperFunc ()

void	SetCursorCoords (const vector< double > &coords)

const vector< double >	GetCursorCoords ()

const vector< long >	GetGrid ()

int	SetGrid (const int grid[3])

int	AlignGridToData (bool val)

bool	IsAlignedToData ()

const vector< long >	GetGridAlignStrides ()

int	SetGridAlignStrides (const vector< long > &strides)

void	getDataAlignment (double rakeExts[6], int rakeGrid[3], size_t timestep)

virtual int	SetHeightVariableName (const string &varName)

virtual const string	GetHeightVariableName ()

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

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

	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 Member Functions
static ParamsBase *	CreateDefaultInstance ()

Static Public Member Functions inherited from VAPoR::RenderParams
static void	InsertParamsInstance (int pType, int winnum, int posn, RenderParams *dp)

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)

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

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

Class that supports drawing Barbs based on 2D or 3D vector field.

Author: Alan Norton

Version: 3.0

Date: February 2014

Definition at line 17 of file arrowparams.h.

Constructor & Destructor Documentation

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

virtual VAPoR::ArrowParams::~ArrowParams ( )

virtual

Member Function Documentation

double VAPoR::ArrowParams::calcDefaultScale ( )

Utility function to calculate default vector scale factor, based on currently selected vector fields. Used in gui setup

Return values

double scale factor

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

inlinestatic

Required static method for extensibility:

Return values

ParamsBase* pointer to a default Params instance

Definition at line 22 of file arrowparams.h.

virtual Box* VAPoR::ArrowParams::GetBox ( )

inlinevirtual

Method to retrieve the Box describing the rake extents

Return values

Box*

Reimplemented from VAPoR::Params.

Definition at line 35 of file arrowparams.h.

const vector<double> VAPoR::ArrowParams::GetConstantColor ( )

Determine the current color (in r,g,b)

Return values

const double rgb[3];

double VAPoR::ArrowParams::GetLineThickness ( )

inline

Determine line thickness in voxels

Return values

double line thickness

Definition at line 61 of file arrowparams.h.

const std::string VAPoR::ArrowParams::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 27 of file arrowparams.h.

double VAPoR::ArrowParams::GetVectorScale ( )

inline

Get the scale factor for vector length. 1.0 is (scene diameter)/100. A default value is provided to deal with older session files that did not specify the scale.

Return values

double scale factor

Definition at line 75 of file arrowparams.h.

virtual bool VAPoR::ArrowParams::IsOpaque ( )

inlinevirtual

Required virtual method, indicates whether the geometry is opaque or not Currently is always true

Returns: true

Implements VAPoR::RenderParams.

Definition at line 47 of file arrowparams.h.

virtual void VAPoR::ArrowParams::restart ( )

virtual

Note that a box is created in the restart() method, and added as a child node to the root ParamNode. The Box instance will be deleted whenever the ArrowParams is deleted.

Implements VAPoR::Params.

int VAPoR::ArrowParams::SetConstantColor ( const double rgb[3] )

Specify the color of barbs. Color rgb values between 0 and 1

Parameters

[in] const double rgb[3]

Return values

0	if successful

int VAPoR::ArrowParams::SetLineThickness ( double val )

inline

Set the line thickness

Parameters

[in] double thickness

Return values

int	0 if success

Definition at line 68 of file arrowparams.h.

int VAPoR::ArrowParams::SetVariables3D ( bool val )

inlinevirtual

Specify whether 3D or 2D field variables are being used

Parameters

[in] bool true if 3D, false if 2D.

Return values

true	if successful;

Reimplemented from VAPoR::RenderParams.

Definition at line 96 of file arrowparams.h.

int VAPoR::ArrowParams::SetVectorScale ( double val )

Set the scale factor for vector length

Parameters

[in] double scale factor

Return values

0	if successful

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

inlinevirtual

Determine if the specified variable is being used in this Params

Implements VAPoR::RenderParams.

Definition at line 51 of file arrowparams.h.

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

virtual

Validate current settings

Parameters

[in] bool useDefault determines whether or not to set values to default.

Implements VAPoR::Params.

bool VAPoR::ArrowParams::VariablesAre3D ( )

inlinevirtual

Determine whether 3D field variables are being used. Default value is provided for older session files that did not specify variable dimension.

Return values

bool	true if 3D, false if 2D

Reimplemented from VAPoR::RenderParams.

Definition at line 106 of file arrowparams.h.

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation