VAPOR3 3.9.4
Public Types | Public Member Functions | Protected Member Functions | List of all members
PTFEditor Class Reference

#include <PTFEditor.h>

Inheritance diagram for PTFEditor:
PWidget UWidget VContainer Updateable PColormapTFEditor

Public Types

enum  Element {
  Opacity , Histogram , Colormap , IsoValues ,
  RegularIsoArray , Default
}
 

Public Member Functions

 PTFEditor ()
 
 PTFEditor (const std::string &tag, const std::set< Element > elements={Default}, const std::string &label="Transfer Function")
 
PTFEditorShowOpacityBasedOnParam (const std::string &tag, int value)
 
PTFEditorShowColormapBasedOnParam (const std::string &tag, int value)
 
- Public Member Functions inherited from PWidget
 PWidget (const std::string &tag, QWidget *widget)
 
void Update (VAPoR::ParamsBase *params, VAPoR::ParamsMgr *paramsMgr=nullptr, VAPoR::DataMgr *dataMgr=nullptr) override
 Follows the Vapor GUI update function convention. Update the element.
 
PWidgetShowBasedOnParam (const std::string &tag, int whenEqualTo=true)
 
PWidgetEnableBasedOnParam (const std::string &tag, int whenEqualTo=true)
 
PWidgetSetTooltip (const std::string &text)
 
void setToolTip (const QString &)=delete
 
- Public Member Functions inherited from UWidget
 VContainer (QWidget *w)
 
- Public Member Functions inherited from VContainer
 VContainer (QWidget *w)
 
void AddBottomStretch ()
 
void SetPadding (int left, int top, int right, int bottom)
 
QLayout * layout () const =delete
 
void setLayout (QLayout *)=delete
 
virtual void Update (VAPoR::ParamsBase *params, VAPoR::ParamsMgr *paramsMgr=nullptr, VAPoR::DataMgr *dataMgr=nullptr)=0
 

Protected Member Functions

void updateGUI () const override
 
- Protected Member Functions inherited from PWidget
virtual void updateGUI () const =0
 
virtual bool requireParamsMgr () const
 
virtual bool requireDataMgr () const
 
virtual bool isShown () const
 
virtual bool isEnabled () const
 
const std::string & getTag () const
 
VAPoR::ParamsBasegetParams () const
 
VAPoR::ParamsMgrgetParamsMgr () const
 
VAPoR::DataMgrgetDataMgr () const
 
SettingsParamsgetSettingsParams () const
 
void setParamsDouble (double v)
 
void setParamsLong (long v)
 
void setParamsString (const std::string &v)
 
double getParamsDouble () const
 
long getParamsLong () const
 
std::string getParamsString () const
 
template<class T >
T * getParams () const
 

Detailed Description

PWidget wrapper for TFEditor

Definition at line 48 of file PTFEditor.h.

Member Enumeration Documentation

◆ Element

Enumerator
Opacity 
Histogram 
Colormap 
IsoValues 
RegularIsoArray 
Default 

Definition at line 72 of file PTFEditor.h.

Constructor & Destructor Documentation

◆ PTFEditor() [1/2]

PTFEditor::PTFEditor ( )

◆ PTFEditor() [2/2]

PTFEditor::PTFEditor ( const std::string &  tag,
const std::set< Element elements = {Default},
const std::string &  label = "Transfer Function" 
)

References Default.

Member Function Documentation

◆ ShowColormapBasedOnParam()

PTFEditor * PTFEditor::ShowColormapBasedOnParam ( const std::string &  tag,
int  value 
)

Behaves the same as PWidget::ShowBasedOnParam except shows/hides the colormap controls.

tag must be a key referencing a long value in the Params Database. If the associated value is equal to whenEqualTo, the current widget will be shown/enabled, and hidden/disabled otherwise.

◆ ShowOpacityBasedOnParam()

PTFEditor * PTFEditor::ShowOpacityBasedOnParam ( const std::string &  tag,
int  value 
)

Behaves the same as PWidget::ShowBasedOnParam except shows/hides the opacity controls.

tag must be a key referencing a long value in the Params Database. If the associated value is equal to whenEqualTo, the current widget will be shown/enabled, and hidden/disabled otherwise.

◆ updateGUI()

void PTFEditor::updateGUI ( ) const
overrideprotectedvirtual

Implements PWidget.


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