VAPOR3 3.9.4
|
#include <VolumeParams.h>
Public Types | |
enum class | Type { Any , DVR , Iso } |
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) |
Public Member Functions | |
VolumeParams (DataMgr *dataMgr, ParamsBase::StateSave *ssave) | |
VolumeParams (DataMgr *dataMgr, ParamsBase::StateSave *ssave, std::string classType) | |
VolumeParams (DataMgr *dataMgr, ParamsBase::StateSave *ssave, XmlNode *node) | |
virtual | ~VolumeParams () |
virtual string | GetDefaultAlgorithmName () const |
virtual bool | GetDefaultLightingEnabled () const |
virtual double | GetDefaultPhongAmbient () const |
virtual double | GetDefaultPhongDiffuse () const |
virtual double | GetDefaultPhongSpecular () const |
virtual double | GetDefaultPhongShininess () const |
std::string | GetAlgorithm () const |
void | SetAlgorithm (std::string algorithm) |
void | SetAlgorithmByUser (std::string algorithm) |
bool | GetAlgorithmWasManuallySetByUser () const |
void | SetAlgorithmWasManuallySetByUser (bool v) |
long | GetSamplingMultiplier () const |
void | SetSamplingMultiplier (long d) |
vector< double > | GetIsoValues (const string &variable) override |
void | SetIsoValues (const string &variable, const vector< double > &values) override |
void | SetLightingEnabled (bool v) |
bool | GetLightingEnabled () const |
void | SetPhongAmbient (float v) |
float | GetPhongAmbient () const |
void | SetPhongDiffuse (float v) |
float | GetPhongDiffuse () const |
void | SetPhongSpecular (float v) |
float | GetPhongSpecular () const |
void | SetPhongShininess (float v) |
float | GetPhongShininess () const |
virtual size_t | GetRenderDim () const override |
virtual string | GetActualColorMapVariableName () const override |
virtual vector< double > | GetIsoValues (const string &variable) |
vector< double > | GetIsoValues () |
virtual void | SetIsoValues (const string &variable, const vector< double > &values) |
void | SetIsoValues (const vector< double > &values) |
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 std::vector< float > | GetSamplingRateMultiples () |
static const std::vector< std::string > | GetAlgorithmNames (Type type=Type::Any) |
static void | Register (const std::string &name, Type type=Type::Any) |
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 std::string | _algorithmTag |
static const std::string | UseColormapVariableTag |
If this is enabled, the volume opacity will be controlled by the main variable while the colormapping will be determined by the colormap variable. | |
static const std::string | SamplingRateMultiplierTag |
static const std::string | VolumeDensityTag |
static const std::string | LightingEnabledTag |
static const std::string | PhongAmbientTag |
static const std::string | PhongDiffuseTag |
static const std::string | PhongSpecularTag |
static const std::string | PhongShininessTag |
static const std::string | OSPDensity |
static const std::string | OSPSampleRateScalar |
static const std::string | OSPAmbientLightIntensity |
static const std::string | OSPDirectionalLightIntensity |
static const std::string | OSPVolmeAlgorithmName |
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 |
Additional Inherited Members | |
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 |
Definition at line 9 of file VolumeParams.h.
|
strong |
Enumerator | |
---|---|
Any | |
DVR | |
Iso |
Definition at line 11 of file VolumeParams.h.
VAPoR::VolumeParams::VolumeParams | ( | DataMgr * | dataMgr, |
ParamsBase::StateSave * | ssave | ||
) |
VAPoR::VolumeParams::VolumeParams | ( | DataMgr * | dataMgr, |
ParamsBase::StateSave * | ssave, | ||
std::string | classType | ||
) |
VAPoR::VolumeParams::VolumeParams | ( | DataMgr * | dataMgr, |
ParamsBase::StateSave * | ssave, | ||
XmlNode * | node | ||
) |
|
virtual |
|
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 99 of file VolumeParams.h.
std::string VAPoR::VolumeParams::GetAlgorithm | ( | ) | const |
Get the current raycasting algorithm
string | - Current raycasting algorithm (Regular, Curvilinear, or Ospray) |
|
static |
bool VAPoR::VolumeParams::GetAlgorithmWasManuallySetByUser | ( | ) | const |
|
inlinestatic |
Definition at line 26 of file VolumeParams.h.
|
virtual |
Reimplemented in VAPoR::VolumeIsoParams.
|
inlinevirtual |
Reimplemented in VAPoR::VolumeIsoParams.
Definition at line 20 of file VolumeParams.h.
|
inlinevirtual |
Reimplemented in VAPoR::VolumeIsoParams.
Definition at line 21 of file VolumeParams.h.
|
inlinevirtual |
Definition at line 22 of file VolumeParams.h.
|
inlinevirtual |
Definition at line 24 of file VolumeParams.h.
|
inlinevirtual |
Definition at line 23 of file VolumeParams.h.
|
inline |
Definition at line 391 of file RenderParams.h.
|
inlinevirtual |
Reimplemented from VAPoR::RenderParams.
Definition at line 384 of file RenderParams.h.
|
overridevirtual |
Reimplemented from VAPoR::RenderParams.
bool VAPoR::VolumeParams::GetLightingEnabled | ( | ) | const |
Get the state for whether lighting is enabled or disabled
bool | - State for enabled lighting (1/true) or disabled lighting (0/false) |
float VAPoR::VolumeParams::GetPhongAmbient | ( | ) | const |
Get the Phong Ambient lighting coefficient (https://en.wikipedia.org/wiki/Phong_reflection_model)
[in] | float | - Phong ambient lighting coefficient |
float VAPoR::VolumeParams::GetPhongDiffuse | ( | ) | const |
Get the Phong Diffuse lighting coefficient (https://en.wikipedia.org/wiki/Phong_reflection_model)
[in] | float | - Phong diffuse lighting coefficient |
float VAPoR::VolumeParams::GetPhongShininess | ( | ) | const |
Get the Phong Diffuse lighting coefficient (https://en.wikipedia.org/wiki/Phong_reflection_model)
[in] | float | - Phong shininess lighting coefficient |
float VAPoR::VolumeParams::GetPhongSpecular | ( | ) | const |
Get the Phong Specular lighting coefficient (https://en.wikipedia.org/wiki/Phong_reflection_model)
[in] | float | - Phong specular lighting coefficient |
|
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 96 of file VolumeParams.h.
long VAPoR::VolumeParams::GetSamplingMultiplier | ( | ) | const |
Get the sampling rate multiplier used with the current raycasting algorithm
long | - Sampling rate multiplier |
|
static |
|
static |
void VAPoR::VolumeParams::SetAlgorithm | ( | std::string | algorithm | ) |
Set the current raycasting algorithm
[in] | string | - Raycasting algorithm (Regular, Curvilinear, or Ospray) |
void VAPoR::VolumeParams::SetAlgorithmByUser | ( | std::string | algorithm | ) |
void VAPoR::VolumeParams::SetAlgorithmWasManuallySetByUser | ( | bool | v | ) |
|
inlinevirtual |
Reimplemented from VAPoR::RenderParams.
Definition at line 389 of file RenderParams.h.
|
overridevirtual |
Reimplemented from VAPoR::RenderParams.
|
inline |
Definition at line 392 of file RenderParams.h.
void VAPoR::VolumeParams::SetLightingEnabled | ( | bool | v | ) |
Enable or disable lighting from the position of the camera
[in] | bool | - Enable lighting (1/true) or disable lighting (0/false) |
void VAPoR::VolumeParams::SetPhongAmbient | ( | float | v | ) |
Set the Phong Ambient lighting coefficient (https://en.wikipedia.org/wiki/Phong_reflection_model)
[in] | float | - Phong ambient lighting coefficient |
void VAPoR::VolumeParams::SetPhongDiffuse | ( | float | v | ) |
Set the Phong Diffuse lighting coefficient (https://en.wikipedia.org/wiki/Phong_reflection_model)
[in] | float | - Phong diffuse lighting coefficient |
void VAPoR::VolumeParams::SetPhongShininess | ( | float | v | ) |
Set the Phong Shininess lighting coefficient (https://en.wikipedia.org/wiki/Phong_reflection_model)
[in] | float | - Phong shininess lighting coefficient |
void VAPoR::VolumeParams::SetPhongSpecular | ( | float | v | ) |
Set the Phong Specular lighting coefficient (https://en.wikipedia.org/wiki/Phong_reflection_model)
[in] | float | - Phong specular lighting coefficient |
void VAPoR::VolumeParams::SetSamplingMultiplier | ( | long | d | ) |
Set the sampling rate multiplier used with the current raycasting algorithm
[in] | long | - Sampling rate multiplier |
|
static |
Definition at line 127 of file VolumeParams.h.
|
static |
Definition at line 138 of file VolumeParams.h.
|
static |
Definition at line 146 of file VolumeParams.h.
|
static |
Definition at line 144 of file VolumeParams.h.
|
static |
Definition at line 147 of file VolumeParams.h.
|
static |
Definition at line 145 of file VolumeParams.h.
|
static |
Definition at line 149 of file VolumeParams.h.
|
static |
Definition at line 139 of file VolumeParams.h.
|
static |
Definition at line 140 of file VolumeParams.h.
|
static |
Definition at line 142 of file VolumeParams.h.
|
static |
Definition at line 141 of file VolumeParams.h.
|
static |
Definition at line 131 of file VolumeParams.h.
|
static |
If this is enabled, the volume opacity will be controlled by the main variable while the colormapping will be determined by the colormap variable.
Definition at line 130 of file VolumeParams.h.
|
static |
The VolumeDensityTag applies an opacity factor to the entirety of the volume rendering in addition to the opacity applied in the Transfer Function. Values range between 0.0 (completely transparent) and 1.0 (completely opaque).
Definition at line 136 of file VolumeParams.h.