PlotParams inherits RenderParams. More...
#include <PlotParams.h>
Inheritance diagram for VAPoR::PlotParams:
Public Member Functions | |
| PlotParams (DataMgr *dmgr, ParamsBase::StateSave *ssave) | |
| Constructor 1. | |
| PlotParams (DataMgr *dmgr, ParamsBase::StateSave *ssave, XmlNode *node) | |
| Constructor 2. | |
| ~PlotParams () | |
| Destructor. | |
| std::vector< long int > | GetMinMaxTS () const |
| In `‘time mode,’' these 2 methods get/set the time range. | |
| void | SetMinMaxTS (const std::vector< long int > &) |
| std::vector< double > | GetSinglePoint () const |
| In `‘time mode,’' these 2 methods get/set the single point position. | |
| void | SetSinglePoint (const std::vector< double > &point) |
| std::vector< double > | GetPoint1 () const |
| In `‘space mode,’' these 4 methods get/set the point 1 and point 2 positions. | |
| std::vector< double > | GetPoint2 () const |
| void | SetPoint1 (const std::vector< double > &point) |
| void | SetPoint2 (const std::vector< double > &point) |
| std::vector< double > | GetMinExtents () const |
| These 4 methods get/set the up-to-date extents. | |
| std::vector< double > | GetMaxExtents () const |
| void | SetMinExtents (const std::vector< double > &point) |
| void | SetMaxExtents (const std::vector< double > &point) |
| long | GetNumOfSamples () const |
| void | SetNumOfSamples (long) |
| void | SetAxisLocks (const std::vector< bool > &locks) |
| std::vector< bool > | GetAxisLocks () |
| 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 () |
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) |
| 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 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) |
| Protected Attributes inherited from VAPoR::RenderParams | |
| DataMgr * | _dataMgr |
| int | _maxDim |
| Protected Attributes inherited from VAPoR::ParamsBase | |
| StateSave * | _ssave |
| XmlNode * | _node |
Detailed Description
PlotParams inherits RenderParams.
Definition at line 28 of file PlotParams.h.
Constructor & Destructor Documentation
◆ PlotParams() [1/2]
| VAPoR::PlotParams::PlotParams | ( | DataMgr * | dmgr, |
| ParamsBase::StateSave * | ssave | ||
| ) |
Constructor 1.
◆ PlotParams() [2/2]
| VAPoR::PlotParams::PlotParams | ( | DataMgr * | dmgr, |
| ParamsBase::StateSave * | ssave, | ||
| XmlNode * | node | ||
| ) |
Constructor 2.
◆ ~PlotParams()
| VAPoR::PlotParams::~PlotParams | ( | ) |
Destructor.
Member Function Documentation
◆ GetActualColorMapVariableName()
|
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 65 of file PlotParams.h.
◆ GetAxisLocks()
| std::vector< bool > VAPoR::PlotParams::GetAxisLocks | ( | ) |
◆ GetClassType()
|
inlinestatic |
Definition at line 63 of file PlotParams.h.
◆ GetMaxExtents()
| std::vector< double > VAPoR::PlotParams::GetMaxExtents | ( | ) | const |
◆ GetMinExtents()
| std::vector< double > VAPoR::PlotParams::GetMinExtents | ( | ) | const |
These 4 methods get/set the up-to-date extents.
◆ GetMinMaxTS()
| std::vector< long int > VAPoR::PlotParams::GetMinMaxTS | ( | ) | const |
In `‘time mode,’' these 2 methods get/set the time range.
◆ GetNumOfSamples()
| long VAPoR::PlotParams::GetNumOfSamples | ( | ) | const |
◆ GetPoint1()
| std::vector< double > VAPoR::PlotParams::GetPoint1 | ( | ) | const |
In `‘space mode,’' these 4 methods get/set the point 1 and point 2 positions.
◆ GetPoint2()
| std::vector< double > VAPoR::PlotParams::GetPoint2 | ( | ) | const |
◆ GetRenderDim()
|
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 64 of file PlotParams.h.
◆ GetSinglePoint()
| std::vector< double > VAPoR::PlotParams::GetSinglePoint | ( | ) | const |
In `‘time mode,’' these 2 methods get/set the single point position.
◆ SetAxisLocks()
| void VAPoR::PlotParams::SetAxisLocks | ( | const std::vector< bool > & | locks | ) |
◆ SetMaxExtents()
| void VAPoR::PlotParams::SetMaxExtents | ( | const std::vector< double > & | point | ) |
◆ SetMinExtents()
| void VAPoR::PlotParams::SetMinExtents | ( | const std::vector< double > & | point | ) |
◆ SetMinMaxTS()
| void VAPoR::PlotParams::SetMinMaxTS | ( | const std::vector< long int > & | ) |
◆ SetNumOfSamples()
| void VAPoR::PlotParams::SetNumOfSamples | ( | long | ) |
◆ SetPoint1()
| void VAPoR::PlotParams::SetPoint1 | ( | const std::vector< double > & | point | ) |
◆ SetPoint2()
| void VAPoR::PlotParams::SetPoint2 | ( | const std::vector< double > & | point | ) |
◆ SetSinglePoint()
| void VAPoR::PlotParams::SetSinglePoint | ( | const std::vector< double > & | point | ) |
The documentation for this class was generated from the following file:
- /Users/pearse/VAPOR/apps/vaporgui/PlotParams.h
