Commit 2a9090f6 authored by Dennis Gläser's avatar Dennis Gläser
Browse files

[doc][doxygen] introduce GeometryUtilities

parent c3b6c5f7
......@@ -31,3 +31,9 @@
* \defgroup Geometry Geometry
* \brief Classes that define basic geometrical objects.
*/
/*!
* \ingroup Geometry
* \defgroup GeometryUtilities Geometry Utilities
* \brief Utility functionality for geometrical objects.
*/
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup GeometryUtilities
* \brief Utility functionality to apply functions on
* geometrical objects of which only the pointer
* to the virtual base class is available. In a
......@@ -47,6 +48,7 @@
namespace Frackit {
/*!
* \ingroup GeometryUtilities
* \brief Apply a function to the geometry referenced
* to by the given pointer on the geometry interface.
* \param geoPtr Pointer to an object of the geometry interface
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup GeometryUtilities
* \brief Utility functionality to cast pointers on objects of
* the geometry interface into the corresponding geometry type.
*/
......@@ -33,6 +34,7 @@
namespace Frackit {
/*!
* \ingroup GeometryUtilities
* \brief Try to cast a pointer on a geometrical object
* into the provided instance of a geometry.
* \param geoPtr Pointer to an object of the geometry interface
......
......@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
* \ingroup GeometryUtilities
* \brief Utility functionality to get the name of geometries.
* This provides an interface that is compatible also
* with classes from the BRep package.
......@@ -39,6 +40,7 @@
namespace Frackit {
/*!
* \ingroup GeometryUtilities
* \brief Return the name of an internal geometry class.
* \note Here, we simply forward to the name() function of the geometries
*/
......@@ -47,42 +49,49 @@ std::string geometryName(const Geo& geo)
{ return geo.name(); }
/*!
* \ingroup GeometryUtilities
* \brief Return the name for a TopoDS_Solid.
*/
std::string geometryName(const TopoDS_Solid& s)
{ return "TopoDS_Solid"; }
/*!
* \brief Return the name for a TopoDS_Shell.
* \ingroup GeometryUtilities
* \brief Return the name for a TopoDS_Shell.
*/
std::string geometryName(const TopoDS_Shell& s)
{ return "TopoDS_Shell"; }
/*!
* \brief Return the name for a TopoDS_Face.
* \ingroup GeometryUtilities
* \brief Return the name for a TopoDS_Face.
*/
std::string geometryName(const TopoDS_Face& f)
{ return "TopoDS_Face"; }
/*!
* \ingroup GeometryUtilities
* \brief Return the name for a TopoDS_Wire.
*/
std::string geometryName(const TopoDS_Wire& w)
{ return "TopoDS_Wire"; }
/*!
* \ingroup GeometryUtilities
* \brief Return the name for a TopoDS_Edge.
*/
std::string geometryName(const TopoDS_Edge& e)
{ return "TopoDS_Edge"; }
/*!
* \ingroup GeometryUtilities
* \brief Return the name for a TopoDS_Vertex.
*/
std::string geometryName(const TopoDS_Vertex& v)
{ return "TopoDS_Vertex"; }
/*!
* \ingroup GeometryUtilities
* \brief Return the name for a TopoDS_Shape.
*/
std::string geometryName(const TopoDS_Shape& v)
......
Supports Markdown
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