OGRE: OgreSerializer.h Source File - OGRE Documentation

# OgreSerializer.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004     (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028
    00029 #ifndef __Serializer_H__
    00030 #define __Serializer_H__
    00031
    00032 #include "OgrePrerequisites.h"
    00033 #include "OgreString.h"
    00034 #include "OgreDataStream.h"
    00035
    00036 namespace Ogre {
    00037
    00049     class _OgreExport Serializer : public SerializerAlloc
    00050     {
    00051     public:
    00052         Serializer();
    00053         virtual ~Serializer();
    00054
    00056         enum Endian
    00057         {
    00059             ENDIAN_NATIVE,
    00061             ENDIAN_BIG,
    00063             ENDIAN_LITTLE
    00064         };
    00065
    00066
    00067     protected:
    00068
    00069         uint32 mCurrentstreamLen;
    00070         FILE* mpfFile;
    00071         String mVersion;
    00072         bool mFlipEndian; // default to native endian, derive from header
    00073
    00074         // Internal methods
    00075         virtual void writeFileHeader(void);
    00076         virtual void writeChunkHeader(uint16 id, size_t size);
    00077
    00078         void writeFloats(const float* const pfloat, size_t count);
    00079         void writeFloats(const double* const pfloat, size_t count);
    00080         void writeShorts(const uint16* const pShort, size_t count);
    00081         void writeInts(const uint32* const pInt, size_t count);
    00082         void writeBools(const bool* const pLong, size_t count);
    00083         void writeObject(const Vector3& vec);
    00084         void writeObject(const Quaternion& q);
    00085
    00086         void writeString(const String& string);
    00087         void writeData(const void* const buf, size_t size, size_t count);
    00088
    00089         virtual void readFileHeader(DataStreamPtr& stream);
    00090         virtual unsigned short readChunk(DataStreamPtr& stream);
    00091
    00092         void readBools(DataStreamPtr& stream, bool* pDest, size_t count);
    00093         void readFloats(DataStreamPtr& stream, float* pDest, size_t count);
    00094         void readFloats(DataStreamPtr& stream, double* pDest, size_t count);
    00095         void readShorts(DataStreamPtr& stream, uint16* pDest, size_t count);
    00096         void readInts(DataStreamPtr& stream, uint32* pDest, size_t count);
    00097         void readObject(DataStreamPtr& stream, Vector3& pDest);
    00098         void readObject(DataStreamPtr& stream, Quaternion& pDest);
    00099
    00100         String readString(DataStreamPtr& stream);
    00101         String readString(DataStreamPtr& stream, size_t numChars);
    00102
    00103         virtual void flipToLittleEndian(void* pData, size_t size, size_t count = 1);
    00104         virtual void flipFromLittleEndian(void* pData, size_t size, size_t count = 1);
    00105
    00106         virtual void flipEndian(void * pData, size_t size, size_t count);
    00107         virtual void flipEndian(void * pData, size_t size);
    00108
    00110         virtual void determineEndianness(DataStreamPtr& stream);
    00112         virtual void determineEndianness(Endian requestedEndian);
    00113     };
    00117 }
    00118
    00119
    00120 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52