From 8d4648be57338f0dfbf0aa29c278b4d8c77fd6e4 Mon Sep 17 00:00:00 2001
From: Shon Ferguson <shonferg@users.sourceforge.net>
Date: Fri, 4 May 2007 22:56:52 +0000
Subject: [PATCH] More documentation. Removed access to unknown data in
NiPSysEmitterCtlrData.
---
include/obj/NiPSysEmitterCtlrData.h | 12 ------------
include/obj/NiPalette.h | 6 ++++--
include/obj/NiPixelData.h | 18 ++++++++++++------
src/obj/NiPSysEmitterCtlrData.cpp | 16 ----------------
4 files changed, 16 insertions(+), 36 deletions(-)
diff --git a/include/obj/NiPSysEmitterCtlrData.h b/include/obj/NiPSysEmitterCtlrData.h
index f925bf8b..c943d29b 100644
--- a/include/obj/NiPSysEmitterCtlrData.h
+++ b/include/obj/NiPSysEmitterCtlrData.h
@@ -36,18 +36,6 @@ public:
NIFLIB_HIDDEN virtual void FixLinks( const map<unsigned int,NiObjectRef> & objects, list<unsigned int> & link_stack, const NifInfo & info );
NIFLIB_HIDDEN virtual list<NiObjectRef> GetRefs() const;
- /*!
- * Unknown.
- */
- NIFLIB_API KeyGroup<float > GetFloatKeys_() const;
- NIFLIB_API void SetFloatKeys_( KeyGroup<float > value );
-
- /*!
- * Unknown.
- */
- NIFLIB_API vector<Key<byte > > GetVisibilityKeys_() const;
- NIFLIB_API void SetVisibilityKeys_( const vector<Key<byte > >& value );
-
protected:
NI_P_SYS_EMITTER_CTLR_DATA_MEMBERS
private:
diff --git a/include/obj/NiPalette.h b/include/obj/NiPalette.h
index 6813dd75..e4ad0c25 100644
--- a/include/obj/NiPalette.h
+++ b/include/obj/NiPalette.h
@@ -32,13 +32,15 @@ public:
NIFLIB_HIDDEN virtual void FixLinks( const map<unsigned int,NiObjectRef> & objects, list<unsigned int> & link_stack, const NifInfo & info );
NIFLIB_HIDDEN virtual list<NiObjectRef> GetRefs() const;
- /*! Retrieves the palette data from this palette object.
+ /*!
+ * Retrieves the palette data from this palette object.
* \return A vector containing the the colors stored in the palette.
* \sa NiPalette::SetPalette
*/
NIFLIB_API vector<Color4> GetPalette() const;
- /*! Sets the palette data for this palette object.
+ /*!
+ * Sets the palette data for this palette object.
* \param new_pal A vector containing the the new colors to be stored in the palette.
* \sa NiPalette::GetPalette
*/
diff --git a/include/obj/NiPixelData.h b/include/obj/NiPixelData.h
index 2de7cf82..e1b1c796 100644
--- a/include/obj/NiPixelData.h
+++ b/include/obj/NiPixelData.h
@@ -39,25 +39,29 @@ public:
NIFLIB_HIDDEN virtual void FixLinks( const map<unsigned int,NiObjectRef> & objects, list<unsigned int> & link_stack, const NifInfo & info );
NIFLIB_HIDDEN virtual list<NiObjectRef> GetRefs() const;
- /*! Retrieves the height of the texture image stored in this object.
+ /*!
+ * Retrieves the height of the texture image stored in this object.
* \return The height of the texture image stored in this object.
* \sa NiPixelData::GetWidth, NiPixelData::GetPixelFormat
*/
NIFLIB_API int GetHeight() const;
- /*! Retrieves the width of the texture image stored in this object.
+ /*!
+ * Retrieves the width of the texture image stored in this object.
* \return The width of the texture image stored in this object.
* \sa NiPixelData::GetHeight, NiPixelData::GetPixelFormat
*/
NIFLIB_API int GetWidth() const;
- /*! Retrieves the pixel format of the texture image stored in this object.
+ /*!
+ * Retrieves the pixel format of the texture image stored in this object.
* \return The pixel format of the texture image stored in this object.
* \sa NiPixelData::GetWidth, NiPixelData::GetHeight
*/
NIFLIB_API PixelFormat GetPixelFormat() const;
- /*! Deletes all image data and sets a new size and format in preparation for new data to be provided.
+ /*!
+ * Deletes all image data and sets a new size and format in preparation for new data to be provided.
* \param new_width The width of the new texture image.
* \param new_height The height of the new texture image.
* \param px_fmt The pixel format of the new texture image.
@@ -65,13 +69,15 @@ public:
*/
NIFLIB_API void Reset( int new_width, int new_height, PixelFormat px_fmt );
- /*! Retrieves the the pixels of the texture image stored in this object. This function does not work on palettized textures.
+ /*!
+ * Retrieves the the pixels of the texture image stored in this object. This function does not work on palettized textures.
* \return A vector containing the colors of each pixel in the texture image stored in this object, one row after another starting from the bottom of the image. The width of the image must be used to interpret them correctly.
* \sa NiPixelData::SetColors, NiPixelData::GetWidth
*/
NIFLIB_API vector<Color4> GetColors() const;
- /*! Sets the the pixels of the texture image stored in this object and optionally generates mipmaps. This function does not work for palettized textures.
+ /*!
+ * Sets the the pixels of the texture image stored in this object and optionally generates mipmaps. This function does not work for palettized textures.
* \param new_pixels A vector containing the colors of each new pixel to be set in the texture image stored in this object, one row after another starting from the botom of the image.
* \param generate_mipmaps If true, mipmaps will be generated for the new image and stored in the file.
* \sa NiPixelData::GetColors, NiPixelData::GetWidth
diff --git a/src/obj/NiPSysEmitterCtlrData.cpp b/src/obj/NiPSysEmitterCtlrData.cpp
index 80a70ec7..15204fbf 100644
--- a/src/obj/NiPSysEmitterCtlrData.cpp
+++ b/src/obj/NiPSysEmitterCtlrData.cpp
@@ -36,22 +36,6 @@ const Type & NiPSysEmitterCtlrData::GetType() const {
return TYPE;
};
-KeyGroup<float > NiPSysEmitterCtlrData::GetFloatKeys_() const {
- return floatKeys_;
-}
-
-void NiPSysEmitterCtlrData::SetFloatKeys_( KeyGroup<float > value ) {
- floatKeys_ = value;
-}
-
-vector<Key<byte > > NiPSysEmitterCtlrData::GetVisibilityKeys_() const {
- return visibilityKeys_;
-}
-
-void NiPSysEmitterCtlrData::SetVisibilityKeys_( const vector<Key<byte > >& value ) {
- visibilityKeys_ = value;
-}
-
const Type & NiPSysEmitterCtlrData::TypeConst() {
return TYPE;
}
--
GitLab