GCC Code Coverage Report
Directory: src/ Exec Total Coverage
File: src/particle/particlecontainer.h Lines: 0 2 0.0 %
Date: 2017-11-29 Branches: 0 0 0.0 %

Line Branch Exec Source
1
/*
2
 *  The ManaPlus Client
3
 *  Copyright (C) 2008-2009  The Mana World Development Team
4
 *  Copyright (C) 2009-2010  The Mana Developers
5
 *  Copyright (C) 2011-2017  The ManaPlus Developers
6
 *
7
 *  This file is part of The ManaPlus Client.
8
 *
9
 *  This program is free software; you can redistribute it and/or modify
10
 *  it under the terms of the GNU General Public License as published by
11
 *  the Free Software Foundation; either version 2 of the License, or
12
 *  any later version.
13
 *
14
 *  This program is distributed in the hope that it will be useful,
15
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17
 *  GNU General Public License for more details.
18
 *
19
 *  You should have received a copy of the GNU General Public License
20
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
21
 */
22
23
#ifndef PARTICLE_PARTICLECONTAINER_H
24
#define PARTICLE_PARTICLECONTAINER_H
25
26
#include "localconsts.h"
27
28
/**
29
 * Set of particle effects.  May be stacked with other ParticleContainers.  All
30
 * operations herein affect such stacked containers, unless the operations end
31
 * in `Locally'.
32
 */
33
class ParticleContainer notfinal
34
{
35
    public:
36
        /**
37
         * Constructs a new particle container and assumes responsibility for
38
         * its parent (for all operations defined herein,
39
         * except when ending in `Locally')
40
         *
41
         * delParent means that the destructor should also free the parent.
42
         */
43
        explicit ParticleContainer(ParticleContainer *const parent = nullptr,
44
                                   const bool delParent = true);
45
46
        A_DELETE_COPY(ParticleContainer)
47
48
        virtual ~ParticleContainer();
49
50
        /**
51
         * Kills and removes all particle effects
52
         */
53
        void clear();
54
55
        /**
56
         * Kills and removes all particle effects (only in this container)
57
         */
58
        virtual void clearLocally()
59
        { }
60
61
        /**
62
         * Sets the positions of all elements
63
         */
64
        virtual void moveTo(const float x, const float y);
65
66
    protected:
67
        ParticleContainer *mNext;           /**< Contained container, if any */
68
        bool mDelParent;                    /**< Delete mNext in destructor */
69
};
70
71
#endif  // PARTICLE_PARTICLECONTAINER_H