diff --git a/docs/StyleGuide.htm b/docs/StyleGuide.htm deleted file mode 100644 index f056e13b..00000000 --- a/docs/StyleGuide.htm +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - - - - - - - -

VCG Library Coding Guide

-

Naming Rules

-

Class names with first -letter Uppercase and internal uppercase to separate compound words.

-

Function members of -classes follow the same rule.

-

Example:

-

Point3f -

-

{

-

public:

-

ScalarType &V(const int i);

-

}

-

Public Variable members -has the first letter lowercase and internal uppercase to separate -compound words.

-

Example:

-


-

-

Private Variable members -has an underscore as first char and the first letter lowercase and -internal uppercase to separate compound words.

-

Example:

-

Point3f -

-

{

-

private:

-

ScalarType _v[3];

-

}

-

Class Template Arguments -all capitalized and with names remembering where they have been -defined.

-

TypeDefs used for templated Class -arguments just like Class Names, but ending with “Type”

-

Example:

-

Point3f::ScalarType -

-

Header Files

-

Header filenames and folders are always -fully lower case. Compound names are separated by '_'.

-

Example:

-

#include<vcg/space/point3.h> -

-

Each file of the library has to include -all the files that it requires. A include file should relies on the -files included by its include files. Example: in vcg/space/box3.h:

-


-

-

#include<vcg/math/base.h> - // not necessary becouse included by point3.h

-

#include<vcg/space/point3.h> -

-


-

-

In Class definitions place prototypes -all together before the inline or templated -implementations.

-


-

-

Editing Rules

-

Tabs are equivalent to two spaces. -

-

There are no strict rules for the -placement of '{' or indenting.

-

Constructors and casting

-

All basic classes (point3, box3 ecc) -must have null constructors. Non null constructors can be added in -debug versions.

-

Implicit casting is disallowed. Write a -member Import function for casting from different integral types and -a static Construct to build an object from different a integral type.

-


-

-

Example:

-

Point3f pf(1.0f,0.0f,0.0f); -

-

Point3d pd=Point3f::Construct(pf);

-

pf.Import(pd);

-

-

- - \ No newline at end of file diff --git a/vcg/simplex/face/A.h b/vcg/simplex/face/A.h deleted file mode 100644 index d6f2de24..00000000 --- a/vcg/simplex/face/A.h +++ /dev/null @@ -1,24 +0,0 @@ -/*#************************************************************************** - History - - 2000 Jan 31 First Working release - -****************************************************************************/ -#ifndef __VCGLIB_FACE_A___TYPE -#define __VCGLIB_FACE_A___TYPE - -#ifdef FACE_TYPE -#pragma message("\nInternal Error 42\n") -#endif - -#define FACE_TYPE FaceA -#define __VCGLIB_FACE_A - -#include - -#undef FACE_TYPE -#undef __VCGLIB_FACE_A - - - -#endif \ No newline at end of file diff --git a/vcg/simplex/face/N.h b/vcg/simplex/face/N.h deleted file mode 100644 index 83399705..00000000 --- a/vcg/simplex/face/N.h +++ /dev/null @@ -1,27 +0,0 @@ -/*#************************************************************************** - History - - 2000 Jan 31 First Working release - -****************************************************************************/ -#ifndef __VCGLIB_VERTEX__N__TYPE -#define __VCGLIB_VERTEX__N__TYPE - -#define VERTEX_TYPE VertexN - -#define __VCGLIB_VERTEX_N - -#include - -#undef VERTEX_TYPE - -#undef __VCGLIB_VERTEX_N - -using namespace vcg; - -typedef VertexN VertexNs; -typedef VertexN VertexNi; -typedef VertexN VertexNf; -typedef VertexN VertexNd; - -#endif \ No newline at end of file diff --git a/vcg/simplex/vertex/N.h b/vcg/simplex/vertex/N.h deleted file mode 100644 index 83399705..00000000 --- a/vcg/simplex/vertex/N.h +++ /dev/null @@ -1,27 +0,0 @@ -/*#************************************************************************** - History - - 2000 Jan 31 First Working release - -****************************************************************************/ -#ifndef __VCGLIB_VERTEX__N__TYPE -#define __VCGLIB_VERTEX__N__TYPE - -#define VERTEX_TYPE VertexN - -#define __VCGLIB_VERTEX_N - -#include - -#undef VERTEX_TYPE - -#undef __VCGLIB_VERTEX_N - -using namespace vcg; - -typedef VertexN VertexNs; -typedef VertexN VertexNi; -typedef VertexN VertexNf; -typedef VertexN VertexNd; - -#endif \ No newline at end of file