Commit 2333166e authored by Alexander Wiebel's avatar Alexander Wiebel
Browse files

[DOC #396] added missing documentation

parent d550f480
......@@ -47,7 +47,7 @@ class WGEManagedGroupNode;
/**
* Computes contour lines (aka isolines) for the given data and render them on a 2D plane.
* Allows to select a 3D position in a DVR by selecting a 2D location on the screen.
* \ingroup modules
*/
class WMPickingDVR: public WModule
......@@ -186,9 +186,13 @@ private:
boost::shared_ptr< WItemSelection > m_pickingCritereaList;
/**
* Intersection Positions
* Intersection position start
*/
osg::Vec3f m_posStart;
/**
* Intersection position end
*/
osg::Vec3f m_posEnd;
/**
......
......@@ -25,33 +25,91 @@
#ifndef WMPICKINGDVRHELPER_H
#define WMPICKINGDVRHELPER_H
/**
* Color converter for different scalings, i.e. [0,1] vs. [0,255]
*/
template <typename T>
class WMEDUColor
{
private:
T red;
T green;
T blue;
T alpha;
T red; //!< Red color component value
T green; //!< Green color component value
T blue; //!< Blue color component value
T alpha; //!< Opacity compnent value
public:
/**
* Standard constructor that creates transparent black.
*/
WMEDUColor();
WMEDUColor( T red, T green, T fBlue, T alpha );
//Getter
/**
* Constructor creating the color.
*
* \param red red color component value
* \param green green color component value
* \param blue blue color copmonent value
* \param alpha opacity component value
*/
WMEDUColor( T red, T green, T blue, T alpha );
/**
* Get red color component value.
*
* \return red value
*/
T getRed();
/**
* Get green color component value.
*
* \return green value
*/
T getGreen();
/**
* Get blue color component value.
*
* \return blue value
*/
T getBlue();
/**
* Get opacity color component value.
*
* \return opacity value
*/
T getAlpha();
//Setter
/**
* Set red color component value.
*
* \param red red value
*/
void setRed( T red );
/**
* Set green color component value.
*
* \param green green value
*/
void setGreen( T green );
/**
* Set blue color component value.
*
* \param blue blue value
*/
void setBlue( T blue );
/**
* Set opacity color component value.
*
* \param alpha opacity value
*/
void setAlpha( T alpha );
void normalize();
void normalize(); //!< Scales color down from [0,255] to [0,1]
};
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment