Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/pickup/PickupRepresentation.cc @ 8061

Last change on this file since 8061 was 7548, checked in by dafrick, 14 years ago

Resolving some TODO's.

  • Property svn:eol-style set to native
File size: 7.2 KB
RevLine 
[6474]1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27*/
28
[6540]29/**
30    @file PickupRepresentation.cc
31    @brief Implementation of the PickupRepresentation class.
32*/
33
[6474]34#include "PickupRepresentation.h"
35
36#include "core/CoreIncludes.h"
[7504]37#include "core/GameMode.h"
[7540]38#include "util/StringUtils.h"
39
[6475]40#include "graphics/Billboard.h"
[7540]41
[6474]42#include "PickupManager.h"
43
44namespace orxonox
45{
[7163]46
[6474]47    CreateFactory(PickupRepresentation);
[7163]48
[6475]49    /**
50    @brief
51        Constructor. Registers the object and initializes its member variables.
52        This is primarily for use of the PickupManager in creating a default PickupRepresentation.
53    */
[7504]54    PickupRepresentation::PickupRepresentation() : BaseObject(NULL), Synchronisable(NULL), spawnerRepresentation_(NULL), pickup_(NULL)
[6474]55    {
56        RegisterObject(PickupRepresentation);
[7163]57
[6474]58        this->initialize();
[7540]59        this->setSyncMode(0x0); // The default PickupRperesentation created by each PickupManager is not synchronised, since it only exists locally.
[6474]60    }
[7163]61
[6475]62    /**
63    @brief
64        Default Constructor. Registers the object and initializes its member variables.
65    */
[7504]66    PickupRepresentation::PickupRepresentation(BaseObject* creator) : BaseObject(creator), Synchronisable(creator), spawnerRepresentation_(NULL), pickup_(NULL)
[6474]67    {
68        RegisterObject(PickupRepresentation);
[7163]69
[6474]70        this->initialize();
[7504]71        this->registerVariables();
72
[7540]73        PickupManager::getInstance().registerRepresentation(this); // Registers the PickupRepresentation with the PickupManager.
[6474]74    }
[7163]75
[6475]76    /**
77    @brief
78        Destructor.
79    */
[6474]80    PickupRepresentation::~PickupRepresentation()
81    {
[6475]82        if(this->spawnerRepresentation_ != NULL)
83            this->spawnerRepresentation_->destroy();
[7163]84
[7504]85        if(this->isInitialized())
86        {
87            if(GameMode::isMaster() && this->pickup_ != NULL)
88            {
89                PickupManager::getInstance().unregisterRepresentation(this->pickup_->getPickupIdentifier(), this);
90            }
[7548]91            PickupManager::getInstance().unregisterRepresentation(this);
[7504]92        }
[6474]93    }
[7163]94
[6475]95    /**
96    @brief
97        Initializes the member variables of this PickupRepresentation.
98    */
[6474]99    void PickupRepresentation::initialize(void)
100    {
101        this->description_ = "This is a pickup.";
102        this->name_ = "Pickup";
103        this->spawnerTemplate_ = "";
[6711]104        this->inventoryRepresentation_ = "Default";
[6474]105    }
[7163]106
[7540]107    /**
108    @brief
109        Registers the variables that need to be synchornised.
110    */
[7504]111    void PickupRepresentation::registerVariables(void)
112    {
113        registerVariable(this->description_, VariableDirection::ToClient);
114        registerVariable(this->name_, VariableDirection::ToClient);
115        registerVariable(this->inventoryRepresentation_, VariableDirection::ToClient);
116    }
117
[6475]118    /**
119    @brief
120        Method for creating a PickupRepresentation object through XML.
121    */
[6474]122    void PickupRepresentation::XMLPort(Element& xmlelement, XMLPort::Mode mode)
123    {
124        SUPER(PickupRepresentation, XMLPort, xmlelement, mode);
[7163]125
[6711]126        XMLPortParam(PickupRepresentation, "pickupName", setPickupName, getPickupName, xmlelement, mode);
127        XMLPortParam(PickupRepresentation, "pickupDescription", setPickupDescription, getPickupDescription, xmlelement, mode);
[6474]128        XMLPortParam(PickupRepresentation, "spawnerTemplate", setSpawnerTemplate, getSpawnerTemplate, xmlelement, mode);
[6711]129        XMLPortParam(PickupRepresentation, "inventoryRepresentation", setInventoryRepresentation, getInventoryRepresentation, xmlelement, mode);
[6474]130        XMLPortObject(PickupRepresentation, Pickupable, "pickup", setPickup, getPickup, xmlelement, mode);
131        XMLPortObject(PickupRepresentation, StaticEntity, "spawner-representation", setSpawnerRepresentation, getSpawnerRepresentationIndex, xmlelement, mode);
[7163]132
[7504]133        if(GameMode::isMaster())
134        {
[7540]135            // Registers the PickupRepresentation with the PickupManager through the PickupIdentifier of the Pickupable it represents.
136            PickupManager::getInstance().registerRepresentation(this->pickup_->getPickupIdentifier(), this);
[7504]137        }
[7163]138
[6484]139        if(this->spawnerRepresentation_ != NULL)
140            this->spawnerRepresentation_->setVisible(false);
[7163]141
[6484]142        COUT(4) << "PickupRepresentation created: name: '" << this->name_ << "', description: '" << this->description_ << "', spawnerTemplate: '" << this->spawnerTemplate_ << "'." << std::endl;
[6474]143    }
[7163]144
[6475]145    /**
146    @brief
147        Get a spawnerRepresentation for a specific PickupSpawner.
148    @param spawner
149        A pointer to the PickupSpawner.
150    @return
151        Returns a pointer to the StaticEntity.
152    */
[6474]153    StaticEntity* PickupRepresentation::getSpawnerRepresentation(PickupSpawner* spawner)
154    {
155        if(this->spawnerRepresentation_ == NULL)
156        {
157            COUT(4) << "PickupRepresentation: No spawner representation found." << std::endl;
[6475]158            if(this->spawnerTemplate_ == BLANKSTRING)
[6474]159            {
160                COUT(4) << "PickupRepresentation: Spawner template is empty." << std::endl;
[7540]161                // If neither spawnerRepresentation nor spawnerTemplate was specified
[6474]162                return this->getDefaultSpawnerRepresentation(spawner);
163            }
164            this->addTemplate(this->spawnerTemplate_);
165        }
[7163]166
[6474]167        StaticEntity* representation = this->spawnerRepresentation_;
[6484]168        representation->setVisible(true);
[7163]169
[6474]170        this->addTemplate(this->spawnerTemplate_);
[6484]171        this->spawnerRepresentation_->setVisible(false);
[7163]172
[6474]173        return representation;
174    }
[7163]175
[6475]176    /**
177    @brief
178        Get the default spawnerRepresentation for a specific PickupSpawner.
179        Helper method of internal use.
180    @param spawner
181        A pointer to the PickupSpawner.
182    @return
183        Returns a pointer to the StaticEntity.
184    */
[7540]185    //TODO: Possibility to define default representation through XML?
[6474]186    StaticEntity* PickupRepresentation::getDefaultSpawnerRepresentation(PickupSpawner* spawner)
187    {
188        StaticEntity* representation = new StaticEntity(spawner);
[6512]189        Billboard* sphere = new Billboard(spawner);
[6676]190        sphere->setColour(ColourValue(0.95f, 0.85f, 0.27f));
[6512]191        sphere->setMaterial("Sphere2");
[6676]192        sphere->setScale(0.1f);
[6512]193        Billboard* icon = new Billboard(spawner);
[6676]194        icon->setColour(ColourValue(0.89f, 0.79f, 0.08f));
[6512]195        icon->setMaterial("Asterix");
196        icon->setScale(0.5);
197        sphere->attach(icon);
198        representation->attach(sphere);
[6474]199        return representation;
200    }
[7163]201
[6474]202}
Note: See TracBrowser for help on using the repository browser.