Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/usability/src/modules/pickup/PickupRepresentation.cc @ 11913

Last change on this file since 11913 was 7978, checked in by rgrieder, 14 years ago

Increased code readability by replacing some BLANKSTRING with plain old "".

  • Property svn:eol-style set to native
File size: 7.2 KB
Line 
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
29/**
30    @file PickupRepresentation.cc
31    @brief Implementation of the PickupRepresentation class.
32*/
33
34#include "PickupRepresentation.h"
35
36#include "core/CoreIncludes.h"
37#include "core/GameMode.h"
38#include "util/StringUtils.h"
39
40#include "graphics/Billboard.h"
41
42#include "PickupManager.h"
43
44namespace orxonox
45{
46
47    CreateFactory(PickupRepresentation);
48
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    */
54    PickupRepresentation::PickupRepresentation() : BaseObject(NULL), Synchronisable(NULL), spawnerRepresentation_(NULL), pickup_(NULL)
55    {
56        RegisterObject(PickupRepresentation);
57
58        this->initialize();
59        this->setSyncMode(0x0); // The default PickupRperesentation created by each PickupManager is not synchronised, since it only exists locally.
60    }
61
62    /**
63    @brief
64        Default Constructor. Registers the object and initializes its member variables.
65    */
66    PickupRepresentation::PickupRepresentation(BaseObject* creator) : BaseObject(creator), Synchronisable(creator), spawnerRepresentation_(NULL), pickup_(NULL)
67    {
68        RegisterObject(PickupRepresentation);
69
70        this->initialize();
71        this->registerVariables();
72
73        PickupManager::getInstance().registerRepresentation(this); // Registers the PickupRepresentation with the PickupManager.
74    }
75
76    /**
77    @brief
78        Destructor.
79    */
80    PickupRepresentation::~PickupRepresentation()
81    {
82        if(this->spawnerRepresentation_ != NULL)
83            this->spawnerRepresentation_->destroy();
84
85        if(this->isInitialized())
86        {
87            if(GameMode::isMaster() && this->pickup_ != NULL)
88            {
89                PickupManager::getInstance().unregisterRepresentation(this->pickup_->getPickupIdentifier(), this);
90            }
91            PickupManager::getInstance().unregisterRepresentation(this);
92        }
93    }
94
95    /**
96    @brief
97        Initializes the member variables of this PickupRepresentation.
98    */
99    void PickupRepresentation::initialize(void)
100    {
101        this->description_ = "This is a pickup.";
102        this->name_ = "Pickup";
103        this->spawnerTemplate_ = "";
104        this->inventoryRepresentation_ = "Default";
105    }
106
107    /**
108    @brief
109        Registers the variables that need to be synchornised.
110    */
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
118    /**
119    @brief
120        Method for creating a PickupRepresentation object through XML.
121    */
122    void PickupRepresentation::XMLPort(Element& xmlelement, XMLPort::Mode mode)
123    {
124        SUPER(PickupRepresentation, XMLPort, xmlelement, mode);
125
126        XMLPortParam(PickupRepresentation, "pickupName", setPickupName, getPickupName, xmlelement, mode);
127        XMLPortParam(PickupRepresentation, "pickupDescription", setPickupDescription, getPickupDescription, xmlelement, mode);
128        XMLPortParam(PickupRepresentation, "spawnerTemplate", setSpawnerTemplate, getSpawnerTemplate, xmlelement, mode);
129        XMLPortParam(PickupRepresentation, "inventoryRepresentation", setInventoryRepresentation, getInventoryRepresentation, xmlelement, mode);
130        XMLPortObject(PickupRepresentation, Pickupable, "pickup", setPickup, getPickup, xmlelement, mode);
131        XMLPortObject(PickupRepresentation, StaticEntity, "spawner-representation", setSpawnerRepresentation, getSpawnerRepresentationIndex, xmlelement, mode);
132
133        if(GameMode::isMaster())
134        {
135            // Registers the PickupRepresentation with the PickupManager through the PickupIdentifier of the Pickupable it represents.
136            PickupManager::getInstance().registerRepresentation(this->pickup_->getPickupIdentifier(), this);
137        }
138
139        if(this->spawnerRepresentation_ != NULL)
140            this->spawnerRepresentation_->setVisible(false);
141
142        COUT(4) << "PickupRepresentation created: name: '" << this->name_ << "', description: '" << this->description_ << "', spawnerTemplate: '" << this->spawnerTemplate_ << "'." << std::endl;
143    }
144
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    */
153    StaticEntity* PickupRepresentation::getSpawnerRepresentation(PickupSpawner* spawner)
154    {
155        if(this->spawnerRepresentation_ == NULL)
156        {
157            COUT(4) << "PickupRepresentation: No spawner representation found." << std::endl;
158            if(this->spawnerTemplate_ == "")
159            {
160                COUT(4) << "PickupRepresentation: Spawner template is empty." << std::endl;
161                // If neither spawnerRepresentation nor spawnerTemplate was specified
162                return this->getDefaultSpawnerRepresentation(spawner);
163            }
164            this->addTemplate(this->spawnerTemplate_);
165        }
166
167        StaticEntity* representation = this->spawnerRepresentation_;
168        representation->setVisible(true);
169
170        this->addTemplate(this->spawnerTemplate_);
171        this->spawnerRepresentation_->setVisible(false);
172
173        return representation;
174    }
175
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    */
185    //TODO: Possibility to define default representation through XML?
186    StaticEntity* PickupRepresentation::getDefaultSpawnerRepresentation(PickupSpawner* spawner)
187    {
188        StaticEntity* representation = new StaticEntity(spawner);
189        Billboard* sphere = new Billboard(spawner);
190        sphere->setColour(ColourValue(0.95f, 0.85f, 0.27f));
191        sphere->setMaterial("Sphere2");
192        sphere->setScale(0.1f);
193        Billboard* icon = new Billboard(spawner);
194        icon->setColour(ColourValue(0.89f, 0.79f, 0.08f));
195        icon->setMaterial("Asterix");
196        icon->setScale(0.5);
197        sphere->attach(icon);
198        representation->attach(sphere);
199        return representation;
200    }
201
202}
Note: See TracBrowser for help on using the repository browser.