Browse Source

Better documentation for primitives.

vectorfields
Vladimír Vondruš 14 years ago
parent
commit
bfbaa79e7b
  1. 5
      src/Primitives/Capsule.h
  2. 7
      src/Primitives/Cube.h
  3. 7
      src/Primitives/Cylinder.h
  4. 11
      src/Primitives/Icosphere.h
  5. 4
      src/Primitives/Plane.h
  6. 4
      src/Primitives/Square.h
  7. 6
      src/Primitives/UVSphere.h

5
src/Primitives/Capsule.h

@ -24,9 +24,10 @@
namespace Magnum { namespace Primitives { namespace Magnum { namespace Primitives {
/** /**
@brief %Capsule primitive @brief 3D capsule primitive
Cylinder along Y axis with hemispheres instead of caps. Cylinder along Y axis with hemispheres instead of caps. Indexed with normals
and optional 2D texture coordinates.
*/ */
class Capsule: public Trade::MeshData3D { class Capsule: public Trade::MeshData3D {
friend class UVSphere; friend class UVSphere;

7
src/Primitives/Cube.h

@ -23,7 +23,12 @@
namespace Magnum { namespace Primitives { namespace Magnum { namespace Primitives {
/** @brief %Cube primitive */ /**
@brief 3D cube primitive
Indexed with smooth normals.
@todo Does anyone EVER want smooth normals on a cube?!
*/
class Cube: public Trade::MeshData3D { class Cube: public Trade::MeshData3D {
public: public:
/** @brief Constructor */ /** @brief Constructor */

7
src/Primitives/Cylinder.h

@ -25,7 +25,12 @@
namespace Magnum { namespace Primitives { namespace Magnum { namespace Primitives {
/** @brief Cylinder primitive */ /**
@brief 3D cylinder primitive
Indexed with normals, optional 2D texture coordinates and optional capped
ends.
*/
class Cylinder: public Capsule { class Cylinder: public Capsule {
public: public:
/** /**

11
src/Primitives/Icosphere.h

@ -29,8 +29,9 @@ namespace Magnum { namespace Primitives {
template<size_t subdivisions> class Icosphere; template<size_t subdivisions> class Icosphere;
/** /**
@brief %Icosphere primitive with zero subdivisions @brief 3D icosphere primitive with zero subdivisions
Indexed with normals.
@todo Use own computed (and more precise) icosahedron data, not these stolen @todo Use own computed (and more precise) icosahedron data, not these stolen
from Blender. from Blender.
*/ */
@ -41,9 +42,11 @@ template<> class Icosphere<0>: public Trade::MeshData3D {
}; };
/** /**
* @brief %Icosphere primitive @brief 3D icosphere primitive
* @tparam subdivisions Number of subdivisions @tparam subdivisions Number of subdivisions
*/
Indexed with normals.
*/
#ifndef DOXYGEN_GENERATING_OUTPUT #ifndef DOXYGEN_GENERATING_OUTPUT
template<size_t subdivisions> class Icosphere: public Icosphere<0> { template<size_t subdivisions> class Icosphere: public Icosphere<0> {
#else #else

4
src/Primitives/Plane.h

@ -24,9 +24,9 @@
namespace Magnum { namespace Primitives { namespace Magnum { namespace Primitives {
/** /**
@brief %Plane primitive @brief 3D plane primitive
2x2 plane with normals in positive Z direction. 2x2 plane, non-indexed with normals in positive Z direction.
*/ */
class Plane: public Trade::MeshData3D { class Plane: public Trade::MeshData3D {
public: public:

4
src/Primitives/Square.h

@ -24,9 +24,9 @@
namespace Magnum { namespace Primitives { namespace Magnum { namespace Primitives {
/** /**
@brief %Square primitive @brief 2D square primitive
2x2 square. 2x2 square, non-indexed.
*/ */
class Square: public Trade::MeshData2D { class Square: public Trade::MeshData2D {
public: public:

6
src/Primitives/UVSphere.h

@ -23,7 +23,11 @@
namespace Magnum { namespace Primitives { namespace Magnum { namespace Primitives {
/** @brief UV Sphere primitive */ /**
@brief 3D UV sphere primitive
Indexed with normals and optional 2D texture coordinates.
*/
class UVSphere: public Capsule { class UVSphere: public Capsule {
public: public:
/** /**

Loading…
Cancel
Save