OgrePredefinedControllers.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2013 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE SOFTWARE.
26-----------------------------------------------------------------------------
27*/
28#ifndef __PredefinedControllers_H__
29#define __PredefinedControllers_H__
30
31#include "OgrePrerequisites.h"
32
33#include "OgreCommon.h"
34#include "OgreController.h"
35#include "OgreFrameListener.h"
36#include "OgreGpuProgram.h"
37#include "OgreHeaderPrefix.h"
38
39namespace Ogre {
40
47 //-----------------------------------------------------------------------
48 // Controller Values
49 //-----------------------------------------------------------------------
53 {
54 protected:
59
60 public:
64 Real getValue(void) const;
65 void setValue(Real value);
66 Real getTimeFactor(void) const;
68 Real getFrameDelay(void) const;
70 Real getElapsedTime(void) const;
72 };
73
74 //-----------------------------------------------------------------------
78 {
79 protected:
81 public:
83
86 Real getValue(void) const;
89 void setValue(Real value);
90
91 };
92 //-----------------------------------------------------------------------
102 {
103 protected:
104 bool mTransU, mTransV;
105 bool mScaleU, mScaleV;
108 public:
124 bool scaleU = false, bool scaleV = false, bool rotate = false );
125
126 Real getValue(void) const;
127 void setValue(Real value);
128
129 };
130
131 //-----------------------------------------------------------------------
145 {
146 protected:
151 public:
159 size_t index );
160
162
163 Real getValue(void) const;
164 void setValue(Real value);
165
166 };
167 //-----------------------------------------------------------------------
168 // Controller functions
169 //-----------------------------------------------------------------------
170
175 {
176 public:
183
187 };
188
192 {
193 protected:
196 public:
204
208
213 };
214
215 //-----------------------------------------------------------------------
219 {
220 protected:
222 public:
231
235
236 };
237
238 //-----------------------------------------------------------------------
259 {
260 protected:
267
270
271 public:
279 WaveformControllerFunction(WaveformType wType, Real base = 0, Real frequency = 1, Real phase = 0, Real amplitude = 1, bool deltaInput = true, Real dutyCycle = 0.5);
280
284
285 };
286 //-----------------------------------------------------------------------
290}
291
292#include "OgreHeaderSuffix.h"
293
294#endif
#define _OgreExport
Predefined controller function for dealing with animation.
Real calculate(Real source)
Overridden function.
void setSequenceTime(Real seqVal)
Set the sequence duration value manually.
AnimationControllerFunction(Real sequenceTime, Real timeOffset=0.0f)
Constructor.
void setTime(Real timeVal)
Set the time value manually.
Subclasses of this class are responsible for performing a function on an input value for a Controller...
Can either be used as an input or output value.
Predefined controller value for setting a single floating- point value in a constant parameter of a v...
FloatGpuParameterControllerValue(GpuProgramParametersSharedPtr params, size_t index)
Constructor.
GpuProgramParametersSharedPtr mParams
The parameters to access.
size_t mParamIndex
The index of the parameter to be read or set.
A interface class defining a listener which can be used to receive notifications of frame events.
Predefined controller value for getting the latest frame time.
bool frameStarted(const FrameEvent &evt)
Called when a frame is about to begin rendering.
void setElapsedTime(Real elapsedTime)
bool frameEnded(const FrameEvent &evt)
Called just after a frame has been rendered.
Real getElapsedTime(void) const
Real getTimeFactor(void) const
Real getFrameDelay(void) const
Predefined controller function which just passes through the original source directly to dest.
Real calculate(Real source)
Overridden function.
PassthroughControllerFunction(bool deltaInput=false)
Constructor.
Predefined controller function which simply scales an input to an output value.
ScaleControllerFunction(Real scalefactor, bool deltaInput)
Constructor, requires a scale factor.
Real calculate(Real source)
Overridden method.
Reference-counted shared pointer, used for objects where implicit destruction is required.
Predefined controller value for getting / setting a texture coordinate modifications (scales and tran...
TexCoordModifierControllerValue(TextureUnitState *t, bool translateU=false, bool translateV=false, bool scaleU=false, bool scaleV=false, bool rotate=false)
Constructor.
Predefined controller value for getting / setting the frame number of a texture layer.
Real getValue(void) const
Gets the frame number as a parametric value in the range [0,1].
void setValue(Real value)
Sets the frame number as a parametric value in the range [0,1]; the actual frame number is (value * n...
TextureFrameControllerValue(TextureUnitState *t)
Class representing the state of a single texture unit during a Pass of a Technique,...
Predefined controller function based on a waveform.
WaveformControllerFunction(WaveformType wType, Real base=0, Real frequency=1, Real phase=0, Real amplitude=1, bool deltaInput=true, Real dutyCycle=0.5)
Default constructor, requires at least a wave type, other parameters can be defaulted unless required...
Real getAdjustedInput(Real input)
Overridden from ControllerFunction.
Real calculate(Real source)
Overridden function.
WaveformType
Enumerates the wave types usable with the Ogre engine.
Definition OgreCommon.h:162
float Real
Software floating point type.
Struct containing information about a frame event.

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.