bsp-version.h

Go to the documentation of this file.

/*
 * bsp-version.h
 *
 * Copyright (C) 2010  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 */

#ifndef WAVEPACKET_QUAKE_BSP_VERSION_H__
#define WAVEPACKET_QUAKE_BSP_VERSION_H__

// includes --------------------------------------------------------------------
#include "geometry/geometry_3d.h"

#include <iostream>


namespace quake {

/// \ingroup quake_bsp
/*@{*/


enum eBspVendor {
        eBspVendor_Id           = 1,    ///< Id Software, magic = "IBSP"
        eBspVendor_Valve        = 2,    ///< Valve Softare, magic = "VBSP"

        // keep this last!
        eBspVendor_Invalid      = 0
};



enum eBspVersion {
        // ID versions
        eBspVersion_IdQuake3    = 1001,

        // Valve versions

        // keep this last!
        eBspVersion_Invalid     = 0
};



/// types of lumps in BSP maps.  There are many types of lumps, and no vendor
///     seems to 100% agree on what they are!  Some examples:
///  - ID Quake3: http://www.mralligator.com/q3/
///  - Valve: http://developer.valvesoftware.com/wiki/The_Source_Engine_BSP_File_Format
enum eLumpType {
        // lumps in the Quake3 bsp format
        eLump_Entities          =  1,   ///< game objects in map
        eLump_Textures          =  2,   ///< surface descriptions
        eLump_Planes            =  3,   ///< planes used by map/BSP geometry
        eLump_Nodes             =  4,   ///< BSP tree nodes
        eLump_Leafs             =  5,   ///< leaves in the BSP tree
        eLump_Leaffaces         =  6,   ///< list of face indices, one list per leaf
        eLump_Leafbrushes       =  7,   ///< list of brush indices, one list per leaf
        eLump_Models            =  8,   ///< rigid world models
        eLump_Brushes           =  9,   ///< convex polyhedra for collisions
        eLump_Brushsides        = 10,   ///< brush surfaces
        eLump_Vertices          = 11,   ///< vertices used to describe faces
        eLump_Meshverts         = 12,   ///< lists of offsets, one per mesh
        eLump_Effects           = 13,   ///< special map effects
        eLump_Faces             = 14,   ///< surface geometry
        eLump_Lightmaps         = 15,   ///< packed lightmap data
        eLump_Lightvols         = 16,   ///< local illumination data
        eLump_Visdata           = 17,   ///< cluster-cluster visibility map

        // keep this last!
        eLump_Invalid           = 0
};

typedef std::vector<eLumpType> vec_lump_type_t;

/// for debugging
const char * getLumpName(IN eLumpType type);



////////////////////////////////////////////////////////////////////////////////
//
//      basic parsing
//
////////////////////////////////////////////////////////////////////////////////

/// read an integer.  These are stored as little-endian in BSP files.
int32_t readInt(IO std::istream& stream);

/// read a float.  These are stored as little-endian in BSP files.
float readFloat(IO std::istream& stream);

/// read a vector/point (helper function using readFloat() above)
point3d_t readPoint3d(IO std::istream& stream);


/// bsp version object
class BspVersion {
public:
        // constructor, destructor ---------------------------------------------
        BspVersion(void) throw() { this->clear(); }

        // quake::BspVersion public class methods ------------------------------
        void clear(void) throw();
        bool isValid(void) const throw();
        void read(IO std::istream& stream);
        eBspVendor getVendor(void) const throw() { return m_vendor; }
        eBspVersion getVersion(void) const throw() { return m_version; }
        bool getLumpTypes(OUT vec_lump_type_t& lumps) const;

protected:
        eBspVendor              m_vendor;
        eBspVersion             m_version;
};



};      // media namespace



#endif  // WAVEPACKET_QUAKE_BSP_VERSION_H__