root/cafu/trunk/CaWE/MapWorld.hpp

/*
=================================================================================
This file is part of Cafu, the open-source game engine and graphics engine
for multiplayer, cross-platform, real-time 3D action.
Copyright (C) 2002-2012 Carsten Fuchs Software.

Cafu is free software: you can redistribute it and/or modify it under the terms
of the GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.

Cafu is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with Cafu. If not, see <http://www.gnu.org/licenses/>.

For support and more information about Cafu, visit us at <http://www.cafu.de>.
=================================================================================
*/

#ifndef CAFU_MAP_WORLD_HPP_INCLUDED
#define CAFU_MAP_WORLD_HPP_INCLUDED

#include "MapEntityBase.hpp"


class EditorMaterialI;
namespace cf { namespace TypeSys { class TypeInfoT; } }
namespace cf { namespace TypeSys { class CreateParamsT; } }


class MapWorldT : public MapEntityBaseT
{
    public:

    /// The constructor. The world is given a reference to the document it is contained within / managed by.
    /// It is aesthetically unpleasing to have the world know about its document, but sometimes
    /// (e.g. for learning about the game config), it's simply required.
    MapWorldT(MapDocumentT& MapDoc);

    /// The copy constructor for copying a world.
    /// @param World   The world to copy-construct this world from.
    MapWorldT(const MapWorldT& World);


    // Implementations and overrides for base class methods.
    MapWorldT* Clone() const;
    void       Assign(const MapElementT* Elem);


    MapDocumentT& GetDoc() const { return m_MapDoc; }

    // MapElementT virtual overrides.
    BoundingBox3fT GetBB() const;

    // The TypeSys related declarations for this class.
    virtual const cf::TypeSys::TypeInfoT* GetType() const { return &TypeInfo; }
    static void* CreateInstance(const cf::TypeSys::CreateParamsT& Params);
    static const cf::TypeSys::TypeInfoT TypeInfo;


    private:

    void operator = (const MapWorldT&);     ///< Use of the Assignment Operator is not allowed.

    MapDocumentT& m_MapDoc;                 ///< The document that contains, keeps and manages this world.
};

#endif