Coverage Report

Created: 2025-07-11 06:36

/src/ogre/PlugIns/ParticleFX/include/OgreScaleAffector.h
Line
Count
Source (jump to first uncovered line)
1
/*
2
-----------------------------------------------------------------------------
3
This source file is part of OGRE
4
(Object-oriented Graphics Rendering Engine)
5
For the latest info, see http://www.ogre3d.org/
6
7
Copyright (c) 2000-2014 Torus Knot Software Ltd
8
9
Permission is hereby granted, free of charge, to any person obtaining a copy
10
of this software and associated documentation files (the "Software"), to deal
11
in the Software without restriction, including without limitation the rights
12
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
copies of the Software, and to permit persons to whom the Software is
14
furnished to do so, subject to the following conditions:
15
16
The above copyright notice and this permission notice shall be included in
17
all copies or substantial portions of the Software.
18
19
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25
THE SOFTWARE.
26
-----------------------------------------------------------------------------
27
*/
28
#ifndef __ScaleAffector_H__
29
#define __ScaleAffector_H__
30
31
#include "OgreParticleFXPrerequisites.h"
32
#include "OgreParticleAffector.h"
33
#include "OgreStringInterface.h"
34
35
namespace Ogre {
36
    /** \addtogroup Plugins
37
    *  @{
38
    */
39
    /** \addtogroup ParticleFX
40
    *  @{
41
    */
42
43
    /** This affector scales particles in flight.
44
    */
45
    class ScaleAffector : public ParticleAffector
46
    {
47
    public:
48
49
        /** Command object for scale adjust (see ParamCommand).*/
50
        class CmdScaleAdjust : public ParamCommand
51
        {
52
        public:
53
            String doGet(const void* target) const override;
54
            void doSet(void* target, const String& val) override;
55
        };
56
57
        /** Default constructor. */
58
        ScaleAffector(ParticleSystem* psys);
59
60
        void _initParticle(Particle* pParticle) override;
61
        void _affectParticles(ParticleSystem* pSystem, Real timeElapsed) override;
62
63
        /** Sets the scale adjustment to be made per second to particles. 
64
        @param rate
65
            Sets the adjustment to be made to the x and y scale components per second. These
66
            values will be added to the scale of all particles every second, scaled over each frame
67
            for a smooth adjustment.
68
        */
69
        void setAdjust( Real rate );
70
71
        /** Gets the scale adjustment to be made per second to particles. */
72
        Real getAdjust(void) const;
73
74
0
        const Vector2& getScaleRange() const {  return mScaleRange; }
75
0
        void setScaleRange(const Vector2& range) {  mScaleRange = range; }
76
77
        static CmdScaleAdjust msScaleCmd;
78
79
    protected:
80
        float mScaleAdj;
81
        Vector2 mScaleRange;
82
    };
83
84
    /** @} */
85
    /** @} */
86
}
87
88
89
#endif
90