/usr/include/cegui-0.8.4/CEGUI/Affector.h is in libcegui-mk2-dev 0.8.4+dfsg-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 | /***********************************************************************
created: 7/8/2010
author: Martin Preisler
purpose: Defines the interface for the Affector clas
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2010 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIAffector_h_
#define _CEGUIAffector_h_
#include "CEGUI/String.h"
#include "CEGUI/KeyFrame.h"
#include <map>
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Defines an 'affector' class
Affector is part of Animation definition. It is set to affect
one Property using one Interpolator.
\todo
moveKeyFrame, this will be vital for any animation editing tools
*/
class CEGUIEXPORT Affector : public AllocatedObject<Affector>
{
public:
//! enumerates the possible methods of application
enum ApplicationMethod
{
//! applies values as absolutes
AM_Absolute,
/** saves a base value after the animation is started and applies
* relatively to that
*/
AM_Relative,
/** saves a base value after the animation is started and applies
* by multiplying this base value with key frame floats
*/
AM_RelativeMultiply
};
/** internal constructor, please construct Affectors via
* Animation::createAffector only
*/
Affector(Animation* parent);
//! destructor, this destroys all key frames defined inside this affector
~Affector(void);
/*!
\brief
Retrieves the parent animation of this keyframe
*/
inline Animation* getParent() const
{
return d_parent;
}
/*!
\brief
Retrieves index with which this affector is retrievable in parent Animation
\note
The index is only valid as long as the list of affectors is unchanged in animation!
*/
size_t getIdxInParent() const;
/*!
\brief
Sets the application method
\par
Values can be applied in 2 ways - as absolute values or relative to base
value that is retrieved and saved after animation is started
*/
void setApplicationMethod(ApplicationMethod method);
/*!
\brief
Retrieves current application method
\see
Affector::setApplicationMethod
*/
ApplicationMethod getApplicationMethod() const;
/*!
\brief
Sets the property that will be affected
*/
void setTargetProperty(const String& target);
/*!
\brief
Gets the property that will be affected
*/
const String& getTargetProperty() const;
/*!
\brief
Sets interpolator of this Affector
\par
Interpolator has to be set for the Affector to work!
*/
void setInterpolator(Interpolator* interpolator);
/*!
\brief
Sets interpolator of this Affector
\par
Interpolator has to be set for the Affector to work!
*/
void setInterpolator(const String& name);
/*!
\brief
Retrieves currently used interpolator of this Affector
*/
Interpolator* getInterpolator() const;
/*!
\brief
Creates a KeyFrame at given position
*/
KeyFrame* createKeyFrame(float position);
/*!
\brief
Creates a KeyFrame at given position
\par
This is a helper method, you can set all these values after you create
the KeyFrame
*/
KeyFrame* createKeyFrame(float position, const String& value,
KeyFrame::Progression progression = KeyFrame::P_Linear,
const String& sourceProperty = "");
/*!
\brief
Destroys given keyframe
*/
void destroyKeyFrame(KeyFrame* keyframe);
/*!
\brief
Retrieves a KeyFrame at given position
*/
KeyFrame* getKeyFrameAtPosition(float position) const;
/*!
\brief
Checks whether there is a key frame at given position
*/
bool hasKeyFrameAtPosition(float position) const;
/*!
\brief
Retrieves a KeyFrame with given index
*/
KeyFrame* getKeyFrameAtIdx(size_t index) const;
/*!
\brief
Returns number of key frames defined in this affector
*/
size_t getNumKeyFrames() const;
/*!
\brief
Moves given key frame to given new position
*/
void moveKeyFrameToPosition(KeyFrame* keyframe, float newPosition);
/*!
\brief
Moves key frame at given old position to given new position
*/
void moveKeyFrameToPosition(float oldPosition, float newPosition);
/*!
\brief
Internal method, causes all properties that are used by this affector
and it's keyframes to be saved
\par
So their values are still known after
they've been affected.
*/
void savePropertyValues(AnimationInstance* instance);
/*!
\brief
Applies this Affector's definition with parameters from given
Animation Instance
\par
This function is internal so unless you know what you're doing, don't
touch!
\see
AnimationInstance
*/
void apply(AnimationInstance* instance);
/*!
\brief
Writes an xml representation of this Affector to \a out_stream.
\param xml_stream
Stream where xml data should be output.
*/
void writeXMLToStream(XMLSerializer& xml_stream) const;
private:
//! parent animation definition
Animation* d_parent;
//! application method
ApplicationMethod d_applicationMethod;
//! property that gets affected by this affector
String d_targetProperty;
//! curently used interpolator (has to be set for the Affector to work!)
Interpolator* d_interpolator;
typedef std::map<float, KeyFrame*, std::less<float>
CEGUI_MAP_ALLOC(float, KeyFrame*)> KeyFrameMap;
/** keyframes of this affector (if there are no keyframes, this affector
* won't do anything!)
*/
KeyFrameMap d_keyFrames;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIAffector_h_
|