HE Namespace Reference

Namespace containing almost every element in the library, except for those contained in namespace Geometry. More...


Classes

class  Face
 Class that represents the faces of the mesh. More...
class  HalfEdge
 Class that represents the half-edges of the mesh. More...
class  Polyhedron
 Class that holds the representation of a manifold mesh in a half-edge data structure. More...
class  Polyhedron_GL
 Wrapper class used to visualize a Polyhedron. More...
class  HE_exception
 Exception class thrown whenever needed in a class or function within the HE namespace. More...
class  Vertex
 Class that represents the vertices of the mesh. It basic topologic and geometric information. More...

Enumerations

enum  filetype_e {
  FT_PLY_ASCII, FT_PLY_BIN, FT_OFF, FT_OBJ,
  FT_TRI, FT_NONE
}
 enum that identifies the different types of mesh file formats supported. More...

Functions

ostream & operator<< (ostream &out, const Face &f)
std::ostream & operator<< (std::ostream &out, const Face &f)
 Stream output operator that prints the direct contents of the Face object. Useful for debugging.
ostream & operator<< (ostream &out, const HalfEdge &he)
std::ostream & operator<< (std::ostream &out, const HalfEdge &he)
 Stream output operator that prints the direct contents of the HalfEdge. Useful for debugging.
filetype_e fileFormat (const char *filename)
 Opens the indicated file and checks magic strings and other information in order to determine the file format.
ostream & operator<< (ostream &out, const Polyhedron &p)
std::ostream & operator<< (std::ostream &out, const Polyhedron &p)
 Writes out a complete description of the Polyhedron.
double rangerand (double min, double max, long steps=10000)
 Gaussian-alike (bell shaped) random number generator.
double gaussianrand (double min, double max, long steps=10000)
 Ranged uniform random number generator.
ostream & operator<< (ostream &out, const Vertex &v)
std::ostream & operator<< (std::ostream &out, const Vertex &v)
 Stream output operator that prints the direct contents of the Vertex object. Useful for debugging.


Detailed Description

Namespace containing almost every element in the library, except for those contained in namespace Geometry.

Namely, classes Polyhedron, Polyhedron_GL, Vertex, HalfEdge, Face and several functions.

See also:
Geometry
Todo:
Remove all pointers from the interface to the library.

Enumeration Type Documentation

enum HE::filetype_e

enum that identifies the different types of mesh file formats supported.

Only a few are actually supported.

Enumerator:
FT_PLY_ASCII  PLY ASCII format.
FT_PLY_BIN  PLY binary format (currently unsupported).
FT_OFF  Object File Format format.
FT_OBJ  OBJ format by Alias (currently unsupported).
FT_TRI  Simple non-indexed triangle format. Troublesome, because of the lack of indices (everything is boundary).
FT_NONE  Not identified format. Indicates an error situation.

Definition at line 52 of file polyhedron.h.


Function Documentation

filetype_e HE::fileFormat ( const char *  filename  ) 

Opens the indicated file and checks magic strings and other information in order to determine the file format.

Parameters:
filename File to be checked.
Returns:
An indicator of the file's format, or FT_NONE, if no supported format is identified.

Definition at line 36 of file mesh_io.cpp.

References FT_NONE, FT_OBJ, FT_OFF, FT_PLY_ASCII, FT_PLY_BIN, and FT_TRI.

Referenced by HE::Polyhedron::load().

double HE::gaussianrand ( double  min,
double  max,
long  steps = 10000 
)

Ranged uniform random number generator.

It produces a random number in the [min,max] interval, and has the granularity indicated by steps.

Parameters:
min Lower bound of the interval.
max Upper bound of the interval.
steps Granularity of the interval. Number of distinct values that can be returned.
Returns:
A value in the interval.

Definition at line 36 of file util.cpp.

References rangerand().

std::ostream& HE::operator<< ( std::ostream &  out,
const Polyhedron &  p 
)

Writes out a complete description of the Polyhedron.

Parameters:
out Stream where the description is to be written.
Returns:
Reference to the written stream.

double HE::rangerand ( double  min,
double  max,
long  steps = 10000 
)

Gaussian-alike (bell shaped) random number generator.

It produces a random number in the [min,max] interval, with a distribution that is similar to that of a Gaussian function. Note, however, that the actual distribution is NOT Gaussian.

Parameters:
min Lower bound of the interval.
max Upper bound of the interval.
steps Granularity of the interval. Number of distinct values that can be returned.
Returns:
A value in the interval.

Definition at line 29 of file util.cpp.

Referenced by gaussianrand(), and HE::Polyhedron_GL::recomputeColors().


Generated on Wed Apr 9 19:22:39 2008 for HalfEdge library by  doxygen 1.5.3