src/ui/effects/inc/FUiEffects_RuntimeIScriptProcessing.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   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
   8 //
   9 //     http://floralicense.org/license/
  10 //
  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.
  16 //
  17 /**
  18  * @file        FUiEffects_RuntimeIScriptProcessing.h
  19  * @brief       This is the header file for the IScriptProcessing class.
  20  */
  21
  22 #ifndef _FUI_EFFECTS_INTERNAL_RUNTIME_ISCRIPT_PROCESSING_H_
  23 #define _FUI_EFFECTS_INTERNAL_RUNTIME_ISCRIPT_PROCESSING_H_
  24
  25 #include <FUiEffectsTypes.h>
  26 #include <FUiEffects_PeElementSurface.h>
  27 #include "FUiEffects_RuntimeModel.h"
  28
  29 namespace Tizen { namespace Ui { namespace Effects { namespace _Runtime
  30 {
  31
  32 /**
  33  * @class       IScriptProcessing
  34  * @brief       This class is an interface between EffectModel and ScriptProcessing module -
  35  *                      for calling script functions by EffectModel
  36  *
  37  * @since 2.0
  38  *
  39  */
  40 class IScriptProcessing
  41 {
  42
  43 public:
  44         /**
  45          * Class destructor
  46          *
  47          * @since 2.0
  48          *
  49          * @remarks             In case if in the future be needed do the memory allocation of
  50          *                              class-inheritor under the pointer to base class (memory leak prevention)
  51          */
  52         virtual ~IScriptProcessing(void)
  53         {
  54         }
  55
  56         /**
  57          * Calls Initialize script function for Initialize event handling
  58          *
  59          * @since 2.0
  60          *
  61          */
  62         virtual bool Initialize(void) = 0;
  63
  64         /**
  65          * Calls OnEffectStart script function for OnEffectStart event handling
  66          *
  67          * @since 2.0
  68          *
  69          */
  70         virtual bool OnEffectStart(const EffectsVector<float>& effectStartInfo) = 0;
  71
  72         /**
  73          * Calls OnEffectCalculate script function for OnEffectCalculate event handling
  74          *
  75          * @since 2.0
  76          *
  77          */
  78         virtual bool OnEffectCalculate(float dt) = 0;
  79
  80         /**
  81          * Calls OnTouchPressed script function for OnTouchPressed event handling
  82          *
  83          * @since 2.0
  84          *
  85          */
  86         virtual bool OnTouchPressed(const TouchEventScript &position) = 0;
  87
  88         /**
  89          * Calls OnTouchDoublePressed script function for OnTouchDoublePressed event handling
  90          *
  91          * @since 2.0
  92          *
  93          */
  94         virtual bool OnTouchDoublePressed(const TouchEventScript &position) = 0;
  95
  96         /**
  97          * Calls OnTouchMoved script function for OnTouchMoved event handling
  98          *
  99          * @since 2.0
 100          *
 101          */
 102         virtual bool OnTouchMoved(const TouchEventScript &position) = 0;
 103
 104         /**
 105          * Calls OnTouchReleased script function for OnTouchReleased event handling
 106          *
 107          * @since 2.0
 108          *
 109          */
 110         virtual bool OnTouchReleased(const TouchEventScript &position) = 0;
 111
 112         /**
 113          * Calls IsEffectFinished script function for IsEffectFinished event handling
 114          *
 115          * @since 2.0
 116          *
 117          */
 118         virtual ::Tizen::Ui::Effects::_Runtime::EffectResultS IsEffectFinished(void) = 0;
 119
 120 }; // IScriptProcessing
 121
 122 } } } } // Tizen::Ui::Effects::_Runtime
 123
 124 #endif //_FUI_EFFECTS_INTERNAL_RUNTIME_ISCRIPT_PROCESSING_H_