From 70a37221cb63746ceb060a0e067a71eace1c5199 Mon Sep 17 00:00:00 2001
From: Shon Ferguson <shonferg@users.sourceforge.net>
Date: Thu, 12 Apr 2007 05:49:16 +0000
Subject: [PATCH] Moved structures contained within the ComplexShape class
outside of it so that they can be wrapped with SWIG. Finished documentation
of ComplexShape.
---
include/ComplexShape.h | 342 +++++++++++++++++++++++++----------------
src/ComplexShape.cpp | 10 +-
2 files changed, 214 insertions(+), 138 deletions(-)
diff --git a/include/ComplexShape.h b/include/ComplexShape.h
index 0948c992..02f943ec 100644
--- a/include/ComplexShape.h
+++ b/include/ComplexShape.h
@@ -23,140 +23,140 @@ class NiTriBasedGeom;
const unsigned int CS_NO_INDEX = 0xFFFFFFFF;
/*!
- * This class is a helper object to ease the process of converting between the
- * 3D model format of a NIF file, which is optimized for real time display via
- * OpenGL or DirectX, and the more compact, complex format usually prefered by
- * 3D modeling software.
- *
- * It is capable of mering multiple NiTriShape objects into one multi-material
- * object with indexed data, or taking such an object and splitting it up into
- * multiple NiTriShape objects.
+ * Used by the ComplexShape::WeightedVertex strut to store a single
+ * skin-weight/bone influence combination for a vertex.
*/
-class ComplexShape {
-public:
+struct SkinInfluence {
+ /*! Constructor */
+ NIFLIB_API SkinInfluence() : influenceIndex(CS_NO_INDEX) {}
+ /*! Destructor */
+ NIFLIB_API ~SkinInfluence() {}
+ /*!
+ * Index into the ComplexShape::skinInfluences array of the bone
+ * influence for this skin weight.
+ */
+ unsigned int influenceIndex;
+ /*!
+ * The amount of influence the indexed bone has on this vertex, between
+ * 0.0 and 1.0
+ */
+ float weight;
+};
- /*!
- * Used by the ComplexShape::WeightedVertex strut to store a single
- * skin-weight/bone influence combination for a vertex.
- */
- struct SkinInfluence {
- /*! Constructor */
- NIFLIB_API SkinInfluence() : influenceIndex(CS_NO_INDEX) {}
- /*! Destructor */
- NIFLIB_API ~SkinInfluence() {}
- /*!
- * Index into the ComplexShape::skinInfluences array of the bone
- * influence for this skin weight.
- */
- unsigned int influenceIndex;
- /*!
- * The amount of influence the indexed bone has on this vertex, between
- * 0.0 and 1.0
- */
- float weight;
- };
+/*!
+ * Used by the ComplexShape class to store a single vertex and any
+ * Associated skin weights
+ */
+struct WeightedVertex {
+ /*! The 3D position of this vertex. */
+ Vector3 position;
+ /*! A list of weight/influence index pairs for this vertex. */
+ vector<SkinInfluence> weights;
+};
+/*!
+ * Used by the ComplexShape::ComplexPoint struct to store a single texture
+ * cooridinate set/texture coordinate pair of indices.
+ */
+struct TexCoordIndex {
+ /*! Constructor */
+ NIFLIB_API TexCoordIndex() : texCoordSetIndex(CS_NO_INDEX), texCoordIndex(CS_NO_INDEX) {}
+ /*! Destructor */
+ NIFLIB_API ~TexCoordIndex() {}
/*!
- * Used by the ComplexShape class to store a single vertex and any
- * Associated skin weights
+ * Index into the ComplexShape::texCoordSets array of texture
+ * coordinate sets.
*/
- struct WeightedVertex {
- /*! The 3D position of this vertex. */
- Vector3 position;
- /*! A list of weight/influence index pairs for this vertex. */
- vector<SkinInfluence> weights;
- };
+ unsigned int texCoordSetIndex;
/*!
- * Used by the ComplexShape::ComplexPoint struct to store a single texture
- * cooridinate set/texture coordinate pair of indices.
- */
- struct TexCoordIndex {
- /*! Constructor */
- NIFLIB_API TexCoordIndex() : texCoordSetIndex(CS_NO_INDEX), texCoordIndex(CS_NO_INDEX) {}
- /*! Destructor */
- NIFLIB_API ~TexCoordIndex() {}
- /*!
- * Index into the ComplexShape::texCoordSets array of texture
- * coordinate sets.
- */
- unsigned int texCoordSetIndex;
-
- /*!
- * Index into the ComplexShape::TexCoordSet::texCoords array of the
- * texture coordinate set referenced by texCoordSetIndex.
- */
- unsigned int texCoordIndex;
- };
+ * Index into the ComplexShape::TexCoordSet::texCoords array of the
+ * texture coordinate set referenced by texCoordSetIndex.
+ */
+ unsigned int texCoordIndex;
+};
+/*!
+ * Used by ComplexShape::ComplexFace class to describe a single point in
+ * the 3D model. Points share their data in case of duplication, so all
+ * information, such as position, normal vector, texture coordinates, etc.,
+ * are stored as indices into the asociated data arrays.
+ */
+struct ComplexPoint {
+ /*! Constructor */
+ NIFLIB_API ComplexPoint() : vertexIndex(CS_NO_INDEX), normalIndex(CS_NO_INDEX), colorIndex(CS_NO_INDEX) {}
+ /*! Destructor */
+ NIFLIB_API ~ComplexPoint() {}
+ /*!
+ * Index into the ComplexShape::vertices array which stores the
+ * position and any associated skin weights for this point.
+ */
+ unsigned int vertexIndex;
+ /*!
+ * Index into the ComplexShape::normals array which stores the normal
+ * vector for this point.
+ */
+ unsigned int normalIndex;
/*!
- * Used by ComplexShape::ComplexFace class to describe a single point in
- * the 3D model. Points share their data in case of duplication, so all
- * information, such as position, normal vector, texture coordinates, etc.,
- * are stored as indices into the asociated data arrays.
- */
- struct ComplexPoint {
- /*! Constructor */
- NIFLIB_API ComplexPoint() : vertexIndex(CS_NO_INDEX), normalIndex(CS_NO_INDEX), colorIndex(CS_NO_INDEX) {}
- /*! Destructor */
- NIFLIB_API ~ComplexPoint() {}
- /*!
- * Index into the ComplexShape::vertices array which stores the
- * position and any associated skin weights for this point.
- */
- unsigned int vertexIndex;
- /*!
- * Index into the ComplexShape::normals array which stores the normal
- * vector for this point.
- */
- unsigned int normalIndex;
- /*!
- * Index into the ComplexShape::colors array which stores the vertex
- * color for this point
- */
- unsigned int colorIndex;
- /*!
- * An array of texture coordinate set/texture coordinate index pairs
- * describing all the UV coordinates for this point.
- */
- vector<TexCoordIndex> texCoordIndices;
- };
+ * Index into the ComplexShape::colors array which stores the vertex
+ * color for this point
+ */
+ unsigned int colorIndex;
+ /*!
+ * An array of texture coordinate set/texture coordinate index pairs
+ * describing all the UV coordinates for this point.
+ */
+ vector<TexCoordIndex> texCoordIndices;
+};
- /*!
- * Used by ComplexShape to describe a single polygon. Complex shape
- * polygons can have more than three points, unlike the triangels required
- * within the NIF format. Each face may also be associated with a
- * different set of NiProperty classes, enabling each face to have unique
- * material settings.
- */
- struct ComplexFace {
- /*! Constructor */
- NIFLIB_API ComplexFace() : propGroupIndex(CS_NO_INDEX) {}
- /*! Destructor */
- NIFLIB_API ~ComplexFace() {}
- /*! A list of points which make up this polygon */
- vector<ComplexPoint> points;
- /*!
- * Index into the ComplexShape::propGroups array which specifies which
- * set of NiProperty classes to apply to this face.
- */
- unsigned int propGroupIndex;
- };
+/*!
+ * Used by ComplexShape to describe a single polygon. Complex shape
+ * polygons can have more than three points, unlike the triangels required
+ * within the NIF format. Each face may also be associated with a
+ * different set of NiProperty classes, enabling each face to have unique
+ * material settings.
+ */
+struct ComplexFace {
+ /*! Constructor */
+ NIFLIB_API ComplexFace() : propGroupIndex(CS_NO_INDEX) {}
+ /*! Destructor */
+ NIFLIB_API ~ComplexFace() {}
+ /*! A list of points which make up this polygon */
+ vector<ComplexPoint> points;
+ /*!
+ * Index into the ComplexShape::propGroups array which specifies which
+ * set of NiProperty classes to apply to this face.
+ */
+ unsigned int propGroupIndex;
+};
+/*!
+ * Used by ComplexShape to store texture coordinate data and the
+ * associated type of texture, such as base, detail, or dark map.
+ */
+struct TexCoordSet {
+ /*!
+ * The type of the texture such as base, detail, bump, etc.
+ */
+ TexType texType;
/*!
- * Used by ComplexShape to store texture coordinate data and the
- * associated type of texture, such as base, detail, or dark map.
- */
- struct TexCoordSet {
- /*!
- * The type of the texture such as base, detail, bump, etc.
- */
- TexType texType;
- /*!
- * A list of all the texture cooridnates for this texture set.
- */
- vector<TexCoord> texCoords;
- };
+ * A list of all the texture cooridnates for this texture set.
+ */
+ vector<TexCoord> texCoords;
+};
+
+/*!
+ * This class is a helper object to ease the process of converting between the
+ * 3D model format of a NIF file, which is optimized for real time display via
+ * OpenGL or DirectX, and the more compact, complex format usually prefered by
+ * 3D modeling software.
+ *
+ * It is capable of mering multiple NiTriShape objects into one multi-material
+ * object with indexed data, or taking such an object and splitting it up into
+ * multiple NiTriShape objects.
+ */
+class ComplexShape {
+public:
/*!
* This function splits the contents of the ComplexShape into multiple
@@ -173,7 +173,7 @@ public:
* \return A referene to the root NiAVObject that was created.
*/
NIFLIB_API Ref<NiAVObject> Split(
- Ref<NiNode> & parent,
+ NiNode * parent,
Matrix44 & transform,
int max_bones_per_partition = 4,
bool stripify = false,
@@ -188,31 +188,107 @@ public:
* or a NiNode that is a split mesh proxy.
* \sa NiNode::IsSplitMeshProxy
*/
- NIFLIB_API void Merge( const Ref<NiAVObject> & root );
+ NIFLIB_API void Merge( NiAVObject * root );
/*
* Clears out all the data stored in this ComplexShape
*/
NIFLIB_API void Clear();
- //Setters
+ /*
+ * Sets the name of ComplexShape which will be used when splitting it into NiTriBasedGeom objects.
+ * \param[in] n The new name for the ComplexShape.
+ */
NIFLIB_API void SetName( const string & n );
- NIFLIB_API void SetVertices( const vector<WeightedVertex> & n );
- NIFLIB_API void SetColors( const vector<Color4> & n );
- NIFLIB_API void SetNormals( const vector<Vector3> & n );
- NIFLIB_API void SetTexCoordSets( const vector<TexCoordSet> & n );
- NIFLIB_API void SetFaces( const vector<ComplexFace> & n );
- NIFLIB_API void SetPropGroups( const vector< vector< Ref<NiProperty> > > & n );
- NIFLIB_API void SetSkinInfluences( const vector< Ref<NiNode> > & n );
- //Getters
+ /*
+ * Gets the name of ComplexShape. This may have been previously created or merged from NiTriBasedGeom objects which form a split mesh proxy.
+ * \return The new name of the ComplexShape.
+ */
NIFLIB_API string GetName() const;
+
+ /*
+ * Sets the vertex data that will be used by the ComplexShape, which includes position and skin weighting information. The data is referenced by vector index, so repetition of values is not necessary.
+ * \param[in] n The new vertex data. Will replace any existing data.
+ */
+ NIFLIB_API void SetVertices( const vector<WeightedVertex> & n );
+
+ /*
+ * Gets the vertex data from the ComplexShape. This includes position and skin weighting information.
+ * \return The vertex data stored in the ComplexShape.
+ */
NIFLIB_API vector<WeightedVertex> GetVertices() const;
+
+ /*
+ * Sets the color data that will be used by the ComplexShape. The data is referenced by vector index, so repetition of values is not necessary.
+ * \param[in] n The new color data. Will replace any existing data.
+ */
+ NIFLIB_API void SetColors( const vector<Color4> & n );
+
+ /*
+ * Gets the color data from the ComplexShape.
+ * \return The color data stored in the ComplexShape.
+ */
NIFLIB_API vector<Color4> GetColors() const;
+
+ /*
+ * Sets the normal data that will be used by the ComplexShape. The data is referenced by vector index, so repetition of values is not necessary.
+ * \param[in] n The new normal data. Will replace any existing data.
+ */
+ NIFLIB_API void SetNormals( const vector<Vector3> & n );
+
+ /*
+ * Gets the normal data from the ComplexShape.
+ * \return The normal data stored in the ComplexShape.
+ */
NIFLIB_API vector<Vector3> GetNormals() const;
+
+ /*
+ * Sets the texture coordinate data used by the ComplexShape. This includes a list of UV sets, each with a texture type and texture coordiantes. The coordinate data is referenced by index, so repetition of values within a particular set is not necessary.
+ * \param[in] n The new texture coordinate sets. Will replace any existing data.
+ */
+ NIFLIB_API void SetTexCoordSets( const vector<TexCoordSet> & n );
+
+ /*
+ * Gets the texture coordinate sets from the ComplexShape. Each set includes the type of texture and the texture coordinates.
+ * \return The texture coodinate sets stored in the ComplexShape.
+ */
NIFLIB_API vector<TexCoordSet> GetTexCoordSets() const;
+
+ /*
+ * Sets the faces used by the ComplexShape. Each face references 3 or more vertex positions (triangles are not required), each of which can reference color, normal, and texture, information. Each face also references a property group which defines the material and any other per-face attributes.
+ * \param[in] n The new face data. Will replace any existing data.
+ */
+ NIFLIB_API void SetFaces( const vector<ComplexFace> & n );
+
+ /*
+ * Gets the face data from the ComplexShape. Each face references 3 or more vertex positions (triangles are not required), each of which can reference color, normal, and texture, information. Each face also references a property group which defines the material and any other per-face attributes.
+ * \return The face data stored in the ComplexShape.
+ */
NIFLIB_API vector<ComplexFace> GetFaces() const;
+
+ /*
+ * Sets the property groups used by the Complex Shape. Each group of NiProperty values can be assigned by vector index to a face in the ComplexShape by index, allowing for material and other properties to be specified on a per-face basis. If the ComplexShape is split, each property group that is used by faces in the mesh will result in a separate NiTriBasedGeom with the specified propreties attached.
+ * \param[in] n The new property groups. Will replace any existing data.
+ */
+ NIFLIB_API void SetPropGroups( const vector< vector< Ref<NiProperty> > > & n );
+
+ /*
+ * Gets the property groups from the ComplexShape. Each group of NiProperty values can be assigned by vector index to a face in the ComplexShape by index, allowing for material and other properties to be specified on a per-face basis. If the ComplexShape is split, each property group that is used by faces in the mesh will result in a separate NiTriBasedGeom with the specified propreties attached.
+ * \return The property groups stored in the ComplexShape.
+ */
NIFLIB_API vector< vector< Ref<NiProperty> > > GetPropGroups() const;
+
+ /*
+ * Sets the skin influences used by the Complex Shape. These are the NiNode objects which cause deformations in skin meshes. They are referenced in the vertex data by vector index.
+ * \param[in] n The new skin influences. Will replace any existing data.
+ */
+ NIFLIB_API void SetSkinInfluences( const vector< Ref<NiNode> > & n );
+
+ /*
+ * Gets the skin influences from the ComplexShape. These are the NiNode objects which cause deformations in skin meshes. They are referenced in the vertex data by vector index.
+ * \return The skin influences referenced by the ComplexShape.
+ */
NIFLIB_API vector< Ref<NiNode> > GetSkinInfluences() const;
private:
diff --git a/src/ComplexShape.cpp b/src/ComplexShape.cpp
index 6b7e408d..c7ae8f85 100644
--- a/src/ComplexShape.cpp
+++ b/src/ComplexShape.cpp
@@ -128,7 +128,7 @@ string ComplexShape::GetName() const {
return name;
}
-vector<ComplexShape::WeightedVertex> ComplexShape::GetVertices() const {
+vector<WeightedVertex> ComplexShape::GetVertices() const {
return vertices;
}
@@ -140,11 +140,11 @@ vector<Vector3> ComplexShape::GetNormals() const {
return normals;
}
-vector<ComplexShape::TexCoordSet> ComplexShape::GetTexCoordSets() const {
+vector<TexCoordSet> ComplexShape::GetTexCoordSets() const {
return texCoordSets;
}
-vector< ComplexShape::ComplexFace > ComplexShape::GetFaces() const {
+vector<ComplexFace> ComplexShape::GetFaces() const {
return faces;
}
@@ -174,7 +174,7 @@ struct MergeLookUp {
map<unsigned int, unsigned int> uvIndices; //TexCoordSet Index, TexCoord Index
};
-void ComplexShape::Merge( const Ref<NiAVObject> & root ) {
+void ComplexShape::Merge( NiAVObject * root ) {
if ( root == NULL ) {
throw runtime_error("Called ComplexShape::Merge with a null root reference.");
@@ -583,7 +583,7 @@ void ComplexShape::Merge( const Ref<NiAVObject> & root ) {
// }
//}
-Ref<NiAVObject> ComplexShape::Split( Ref<NiNode> & parent, Matrix44 & transform, int max_bones_per_partition, bool stripify, bool tangent_space ) const {
+Ref<NiAVObject> ComplexShape::Split( NiNode * parent, Matrix44 & transform, int max_bones_per_partition, bool stripify, bool tangent_space ) const {
//Make sure parent is not NULL
if ( parent == NULL ) {
--
GitLab