Commit 6332216f authored by Sebastian Eichelbaum's avatar Sebastian Eichelbaum

[DOC] - fixed all doxygen warnings in core.

parent 6f51a2ef
......@@ -107,6 +107,8 @@ public:
* Calculates and returns the squared length of the bounding box radius.
*
* \note This is a wrapper call to osg::BoundingBoxImpl< VT >::radius2()
*
* \return squared bbox radius
*/
value_type radiusSquare() const;
......
......@@ -150,6 +150,8 @@ public:
* finds the X biggest clusters for a given cluster
* \param cluster
* \param number of sub clusters
*
* \return the biggest clusters
*/
std::vector< size_t >findXBiggestClusters( size_t cluster, size_t number = 10 );
......
......@@ -85,7 +85,7 @@ public:
* selection is known.
*
* \note Please be aware that, in the moment this method returns, another thread can make all selectors invalid again causing the returned
* one to be invalid too. To avoid this, use the newSelector method only if the old has locked the selection using ::lock and ::unlock.
* one to be invalid too. To avoid this, use the newSelector method only if the old has locked the selection using \ref lock and \ref unlock.
*
* \param selected the selected items (their index in WItemSelection).
*
......@@ -99,7 +99,7 @@ public:
* the IndexList.
*
* \note Please be aware that, in the moment this method returns, another thread can make all selectors invalid again causing the returned
* one to be invalid too. To avoid this, use the newSelector method only if the old has locked the selection using ::lock and ::unlock.
* one to be invalid too. To avoid this, use the newSelector method only if the old has locked the selection using \ref lock and \ref unlock.
*
* \param selected the selected item (the index in WItemSelection).
*
......@@ -112,7 +112,7 @@ public:
* string representing it is known. This somehow correlates to the << operator.
*
* \note Please be aware that, in the moment this method returns, another thread can make all selectors invalid again causing the returned
* one to be invalid too. To avoid this, use the newSelector method only if the old has locked the selection using ::lock and ::unlock.
* one to be invalid too. To avoid this, use the newSelector method only if the old has locked the selection using \ref lock and \ref unlock.
*
* \param asString the selected items
*
......@@ -125,7 +125,7 @@ public:
* selection list valid with the current underlying selection.
*
* \note Please be aware that, in the moment this method returns, another thread can make all selectors invalid again causing the returned
* one to be invalid too. To avoid this, use the newSelector method only if the old has locked the selection using ::lock and ::unlock.
* one to be invalid too. To avoid this, use the newSelector method only if the old has locked the selection using \ref lock and \ref unlock.
*
* \return the new (valid) selector.
*/
......
......@@ -124,6 +124,8 @@ public:
*
* \param event the kind of signal the callback should be used for.
* \param callback the callback.
*
* \return the connection object. Disconnect it explicitly!
*/
boost::signals2::connection subscribeSignal( LogEvent event, LogEntryCallback callback );
......
......@@ -70,7 +70,7 @@ public:
void observe( boost::shared_ptr< WProperties > properties, std::set< std::string > names = std::set< std::string >() );
/**
* Is true if one observed property fired. This is reset by the ::handled method.
* Is true if one observed property fired. This is reset by the \ref handled method.
*
* \return true if one property fired.
*/
......@@ -79,7 +79,7 @@ public:
/**
* Resets the update flag and the list of fired properties.
*
* \return the set of properties fired until the last call of handled().
* \return the set of properties fired until the last call of \ref handled.
*/
PropertyNameMap handled();
......@@ -110,12 +110,12 @@ private:
WPropertyObserver& operator=( const WPropertyObserver& rhs );
/**
* Cancels all current subscriptions and cleans ::m_subscriptions.
* Cancels all current subscriptions and cleans m_subscriptions.
*/
void cancelSubscriptions();
/**
* Subscribes each property update condition which matches an entry in ::m_propNames.
* Subscribes each property update condition which matches an entry in m_propNames.
*/
void updateSubscriptions();
......
......@@ -151,6 +151,8 @@ public:
/**
* Is coloring enabled?
*
* \return true if enabled
*/
bool isEnabled() const;
......
......@@ -129,6 +129,8 @@ protected:
/**
* WThreadedFunctionBase is non-copyable, so the copy operator is not implemented.
*
* \return this function
*/
WThreadedFunctionBase& operator = ( WThreadedFunctionBase const& );
......@@ -222,6 +224,8 @@ private:
/**
* WThreadedFunction is non-copyable, so the copy operator is not implemented.
*
* \return this function
*/
WThreadedFunction& operator = ( WThreadedFunction const& );
......
......@@ -98,6 +98,8 @@ private:
/**
* WWorkerThread is non-copyable, so the copy operator is not implemented.
*
* \return this worker-thread.
*/
WWorkerThread& operator = ( WWorkerThread const& );
......
......@@ -62,27 +62,37 @@ public:
* Return the value on the sphere.
* \param theta angle for the position on the unit sphere
* \param phi angle for the position on the unit sphere
*
* \return value on sphere
*/
double getValue( double theta, double phi ) const;
/**
* Return the value on the sphere.
* \param coordinates for the position on the unit sphere
*
* \return value on sphere
*/
double getValue( const WUnitSphereCoordinates& coordinates ) const;
/**
* Returns the used coefficients (stored like in the mentioned 2007 Descoteaux paper).
*
* \return coefficient list
*/
const WValue<double>& getCoefficients() const;
/**
* Returns the coefficients for Schultz' SH base.
*
* \return coefficient list
*/
WValue< double > getCoefficientsSchultz() const;
/**
* Returns the coefficients for the complex base.
*
* \return coefficiend list
*/
WValue< std::complex< double > > getCoefficientsComplex() const;
......@@ -96,6 +106,8 @@ public:
/**
* Return the order of the spherical harmonic.
*
* \return order of SH
*/
size_t getOrder() const;
......@@ -190,6 +202,8 @@ public:
*
* \param order The order of the symmetric tensor.
* \param orientations A vector of at least (orderTensor+1) * (orderTensor+2) / 2 orientations.
*
* \return the conversion matrix
*/
static WMatrix< double > calcSHToTensorSymMatrix( std::size_t order, const std::vector< WUnitSphereCoordinates >& orientations );
......
......@@ -94,6 +94,8 @@ public:
* Copy from a symmetric tensor.
*
* \param t A symmetric tensor.
*
* \return new tensor
*/
WTensor const& operator = ( WTensorSym< order, dim, Data_T > const& t );
};
......
......@@ -64,11 +64,15 @@ public:
/**
* Return the theta angle.
*
* \return theta angle
*/
double getTheta() const;
/**
* Return the phi angle.
*
* \return phi angle
*/
double getPhi() const;
......@@ -86,6 +90,8 @@ public:
/**
* Returns the stored sphere coordinates as Euclidean coordinates.
*
* \return sphere coordinates in euclidean space
*/
WVector3d getEuclidean() const;
......
......@@ -475,6 +475,8 @@ private:
* \param angle The rotation angle (in radians).
*
* \note i must not have the same values as j
*
* \return The new tensor
*/
template< std::size_t dim, typename Data_T >
WTensorSym< 2, dim, Data_T > similarity_rotate_givens( WTensorSym< 2, dim, Data_T > const& m,
......@@ -713,6 +715,8 @@ private:
*
* \param t The tensor.
* \param v The gradient.
*
* \return value
*/
double calcTens( WTensorSym< 4, 3, double > const& t, WVector3d const& v )
{
......
......@@ -67,6 +67,8 @@ public:
/**
* Return the value of the finished flag.
*
* \return true if finished
*/
inline bool isFinished();
......
......@@ -73,6 +73,8 @@ public:
/**
* Get the name of the file that this data set stems from.
*
* \return the filename.
*/
std::string getFileName() const;
......
......@@ -92,11 +92,15 @@ public:
/**
* Returns the largest of the scalars stored in the data set
*
* \return maximum value in dataset
*/
double getMax() const;
/**
* Returns the smallest of the scalars stored in the data set
*
* \return minimum value in dataset
*/
double getMin() const;
......
......@@ -54,11 +54,15 @@ public:
/**
* Returns an empty dummy WPersonalInformation object.
*
* \return the dummy object
*/
static WPersonalInformation createDummyInformation();
/**
* Returns the subjectID of the person. This is zero for dummy information.
*
* \return subject id number
*/
uint64_t getSubjectID() const;
......@@ -70,6 +74,8 @@ public:
/**
* Returns the last or family name of the person.
*
* \return family name
*/
std::string getLastName() const;
......@@ -81,23 +87,31 @@ public:
/**
* Returns the middle name of the person.
*
* \return middle name
*/
std::string getMiddleName() const;
/**
* Returns the first or given name of the person.
*
* \return first name
*/
std::string getFirstName() const;
/**
* Returns if all members of the current WPersonalInformation are equal to those of info.
* \param info the WPersonalInformation to compare with
*
* \return true if the information are equal
*/
bool operator==( WPersonalInformation info ) const;
/**
* Returns if not all members of the current WPersonalInformation are equal to those of info.
* \param info the WPersonalInformation to compare with
*
* \return true if the personal informations differ
*/
bool operator!=( WPersonalInformation info ) const;
......
......@@ -49,6 +49,8 @@ public:
/**
* How many positions this tract incorporates.
*
* \return number of points
*/
size_t numPoints() const;
......
......@@ -77,6 +77,8 @@ public:
* \param i The relative position of the element in the subarray's range.
*
* \note If i is not in ( 0, size - 1 ), the first element will be returned.
*
* \return the value
*/
T const& operator[] ( std::size_t i ) const
{
......@@ -216,6 +218,8 @@ public:
/**
* Sometimes we need raw access to the data array, for e.g. OpenGL.
*
* \return the raw data pointer
*/
const T * rawData() const
{
......@@ -224,6 +228,8 @@ public:
/**
* Sometimes we need raw access to the data vector.
*
* \return the data vector
*/
const std::vector< T >* rawDataVectorPointer() const
{
......
......@@ -71,6 +71,8 @@ public:
/**
* Returns true if there are no fibers in that cluster, false otherwise.
*
* \return true if empty
*/
bool empty() const;
......@@ -84,6 +86,8 @@ public:
/**
* Returns a const reference of all indices inside this cluster
*
* \return the index list
*/
const std::list< size_t >& getIndices() const;
......@@ -122,6 +126,8 @@ public:
/**
* Gets the color of which all fibers of this clusters should be painted
* with.
*
* \return cluster color.
*/
WColor getColor() const;
......
......@@ -51,6 +51,8 @@ public:
/**
* Returns dummy bounding box.
*
* \return bbox
*/
virtual WBoundingBox getBoundingBox() const
{
......
......@@ -205,6 +205,8 @@ private:
* Build a test dataset.
*
* \param data The vector for every voxel.
*
* \return the test dataset
*/
boost::shared_ptr< WDataSetSingle > buildTestData( WVector3d data )
{
......
......@@ -63,20 +63,23 @@ public:
WFiberDrawable( const WFiberDrawable& pg, const osg::CopyOp& copyop = osg::CopyOp::SHALLOW_COPY );
/**
* no clue why it's here and wehat it does
* See osg documentation for this.
*
* \return the cloned object
*/
virtual osg::Object* cloneType() const;
/**
* clones it
*
* \param copyop
* \param copyop copy operation. See osg doc for details
* \return the cloned object
*/
virtual osg::Object* clone( const osg::CopyOp& copyop ) const;
/**
* Real work is done here. THERE IS A VERY IMPORTANT THING TO NOTE HERE:
* the 'drawImplementation()' method receives an 'osg::State' as
* the \ref drawImplementation method receives an state as
* parameter. This can be used to change the OpenGL state, but changing
* the OpenGL state here is something to be avoided as much as possible.
* Do this *only* if it is *absolutely* necessary to make your rendering
......@@ -87,7 +90,7 @@ public:
* these rare cases in which it is necessary. But always keep in mind:
* *Change the OpenGL state only if strictly necessary*.
*
* \param renderInfo
* \param renderInfo the render info object. See osg doc for details
*/
virtual void drawImplementation( osg::RenderInfo& renderInfo ) const; //NOLINT
......
......@@ -164,6 +164,8 @@ private:
* Handles events related to zooming.
*
* \param ea event class for storing keyboard, mouse and window events
*
* \return true if event was handled
*/
bool zoom( const osgGA::GUIEventAdapter& ea );
......
......@@ -209,7 +209,7 @@ namespace wge
*
* \param resX How many quads in x-direction
* \param resY How many quads in y-direction
* \param spacing \todo(math): Not implement yet
* \param spacing Not implement yet
*
* \return The new uncolored plane geode
*/
......
......@@ -45,6 +45,8 @@ public:
* Indicates whether we want the widget showing the scene to be
* tranferred to its home position. This is the case if we have the
* <b>first</b> child added to the scene.
*
* \return true if reset to bbox is requested
*/
bool isHomePositionRequested();
......
......@@ -48,6 +48,8 @@ namespace wge
*
* \param pos1 First point
* \param pos2 Second point
*
* \return converts a vector to a color
*/
WColor getRGBAColorFromDirection( const WPosition &pos1, const WPosition &pos2 );
......@@ -65,6 +67,8 @@ namespace wge
*
* \param screen the screen coordinates
* \param camera The matrices of this camera will used for unprojecting.
*
* \return un-projects a screen coordinate back to world space
*/
osg::Vec3 WGE_EXPORT unprojectFromScreen( const osg::Vec3 screen, osg::ref_ptr< osg::Camera > camera );
......
......@@ -47,6 +47,8 @@ public:
/**
* Get the position of the manipulator as 4x4 matrix.
*
* \return the matrix representing the transformation
*/
virtual osg::Matrixd getMatrix() const;
......@@ -60,6 +62,8 @@ public:
/**
* Get the position of the manipulator as a inverse matrix of the
* manipulator, typically used as a model view matrix.
*
* \return the inverse matrix
*/
virtual osg::Matrixd getInverseMatrix() const;
......@@ -74,11 +78,15 @@ public:
* Handle events, return true if handled, false otherwise.
* \param ea Event class for storing Keyboard, mouse and window events.
* \param us Interface by which GUIEventHandlers may request actions of the GUI system
*
* \return true if event was handled
*/
virtual bool handle( const osgGA::GUIEventAdapter& ea, osgGA::GUIActionAdapter& us );
/**
* Get zoom factor.
*
* \return the current zoom factor
*/
double getZoom() const;
......@@ -117,6 +125,8 @@ private:
* Handles events related to zooming.
* \param ea Event class for storing Keyboard, mouse and window events.
* \param us Interface by which GUIEventHandlers may request actions of the GUI system
*
* \return true if event was handled
*/
bool zoom( const osgGA::GUIEventAdapter& ea, osgGA::GUIActionAdapter& us );
......
......@@ -74,6 +74,8 @@ public:
* Deals with the events found by the osg.
* \param ea Event class for storing Keyboard, mouse and window events.
* \param aa Interface by which GUIEventHandlers may request actions of the GUI system
*
* \return true if the event was handled.
*/
bool handle( const osgGA::GUIEventAdapter& ea, osgGA::GUIActionAdapter& aa );
......@@ -91,6 +93,8 @@ public:
/**
* Gives information about the picked object.
*
* \return info object for this hit
*/
WPickInfo getHitResult();
......
......@@ -90,11 +90,15 @@ public:
/**
* Get the modifier key associated with the pick
*
* \return the mod key
*/
inline modifierKey getModifierKey() const;
/**
* Get the mouse button associated with the pick
*
* \return the mouse button
*/
inline WMouseButton getMouseButton() const;
......@@ -112,22 +116,30 @@ public:
/**
* Get name of picked object.
*/
* Get name of picked object.
*
* \return object name
*/
inline std::string getName() const;
/**
* Get name of the viewer.
*/
* Get name of the viewer.
*
* \return viewer name
*/
inline std::string getViewerName() const;
/**
* Get position where object was hit.
*
* \return the pick position
*/
inline WPosition getPickPosition() const;
/**
* Get normal at position where object was hit.
*
* \return pick normal
*/
inline WVector3d getPickNormal() const;
......@@ -141,12 +153,17 @@ public:
/**
* Tests two pick infos for equality