Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/SuperOrxoBros_HS18/SuperOrxoBros_HS18/src/libraries/core/object/Destroyable.cc @ 12175

Last change on this file since 12175 was 12175, checked in by siramesh, 5 years ago

Super Orxo Bros (Sidharth Ramesh, Nisa Balta, Jeff Ren)

File size: 3.1 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 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @brief Implementation of Destroyable.
32*/
33
34#include "Destroyable.h"
35#include "DestroyLaterManager.h"
36#include "core/class/IdentifierManager.h"
37
38#include <cassert>
39
40namespace orxonox
41{
42    /**
43        @brief Constructor: Sets the default values.
44    */
45    Destroyable::Destroyable()
46    {
47        this->referenceCount_ = 0;
48        this->requestedDestruction_ = false;
49    }
50
51    /**
52        @brief Destructor: Notifies all DestructionListener (for example @ref WeakPtr "weak pointers") that this object is being deleted.
53    */
54    Destroyable::~Destroyable()
55    {
56        if (!this->requestedDestruction_ && IdentifierManager::exists() && !IdentifierManager::getInstance().isCreatingHierarchy())
57            orxout(internal_warning) << "Deleted destroyable object without destroy()" << endl;
58
59        assert(this->referenceCount_ <= 0);
60
61        // notify all destruction listeners
62        for (std::set<DestructionListener*>::iterator it = this->destructionListeners_.begin(); it != this->destructionListeners_.end(); )
63            (*(it++))->objectDeleted();
64    }
65
66    /**
67        @brief Deletes the object if no @ref orxonox::StrongPtr "strong pointers" point to this object. Otherwise schedules the object to be deleted as soon as possible.
68        Always call destroy() instead of using 'delete' directly, otherwise strong pointers won't work.
69    */
70    void Destroyable::destroy()
71    {
72        assert(this); // Just in case someone tries to delete a nullptr
73        this->requestedDestruction_ = true;
74        if (this->referenceCount_ == 0)
75        {
76            this->preDestroy();
77            if (this->referenceCount_ == 0)
78                delete this;
79        }
80    }
81
82    /**
83     * Works like @ref destroy() but doesn't destroy the object until the current tick has ended.
84     */
85    void Destroyable::destroyLater()
86    {
87        // register in DestroyLaterManager - this ensures that a strongPtr points to this object and keeps it alive for a while
88        DestroyLaterManager::getInstance().retain(this);
89
90        // request destruction -> object will be deleted after all strongPtrs (including the one in DestroyLaterManager) were destroyed.
91        this->destroy();
92    }
93}
Note: See TracBrowser for help on using the repository browser.