Image Component Library (ICL)
Public Member Functions | Static Private Member Functions | List of all members
icl::qt::Plot Struct Reference

a 2D function and data plotting component More...

#include <GUIComponents.h>

Inheritance diagram for icl::qt::Plot:
icl::qt::GUIComponent

Public Member Functions

 Plot (const utils::Range32f xRange=utils::Range32f(0, 0), const utils::Range32f yRange=utils::Range32f(0, 0), bool useOpenGL=false, const std::string &xLabel="", const std::string &yLabel="")
 Create Plot component with optionally given range parameters. More...
 
 Plot (float minX, float maxX=0, float minY=0, float maxY=0, bool useOpenGL=false, const std::string &xLabel="", const std::string &yLabel="")
 Create Plot component with optionally given POD parameters. More...
 
- Public Member Functions inherited from icl::qt::GUIComponent
const GUIComponenthandle (const std::string &handle) const
 sets the component handle More...
 
const GUIComponentlabel (const std::string &label) const
 sets the component label More...
 
const GUIComponenttooltip (const std::string &tooltip) const
 sets the component tooltip More...
 
const GUIComponentsize (const utils::Size &size) const
 sets the component initial size More...
 
const GUIComponentsize (int w, int h) const
 sets the component initial size More...
 
const GUIComponentminSize (const utils::Size &minSize) const
 sets the component minimum size constraint More...
 
const GUIComponentminSize (int w, int h) const
 sets the component minimum size constraint More...
 
const GUIComponentmaxSize (const utils::Size &maxSize) const
 sets the component maximum size constraint More...
 
const GUIComponentmaxSize (int w, int h) const
 sets the component maximum size constraint More...
 
const GUIComponenthideIf (bool flag) const
 hides the component if the given flag is true More...
 
GUIComponenthandle (std::string &handle)
 sets the component handle More...
 
GUIComponentlabel (std::string &label)
 sets the component label More...
 
GUIComponenttooltip (std::string &tooltip)
 sets the component tooltip More...
 
GUIComponentsize (utils::Size &size)
 sets the component initial size More...
 
GUIComponentsize (int w, int h)
 sets the component initial size More...
 
GUIComponentminSize (utils::Size &minSize)
 sets the component minimum size constraint More...
 
GUIComponentminSize (int w, int h)
 sets the component minimum size constraint More...
 
GUIComponentmaxSize (utils::Size &maxSize)
 sets the component maximum size constraint More...
 
GUIComponentmaxSize (int w, int h)
 sets the component maximum size constraint More...
 
GUIComponenthideIf (bool flag)
 hides the component if the given flag is true More...
 
std::string toString () const
 creates a string representation of the component More...
 

Static Private Member Functions

static std::string form_args (const utils::Range32f xRange, const utils::Range32f yRange, bool useOpenGL, const std::string &xLabel, const std::string &yLabel)
 utility method More...
 

Additional Inherited Members

- Protected Member Functions inherited from icl::qt::GUIComponent
 GUIComponent (const std::string &type, const std::string &params="")
 creates a component with given type and optionally given parameters More...
 
- Static Protected Member Functions inherited from icl::qt::GUIComponent
template<class A , class B , class C >
static std::string form_args_3 (const A &a, const B &b, const C &c)
 utility method to concatenate 3 values More...
 
template<class A , class B , class C , class D >
static std::string form_args_4 (const A &a, const B &b, const C &c, const D &d)
 utility method to concatenate 4 values More...
 
template<class A , class B , class C , class D , class E >
static std::string form_args_5 (const A &a, const B &b, const C &c, const D &d, const E &e)
 utility method to concatenate 5 values More...
 
template<class A , class B , class C , class D , class E , class F >
static std::string form_args_6 (const A &a, const B &b, const C &c, const D &d, const E &e, const F &f)
 utility method to concatenate 5 values More...
 
- Protected Attributes inherited from icl::qt::GUIComponent
Options m_options
 all component options (mutable for C++-reasons) More...
 
std::string m_type
 component type More...
 
std::string m_params
 component parameters More...
 

Detailed Description

a 2D function and data plotting component

Creates a PlotHandle

Constructor & Destructor Documentation

◆ Plot() [1/2]

icl::qt::Plot::Plot ( const utils::Range32f  xRange = utils::Range32f(0,0),
const utils::Range32f  yRange = utils::Range32f(0,0),
bool  useOpenGL = false,
const std::string &  xLabel = "",
const std::string &  yLabel = "" 
)
inline

Create Plot component with optionally given range parameters.

Parameters
xRangehorizontal range of the data view-port. If [0,0], then it is derived from the data
yRangevertical range of the data view-port. If [0,0], then it is derived from the data
useOpenGLif true, the renderering is performed in OpenGL (this can be faster in case of transparency)
xLabelx-axis label
yLabely-axis label

◆ Plot() [2/2]

icl::qt::Plot::Plot ( float  minX,
float  maxX = 0,
float  minY = 0,
float  maxY = 0,
bool  useOpenGL = false,
const std::string &  xLabel = "",
const std::string &  yLabel = "" 
)
inline

Create Plot component with optionally given POD parameters.

The parameters are described well in the other constructor

Member Function Documentation

◆ form_args()

static std::string icl::qt::Plot::form_args ( const utils::Range32f  xRange,
const utils::Range32f  yRange,
bool  useOpenGL,
const std::string &  xLabel,
const std::string &  yLabel 
)
inlinestaticprivate

utility method


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