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

#include <BarbParams.h>

Inheritance diagram for VAPoR::BarbParams:

Public Member Functions
	BarbParams (DataMgr dataMgr, ParamsBase::StateSave ssave)

	BarbParams (DataMgr dataMgr, ParamsBase::StateSave ssave, XmlNode *node)

virtual	~BarbParams ()

bool	GetNeedToRecalculateScales () const

void	SetNeedToRecalculateScales (bool val)

double	GetLengthScale () const

void	SetLengthScale (double val)

const vector< long >	GetGrid () const

void	SetGrid (const int grid[3])

double	GetLineThickness () const

void	SetLineThickness (double val)

virtual size_t	GetRenderDim () const override

virtual string	GetActualColorMapVariableName () const override

Public Member Functions inherited from VAPoR::RenderParams
	RenderParams (DataMgr dataMgr, ParamsBase::StateSave ssave, const string &classname, int maxdim=3)

	RenderParams (DataMgr dataMgr, ParamsBase::StateSave ssave, XmlNode *node, int maxdim=3)

	RenderParams (const RenderParams &rhs)

RenderParams &	operator= (const RenderParams &rhs)

virtual	~RenderParams ()

virtual int	Initialize ()

int	ResetUserExtentsToDataExents (string var="")

virtual bool	IsEnabled () const

virtual void	SetEnabled (bool val)

virtual void	SetVariableName (string varName)

string	GetVariableName () const

virtual void	SetAuxVariableNames (vector< string > varName)

vector< string >	GetAuxVariableNames () const

bool	UseAuxVariable () const

string	GetFirstVariableName () const

virtual void	SetFieldVariableNames (vector< string > varNames)

void	SetXFieldVariableName (std::string varName)

void	SetYFieldVariableName (std::string varName)

void	SetZFieldVariableName (std::string varName)

vector< string >	GetFieldVariableNames () const

std::string	GetXFieldVariableName () const

std::string	GetYFieldVariableName () const

std::string	GetZFieldVariableName () const

vector< string >	GetDistribVariableNames () const

virtual void	SetRefinementLevel (int numrefinements)

virtual int	GetRefinementLevel () const

virtual int	GetCompressionLevel () const

virtual void	SetCompressionLevel (int val)

void	SetHistoStretch (float factor)

float	GetHistoStretch () const

virtual ColorbarPbase *	GetColorbarPbase () const
	Obtain ColorbarPBase (used to specify Color Bar properties) from RenderParams.

virtual void	SetColorbarPbase (ColorbarPbase *pb)

virtual MapperFunction *	GetMapperFunc (string varname)

virtual void	RemoveMapperFunc (string varname)
	Remove the mapper function for the named variable.

virtual void	SetMapperFunc (string varname, MapperFunction *tf)

virtual Box *	GetBox () const

void	SetCursorCoords (const float coords[2])

void	GetCursorCoords (float coords[2]) const

virtual void	SetHeightVariableName (string varname)

virtual string	GetHeightVariableName () const

bool	UseSingleColor () const

virtual void	SetColorMapVariableName (string varname)

virtual string	GetColorMapVariableName () const

virtual string	GetActualColorMapVariableName () const =0

void	SetUseSingleColor (bool val)

void	SetConstantColor (const float rgb[3])

void	SetConstantColor (vector< float > rgb)

void	GetConstantColor (float rgb[3]) const

vector< float >	GetConstantColor () const

void	SetConstantOpacity (float o)

float	GetConstantOpacity () const

size_t	GetCurrentTimestep () const

void	SetCurrentTimestep (size_t ts)

virtual Transform *	GetTransform () const
	Access the transform used by the renderer.

void	initializeBypassFlags ()

virtual void	SetDefaultVariables (int dim, bool secondaryColormapVariable)

virtual size_t	GetRenderDim () const =0

virtual bool	HasIsoValues () const
	This should be overriden by params for renderes that support iso values to return true.

virtual vector< double >	GetIsoValues (const string &variable)

virtual void	SetIsoValues (const string &variable, const vector< double > &values)

vector< double >	GetIsoValues ()

void	SetIsoValues (const vector< double > &values)

virtual bool	GetOrientable () const
	Return whether a renderer can be oriented - IE, can this renderer be rotated about an origin point?

vector< double >	GetSlicePlaneRotation () const

vector< double >	GetSlicePlaneOrigin () const

vector< double >	GetSlicePlaneNormal () const

double	GetXSlicePlaneOrigin () const

