Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/object/Destroyable.cc @ 10437

Last change on this file since 10437 was 9944, checked in by landauf, 11 years ago

no Thilo, we don't want to call preDestroy()
made documentation of destroy() and preDestroy() more explicit.

  • Property svn:eol-style set to native
File size: 2.3 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
36#include <cassert>
37
38namespace orxonox
39{
40    /**
41        @brief Constructor: Sets the default values.
42    */
43    Destroyable::Destroyable()
44    {
45        this->referenceCount_ = 0;
46        this->requestedDestruction_ = false;
47    }
48
49    /**
50        @brief Destructor: Notifies all DestructionListener (for example @ref WeakPtr "weak pointers") that this object is being deleted.
51    */
52    Destroyable::~Destroyable()
53    {
54        assert(this->referenceCount_ <= 0);
55
56        // notify all destruction listeners
57        for (std::set<DestructionListener*>::iterator it = this->destructionListeners_.begin(); it != this->destructionListeners_.end(); )
58            (*(it++))->objectDeleted();
59    }
60
61    /**
62        @brief Deletes the object if no @ref orxonox::SmartPtr "smart pointers" point to this object. Otherwise schedules the object to be deleted as soon as possible.
63        Always call destroy() instead of using 'delete' directly, otherwise smart pointers won't work.
64    */
65    void Destroyable::destroy()
66    {
67        assert(this); // Just in case someone tries to delete a NULL pointer
68        this->requestedDestruction_ = true;
69        if (this->referenceCount_ == 0)
70        {
71            this->preDestroy();
72            if (this->referenceCount_ == 0)
73                delete this;
74        }
75    }
76}
Note: See TracBrowser for help on using the repository browser.