source/graphics/CinemaPath.h

   1 /* Copyright (C) 2017 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef INCLUDED_CINEMAPATH
  19 #define INCLUDED_CINEMAPATH
  20
  21 #include "maths/NUSpline.h"
  22 #include "ps/CStr.h"
  23
  24 class CVector3D;
  25 class CVector4D;
  26 class CCamera;
  27
  28 // For loading data
  29 class CCinemaData
  30 {
  31 public:
  32         CCinemaData() : m_LookAtTarget(false), m_GrowthCount(0), m_Growth(1), m_Switch(1), m_Timescale(fixed::FromInt(1)) {}
  33         virtual ~CCinemaData() {}
  34
  35         const CCinemaData* GetData() const { return this; }
  36
  37         CStrW m_Name;
  38         CStrW m_Orientation;
  39         CStrW m_Mode;
  40         CStrW m_Style;
  41
  42         bool m_LookAtTarget;
  43
  44         fixed m_Timescale; // a negative timescale results in backwards play
  45
  46         // Distortion variables
  47         mutable float m_GrowthCount;
  48         float m_Growth;
  49         float m_Switch;
  50 };
  51
  52
  53 // Once the data is part of the path, it shouldn't be changeable, so use private inheritance.
  54 // This class encompasses the spline and the information which determines how the path will operate
  55 // and also provides the functionality for doing so
  56
  57 class CCinemaPath : private CCinemaData, public TNSpline
  58 {
  59 public:
  60         CCinemaPath() : m_TimeElapsed(0), m_PreviousNodeTime(0) {}
  61         CCinemaPath(const CCinemaData& data, const TNSpline& spline, const TNSpline& targetSpline);
  62
  63         // Sets camera position to calculated point on spline
  64         void MoveToPointAt(float t, float nodet, const CVector3D& startRotation, CCamera* camera) const;
  65
  66         // Distortion mode functions-change how ratio is passed to distortion style functions
  67         float EaseIn(float t) const;
  68         float EaseOut(float t) const;
  69         float EaseInOut(float t) const;
  70         float EaseOutIn(float t) const;
  71
  72         // Distortion style functions
  73         float EaseDefault(float t) const;
  74         float EaseGrowth(float t) const;
  75         float EaseExpo(float t) const;
  76         float EaseCircle(float t) const;
  77         float EaseSine(float t) const;
  78
  79         float (CCinemaPath::*DistStylePtr)(float ratio) const;
  80         float (CCinemaPath::*DistModePtr)(float ratio) const;
  81
  82         const CCinemaData* GetData() const;
  83
  84 public:
  85
  86         CVector3D GetNodePosition(const int index) const;
  87         fixed GetNodeDuration(const int index) const;
  88         fixed GetDuration() const;
  89
  90         float GetNodeFraction() const;
  91         float GetElapsedTime() const;
  92
  93         const CStrW& GetName() const;
  94
  95         void SetTimescale(fixed scale);
  96
  97         float m_TimeElapsed;
  98         float m_PreviousNodeTime; // How much time has passed before the current node
  99
 100         size_t m_CurrentNode;
 101         CVector3D m_PreviousRotation;
 102
 103 public:
 104
 105         /**
 106          * Returns false if finished.
 107          * @param deltaRealTime Elapsed real time since the last frame.
 108          * @param camera An affected camera
 109          */
 110         bool Play(const float deltaRealTime, CCamera* camera);
 111
 112         /**
 113          * Validate the path
 114          * @return true if the path is valid
 115          */
 116         bool Validate();
 117
 118         /**
 119          * Returns true if path doesn't contain nodes
 120          */
 121         bool Empty() const;
 122
 123         /**
 124          * Resets the path state
 125          */
 126         void Reset();
 127
 128         fixed GetTimescale() const;
 129
 130         const TNSpline& GetTargetSpline() const;
 131
 132 private:
 133
 134         TNSpline m_TargetSpline;
 135 };
 136
 137 #endif // INCLUDED_CINEMAPATH