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