PickupRepresentation.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program 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 2
 *   of the License, or (at your option) any later version.
 *
 *   This program 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 this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Damian 'Mozork' Frick
 *   Co-authors:
 *      ...
 *
*/

#ifndef _PickupRepresentation_H__
#define _PickupRepresentation_H__

#include "PickupPrereqs.h"

#include "core/XMLPort.h"

#include "interfaces/Pickupable.h"
#include "worldentities/StaticEntity.h"

#include "PickupSpawner.h"

#include "core/BaseObject.h"
#include "network/synchronisable/Synchronisable.h"

namespace orxonox // tolua_export
{ // tolua_export

    class _PickupExport PickupRepresentation // tolua_export
        : public BaseObject, public Synchronisable
    { // tolua_export

        public:
            PickupRepresentation(); 
            PickupRepresentation(Context* context); 
            virtual ~PickupRepresentation(); 

            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override; 

            inline const std::string& getPickupName(void) const { return this->name_; } // tolua_export
            inline const std::string& getPickupDescription(void) const { return this->description_; } // tolua_export
            inline const std::string& getSpawnerTemplate(void) const
                { return this->spawnerTemplate_; }
            inline const StaticEntity* getSpawnerRepresentationIndex(unsigned int index) const
                { if(index == 0) return this->spawnerRepresentation_; return nullptr; }
            inline const std::string& getInventoryRepresentation(void) const { return this->inventoryRepresentation_; } // tolua_export

            virtual void changedName() override;

            StaticEntity* createSpawnerRepresentation(PickupSpawner* spawner); 

        protected:
            inline void setPickupName(const std::string& name)
                { this->name_ = name; }
            inline void setPickupDescription(const std::string& description)
                { this->description_ = description; }
            inline void setSpawnerTemplate(const std::string& spawnerTemplate)
                { this->spawnerTemplate_ = spawnerTemplate; }
            void setSpawnerRepresentation(StaticEntity* representation);

            inline void setInventoryRepresentation(const std::string& image)
                { this->inventoryRepresentation_ = image; }

        private:
            void initialize(void); 
            StaticEntity* getDefaultSpawnerRepresentation(PickupSpawner* spawner); 

            void registerVariables(void); 

            std::string name_; 
            std::string description_; 
            std::string spawnerTemplate_; 
            StaticEntity* spawnerRepresentation_; 
            std::string inventoryRepresentation_; 

    }; // tolua_export

} // tolua_export

#endif // _PickupRepresentation_H__