Browse Source

More documentation updates for primitives.

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

4
src/Primitives/Capsule.h

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

2
src/Primitives/Cube.h

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

4
src/Primitives/Cylinder.h

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

4
src/Primitives/Icosphere.h

@ -31,7 +31,7 @@ template<size_t subdivisions> class Icosphere;
/**
@brief 3D icosphere primitive with zero subdivisions
Indexed with normals.
Indexed triangle mesh with normals.
@todo Use own computed (and more precise) icosahedron data, not these stolen
from Blender.
*/
@ -45,7 +45,7 @@ template<> class Icosphere<0>: public Trade::MeshData3D {
@brief 3D icosphere primitive
@tparam subdivisions Number of subdivisions
Indexed with normals.
Indexed triangle mesh with normals.
*/
#ifndef DOXYGEN_GENERATING_OUTPUT
template<size_t subdivisions> class Icosphere: public Icosphere<0> {

2
src/Primitives/Plane.h

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

2
src/Primitives/Square.h

@ -26,7 +26,7 @@ namespace Magnum { namespace Primitives {
/**
@brief 2D square primitive
2x2 square, non-indexed.
2x2 square as triangle strip, non-indexed.
*/
class Square: public Trade::MeshData2D {
public:

2
src/Primitives/UVSphere.h

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

Loading…
Cancel
Save