double	GetYSlicePlaneOrigin () const

double	GetZSlicePlaneOrigin () const

void	SetXSlicePlaneOrigin (double xOrigin)

void	SetYSlicePlaneOrigin (double yOrigin)

void	SetZSlicePlaneOrigin (double zOrigin)

void	SetSlicePlaneQuad (const std::vector< CoordType > &quad)

std::vector< CoordType >	GetSlicePlaneQuad () const

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	_needToRecalculateScalesTag

static const string	_lengthScaleTag

static const string	_thicknessScaleTag

static const string	_xBarbsCountTag
	Number of barbs displayed on X axis.

static const string	_yBarbsCountTag
	Number of barbs displayed on Y axis.

static const string	_zBarbsCountTag
	Number of barbs displayed on Z axis.

static const string	_alignGridTag

static const string	_alignGridStridesTag

static const string	_varsAre3dTag

Static Public Attributes inherited from VAPoR::RenderParams
static const string	_variableNameTag

static const string	_colorMapVariableNameTag

static const string	_heightVariableNameTag

static const string	_useSingleColorTag

static const string	_constantColorTag

static const string	_CompressionLevelTag

static const string	_RefinementLevelTag

static const string	_xFieldVariableNameTag

static const string	_yFieldVariableNameTag

static const string	_zFieldVariableNameTag

static const string	_constantOpacityTag

static const string	CustomHistogramDataTag

static const string	CustomHistogramRangeTag

static const string	LightingEnabledTag

static const string	UserNameTag

static const string	XSlicePlaneOriginTag

static const string	YSlicePlaneOriginTag

static const string	ZSlicePlaneOriginTag

static const string	XSlicePlaneRotationTag

static const string	YSlicePlaneRotationTag

static const string	ZSlicePlaneRotationTag

static const string	SampleRateTag

static const string	SliceOffsetTag

static const string	SlicePlaneNormalXTag

static const string	SlicePlaneNormalYTag

static const string	SlicePlaneNormalZTag

static const string	SlicePlaneOrientationModeTag

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
virtual bool	GetUseSingleColorDefault () const override

Protected Member Functions inherited from VAPoR::RenderParams
bool	InitBoxFromVariable (size_t ts, string varName)

virtual bool	GetUseSingleColorDefault () const

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)

Additional Inherited Members
Public Types inherited from VAPoR::RenderParams
enum class	SlicePlaneOrientationMode { Rotation = 0 , Normal = 1 }

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

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

Protected Attributes inherited from VAPoR::RenderParams
DataMgr *	_dataMgr

int	_maxDim

Protected Attributes inherited from VAPoR::ParamsBase
StateSave *	_ssave

XmlNode *	_node

Detailed Description

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

Author: Scott Pearse

Version: 3.0

Date: June 2017

Definition at line 15 of file BarbParams.h.

Constructor & Destructor Documentation

◆ BarbParams() [1/2]

VAPoR::BarbParams::BarbParams	(	DataMgr *	dataMgr,
		ParamsBase::StateSave *	ssave
	)

◆ BarbParams() [2/2]

VAPoR::BarbParams::BarbParams	(	DataMgr *	dataMgr,
		ParamsBase::StateSave *	ssave,
		XmlNode *	node
	)

◆ ~BarbParams()

virtual VAPoR::BarbParams::~BarbParams ( )

virtual

Member Function Documentation

◆ GetActualColorMapVariableName()

virtual string VAPoR::BarbParams::GetActualColorMapVariableName ( ) const

inlineoverridevirtual

Due to legacy code, the "ColorMapVariableName" is not the name of the variable by which the renderer is colormapping, but rather the variable it should use if it is not already using its primary variable or a constant color. This function should return the name of the variable that is currently being used for colormapping.

Implements VAPoR::RenderParams.

Definition at line 79 of file BarbParams.h.

◆ GetClassType()

static string VAPoR::BarbParams::GetClassType ( )

inlinestatic

Definition at line 66 of file BarbParams.h.

◆ GetGrid()

const vector< long > VAPoR::BarbParams::GetGrid ( ) const

inline

Determine the size of the discrete grid E.g. the grid on which barbs are placed.

Return values

vector<long> grid

Definition at line 37 of file BarbParams.h.

◆ GetLengthScale()

double VAPoR::BarbParams::GetLengthScale ( ) const

inline

Get the length scaling factor

Return values

double scale factor

Definition at line 30 of file BarbParams.h.

