2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
5 // Licensed under the Flora License, Version 1.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://floralicense.org/license/
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an AS IS BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
18 * @file FUiEffects_RuntimeIEffectModelManager.h
19 * @brief This is the header file for the IEffectModelManager class.
22 #ifndef _FUI_EFFECTS_INTERNAL_RUNTIME_IEFFECT_MODEL_MANAGER_H_
23 #define _FUI_EFFECTS_INTERNAL_RUNTIME_IEFFECT_MODEL_MANAGER_H_
25 namespace Tizen { namespace Ui { namespace Effects { namespace _Runtime
28 class RenderDataScene;
31 * @class IEffectModelManager
32 * @brief This class is an interface between EffectModel and _EffectImpl
33 * for handling _EffectImpl events by EffectModel
37 class IEffectModelManager
41 * Virtual interface destructor
46 virtual ~IEffectModelManager(void)
51 * Calls script function OnEffectStart, preparing effect to starting
56 virtual int Start(const EffectsVector<float>& effectStartInfo) = 0;
59 * Stops effect performing and initializes it
64 virtual void Stop(bool isBreakdown, bool isInterruptedFromApplication) = 0;
72 virtual void Calculate(float dt) = 0;
75 * Event touch pressed handler
79 * @remarks It is called from up level from corresponding event handler
81 virtual void FeedTouchPressEvent(const TouchEventScript &pos3) = 0;
84 * Event touch moved handler
88 * @remarks It is called from up level from corresponding event handler,
90 virtual void FeedTouchMoveEvent(const TouchEventScript &pos3) = 0;
93 * Event touch released handler
97 * @remarks It is called from up level from corresponding event handler,
99 virtual void FeedTouchReleaseEvent(const TouchEventScript &pos3) = 0;
102 * Event touch double pressed handler
106 * @remarks It is called from up level from corresponding event handler,
108 virtual void FeedTouchDoublePressEvent(const TouchEventScript &pos3) = 0;
111 * Returns time passed from the effect beginning
116 virtual float GetCalculationPeriodForTimer(void) const = 0;
119 * Returns current effect state (see enumeration _EffectState)
124 virtual _EffectState GetState(void) const = 0;
127 * Returns effect behaviour type (see enumeration EffectType)
132 virtual EffectType GetType(void) const = 0;
135 * Returns the pointer to collection of structure RenderData elements
136 * to up level (to renderer)
140 * @remarks The size of this collection is equal to quantity of graphical surfaces;
141 * this function is called once from up level for renderer
143 virtual RenderDataScene* GetRenderingData(void) const = 0;
146 * Updates all graphical surfaces
150 * @remarks It is called by renderer timer
151 * for updating graphical points
153 virtual void UpdateGraphicalSurfaces(void) = 0;
155 virtual long GetId(void) const = 0;
156 virtual std::string GetName(void) const = 0;
158 }; // IEffectModelManager
160 } } } } // Tizen::Ui::Effects::_Runtime
162 #endif //_FUI_EFFECTS_INTERNAL_RUNTIME_IEFFECT_MODEL_MANAGER_H_