OGRE
1.9.0
OgreMain
include
OgrePredefinedControllers.h
Go to the documentation of this file.
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 __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
39
namespace
Ogre
{
40
47
//-----------------------------------------------------------------------
48
// Controller Values
49
//-----------------------------------------------------------------------
52
class
_OgreExport
FrameTimeControllerValue
:
public
ControllerValue
<Real>,
public
FrameListener
53
{
54
protected
:
55
Real
mFrameTime
;
56
Real
mTimeFactor
;
57
Real
mElapsedTime
;
58
Real
mFrameDelay
;
59
60
public
:
61
FrameTimeControllerValue
();
62
bool
frameEnded(
const
FrameEvent
&evt);
63
bool
frameStarted(
const
FrameEvent
&evt);
64
Real
getValue(
void
)
const
;
65
void
setValue(
Real
value);
66
Real
getTimeFactor(
void
)
const
;
67
void
setTimeFactor(
Real
tf);
68
Real
getFrameDelay(
void
)
const
;
69
void
setFrameDelay(
Real
fd);
70
Real
getElapsedTime(
void
)
const
;
71
void
setElapsedTime(
Real
elapsedTime);
72
};
73
74
//-----------------------------------------------------------------------
77
class
_OgreExport
TextureFrameControllerValue
:
public
ControllerValue
<Real>
78
{
79
protected
:
80
TextureUnitState
*
mTextureLayer
;
81
public
:
82
TextureFrameControllerValue
(
TextureUnitState
* t);
83
86
Real
getValue(
void
)
const
;
89
void
setValue(
Real
value);
90
91
};
92
//-----------------------------------------------------------------------
101
class
_OgreExport
TexCoordModifierControllerValue
:
public
ControllerValue
<Real>
102
{
103
protected
:
104
bool
mTransU,
mTransV
;
105
bool
mScaleU,
mScaleV
;
106
bool
mRotate
;
107
TextureUnitState
*
mTextureLayer
;
108
public
:
123
TexCoordModifierControllerValue
(
TextureUnitState
* t,
bool
translateU =
false
,
bool
translateV =
false
,
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
//-----------------------------------------------------------------------
144
class
_OgreExport
FloatGpuParameterControllerValue
:
public
ControllerValue
<Real>
145
{
146
protected
:
148
GpuProgramParametersSharedPtr
mParams
;
150
size_t
mParamIndex
;
151
public
:
158
FloatGpuParameterControllerValue
(
GpuProgramParametersSharedPtr
params,
159
size_t
index );
160
161
~FloatGpuParameterControllerValue
() {}
162
163
Real
getValue(
void
)
const
;
164
void
setValue(
Real
value);
165
166
};
167
//-----------------------------------------------------------------------
168
// Controller functions
169
//-----------------------------------------------------------------------
170
174
class
_OgreExport
PassthroughControllerFunction
:
public
ControllerFunction
<Real>
175
{
176
public
:
182
PassthroughControllerFunction
(
bool
deltaInput =
false
);
183
186
Real
calculate(
Real
source);
187
};
188
191
class
_OgreExport
AnimationControllerFunction
:
public
ControllerFunction
<Real>
192
{
193
protected
:
194
Real
mSeqTime
;
195
Real
mTime
;
196
public
:
203
AnimationControllerFunction
(
Real
sequenceTime,
Real
timeOffset = 0.0f);
204
207
Real
calculate(
Real
source);
208
210
void
setTime(
Real
timeVal);
212
void
setSequenceTime(
Real
seqVal);
213
};
214
215
//-----------------------------------------------------------------------
218
class
_OgreExport
ScaleControllerFunction
:
public
ControllerFunction
<Real>
219
{
220
protected
:
221
Real
mScale
;
222
public
:
230
ScaleControllerFunction
(
Real
scalefactor,
bool
deltaInput);
231
234
Real
calculate(
Real
source);
235
236
};
237
238
//-----------------------------------------------------------------------
258
class
_OgreExport
WaveformControllerFunction
:
public
ControllerFunction
<Real>
259
{
260
protected
:
261
WaveformType
mWaveType
;
262
Real
mBase
;
263
Real
mFrequency
;
264
Real
mPhase
;
265
Real
mAmplitude
;
266
Real
mDutyCycle
;
267
269
Real
getAdjustedInput(
Real
input);
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
283
Real
calculate(
Real
source);
284
285
};
286
//-----------------------------------------------------------------------
290
}
291
292
#include "
OgreHeaderSuffix.h
"
293
294
#endif
Ogre::WaveformControllerFunction
Predefined controller function based on a waveform.
Definition:
OgrePredefinedControllers.h:258
_OgreExport
#define _OgreExport
Definition:
OgrePlatform.h:260
Ogre::WaveformType
WaveformType
Enumerates the wave types usable with the Ogre engine.
Definition:
OgreCommon.h:161
Ogre::WaveformControllerFunction::mAmplitude
Real mAmplitude
Definition:
OgrePredefinedControllers.h:265
Ogre::AnimationControllerFunction
Predefined controller function for dealing with animation.
Definition:
OgrePredefinedControllers.h:191
Ogre::ControllerFunction
Subclasses of this class are responsible for performing a function on an input value for a Controller...
Definition:
OgreController.h:56
Ogre::Real
float Real
Software floating point type.
Definition:
OgrePrerequisites.h:70
Ogre::WaveformControllerFunction::mDutyCycle
Real mDutyCycle
Definition:
OgrePredefinedControllers.h:266
Ogre::WaveformControllerFunction::mBase
Real mBase
Definition:
OgrePredefinedControllers.h:262
Ogre::AnimationControllerFunction::mTime
Real mTime
Definition:
OgrePredefinedControllers.h:195
Ogre::FrameTimeControllerValue::mElapsedTime
Real mElapsedTime
Definition:
OgrePredefinedControllers.h:57
Ogre::WaveformControllerFunction::mFrequency
Real mFrequency
Definition:
OgrePredefinedControllers.h:263
OgreFrameListener.h
Ogre::FloatGpuParameterControllerValue::mParamIndex
size_t mParamIndex
The index of the parameter to be read or set.
Definition:
OgrePredefinedControllers.h:150
Ogre::TexCoordModifierControllerValue
Predefined controller value for getting / setting a texture coordinate modifications (scales and tran...
Definition:
OgrePredefinedControllers.h:101
Ogre::ControllerValue
Can either be used as an input or output value.
Definition:
OgreController.h:105
OgreController.h
Ogre::FrameTimeControllerValue::mTimeFactor
Real mTimeFactor
Definition:
OgrePredefinedControllers.h:56
OgreCommon.h
Ogre::FloatGpuParameterControllerValue::~FloatGpuParameterControllerValue
~FloatGpuParameterControllerValue()
Definition:
OgrePredefinedControllers.h:161
Ogre::TextureUnitState
Class representing the state of a single texture unit during a Pass of a Technique,...
Definition:
OgreTextureUnitState.h:62
OgrePrerequisites.h
Ogre::TexCoordModifierControllerValue::mScaleV
bool mScaleV
Definition:
OgrePredefinedControllers.h:105
Ogre::TexCoordModifierControllerValue::mTransV
bool mTransV
Definition:
OgrePredefinedControllers.h:104
Ogre::AnimationControllerFunction::mSeqTime
Real mSeqTime
Definition:
OgrePredefinedControllers.h:194
Ogre::FrameTimeControllerValue::mFrameTime
Real mFrameTime
Definition:
OgrePredefinedControllers.h:55
Ogre::FrameEvent
Struct containing information about a frame event.
Definition:
OgreFrameListener.h:44
Ogre::TexCoordModifierControllerValue::mRotate
bool mRotate
Definition:
OgrePredefinedControllers.h:106
Ogre::TextureFrameControllerValue::mTextureLayer
TextureUnitState * mTextureLayer
Definition:
OgrePredefinedControllers.h:80
Ogre::WaveformControllerFunction::mPhase
Real mPhase
Definition:
OgrePredefinedControllers.h:264
OgreHeaderSuffix.h
Ogre::TexCoordModifierControllerValue::mTextureLayer
TextureUnitState * mTextureLayer
Definition:
OgrePredefinedControllers.h:107
Ogre::PassthroughControllerFunction
Predefined controller function which just passes through the original source directly to dest.
Definition:
OgrePredefinedControllers.h:174
Ogre::ScaleControllerFunction
Predefined controller function which simply scales an input to an output value.
Definition:
OgrePredefinedControllers.h:218
Ogre
Definition:
OgreAndroidLogListener.h:34
Ogre::FloatGpuParameterControllerValue::mParams
GpuProgramParametersSharedPtr mParams
The parameters to access.
Definition:
OgrePredefinedControllers.h:148
Ogre::SharedPtr< GpuProgramParameters >
OgreHeaderPrefix.h
Ogre::ScaleControllerFunction::mScale
Real mScale
Definition:
OgrePredefinedControllers.h:221
Ogre::TextureFrameControllerValue
Predefined controller value for getting / setting the frame number of a texture layer.
Definition:
OgrePredefinedControllers.h:77
Ogre::WaveformControllerFunction::mWaveType
WaveformType mWaveType
Definition:
OgrePredefinedControllers.h:261
Ogre::FrameTimeControllerValue::mFrameDelay
Real mFrameDelay
Definition:
OgrePredefinedControllers.h:58
Ogre::FloatGpuParameterControllerValue
Predefined controller value for setting a single floating- point value in a constant parameter of a v...
Definition:
OgrePredefinedControllers.h:144
Ogre::FrameTimeControllerValue
Predefined controller value for getting the latest frame time.
Definition:
OgrePredefinedControllers.h:52
OgreGpuProgram.h
Ogre::FrameListener
A interface class defining a listener which can be used to receive notifications of frame events.
Definition:
OgreFrameListener.h:79
Generated on Sun Jun 30 2019 17:12:17 for OGRE by
1.8.15