◆ GetLineThickness()

double VAPoR::BarbParams::GetLineThickness ( ) const

inline

Query line thickness as a multiplier that's applied to the default value.

Return values

double line thickness.

Definition at line 58 of file BarbParams.h.

◆ GetNeedToRecalculateScales()

bool VAPoR::BarbParams::GetNeedToRecalculateScales ( ) const

inline

Definition at line 23 of file BarbParams.h.

◆ GetRenderDim()

virtual size_t VAPoR::BarbParams::GetRenderDim ( ) const

inlineoverridevirtual

Return the renderer's current dimension

For renderers that are only capable of operating on variables of a fixed dimensionality (e.g. 2D or 3D) this function will return a constant value: the number of dimensions. For renderers that can operate on a variable of varying dimension this method returns the current dimensionality. The returned value will be between 0 and 3. A value of zero will be returned if the current dimensionality cannot be determined.

Implements VAPoR::RenderParams.

Definition at line 70 of file BarbParams.h.

◆ GetUseSingleColorDefault()

virtual bool VAPoR::BarbParams::GetUseSingleColorDefault ( ) const

inlineoverrideprotectedvirtual

Reimplemented from VAPoR::RenderParams.

Definition at line 88 of file BarbParams.h.

◆ SetGrid()

void VAPoR::BarbParams::SetGrid ( const int grid[3] )

inline

Specify the size of a discrete grid E.g. the grid on which barbs are placed.

Parameters

[in] int array of size 3 - Specifies the barb distribution on the X, Y, and Z axes.

Definition at line 49 of file BarbParams.h.

◆ SetLengthScale()

void VAPoR::BarbParams::SetLengthScale ( double val )

inline

Definition at line 32 of file BarbParams.h.

◆ SetLineThickness()

void VAPoR::BarbParams::SetLineThickness ( double val )

inline

Set line thickness as a multiplier that's applied to the default value.

Parameters

[in] double - Line thickness.

Definition at line 62 of file BarbParams.h.

◆ SetNeedToRecalculateScales()

void VAPoR::BarbParams::SetNeedToRecalculateScales ( bool val )

Member Data Documentation

◆ _alignGridStridesTag

const string VAPoR::BarbParams::_alignGridStridesTag

static

Definition at line 104 of file BarbParams.h.

◆ _alignGridTag

const string VAPoR::BarbParams::_alignGridTag

static

Definition at line 103 of file BarbParams.h.

◆ _lengthScaleTag

const string VAPoR::BarbParams::_lengthScaleTag

static

Definition at line 95 of file BarbParams.h.

◆ _needToRecalculateScalesTag

const string VAPoR::BarbParams::_needToRecalculateScalesTag

static

Definition at line 94 of file BarbParams.h.

◆ _thicknessScaleTag

const string VAPoR::BarbParams::_thicknessScaleTag

static

Definition at line 96 of file BarbParams.h.

◆ _varsAre3dTag

const string VAPoR::BarbParams::_varsAre3dTag

static

Definition at line 105 of file BarbParams.h.

◆ _xBarbsCountTag

const string VAPoR::BarbParams::_xBarbsCountTag

static

Number of barbs displayed on X axis.

Definition at line 98 of file BarbParams.h.

◆ _yBarbsCountTag

const string VAPoR::BarbParams::_yBarbsCountTag

static

Number of barbs displayed on Y axis.

Definition at line 100 of file BarbParams.h.

◆ _zBarbsCountTag

const string VAPoR::BarbParams::_zBarbsCountTag

static

Number of barbs displayed on Z axis.

Definition at line 102 of file BarbParams.h.

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BarbParams() [1/2]

◆ BarbParams() [2/2]

◆ ~BarbParams()

Member Function Documentation

◆ GetActualColorMapVariableName()

◆ GetClassType()

◆ GetGrid()

◆ GetLengthScale()

◆ GetLineThickness()

◆ GetNeedToRecalculateScales()

◆ GetRenderDim()

◆ GetUseSingleColorDefault()

◆ SetGrid()

◆ SetLengthScale()

◆ SetLineThickness()

◆ SetNeedToRecalculateScales()

Member Data Documentation

◆ _alignGridStridesTag

◆ _alignGridTag

◆ _lengthScaleTag

◆ _needToRecalculateScalesTag

◆ _thicknessScaleTag

◆ _varsAre3dTag

◆ _xBarbsCountTag

◆ _yBarbsCountTag

◆ _zBarbsCountTag