inc/FUiEffectsEffectManager.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0
  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        FUiEffectsEffectManager.h
  19 * @brief       This is the header file for the %EffectManager class.
  20 *
  21 * This header file contains the declarations of the %EffectManager class.
  22 */
  23
  24 #ifndef _FUI_EFFECTS_EFFECT_MANAGER_H_
  25 #define _FUI_EFFECTS_EFFECT_MANAGER_H_
  26
  27 #include <FBaseObject.h>
  28 #include <FUiEffectsTypes.h>
  29
  30
  31 namespace Tizen { namespace Base {
  32 class String;
  33 }} // Tizen::Base
  34
  35
  36 namespace Tizen { namespace Ui { namespace Effects
  37 {
  38
  39 class _EffectManagerImpl;
  40 class Effect;
  41
  42 /**
  43  * @class                       EffectManager
  44  * @brief This class contains API for managing effects.
  45  *
  46  * @since 2.0
  47  *
  48  * The %EffectManager class contains API for managing effects.
  49  */
  50 class _OSP_EXPORT_ EffectManager
  51         : public Tizen::Base::Object
  52 {
  53 public:
  54         /**
  55          * Gets the effect manager instance.
  56          *
  57          * @since 2.0
  58          *
  59          * @return                      A pointer to the %EffectManager instance
  60          * @exception           E_SUCCESS                          The %EffectManager instance is constructed successfully.
  61          * @exception           E_OPERATION_FAILED         The system has failed to initialize the 3D system.
  62          */
  63          static EffectManager* GetInstance(void);
  64
  65         /**
  66          * Destroys all previously created effects and their resources. @n
  67          * Application can use OpenGL APIs only after invoking this method.
  68          *
  69          * @since 2.0
  70          */
  71          static void DestroyInstance(void);
  72
  73         /**
  74          * Creates a new effect from the specified effect file.
  75          *
  76          * @since 2.0
  77          *
  78          * @return A pointer to the Effect instance, @n
  79          *                      else @c null if an error occurs
  80          * @param [in]          filePath                           The file path of the effect
  81          * @exception           E_SUCCESS                          The effect is created successfully.
  82          * @exception           E_FILE_NOT_FOUND           The specified effect file does not exist.
  83          * @exception           E_PARSING_FAILED           A syntax error exists in the effect file.
  84          * @remarks             The DestroyEffect() method must be used to destroy the Effect instance returned.
  85          * @see DestroyEffect()
  86          */
  87          Effect* CreateEffect(const Tizen::Base::String& filePath);
  88
  89         /**
  90          * Destroys the Effect instance.
  91          *
  92          * @since 2.0
  93          *
  94          * @param [in]          effect                           The Effect instance to destroy
  95          * @see CreateEffect()
  96          */
  97          void DestroyEffect(Effect& effect);
  98
  99 protected:
 100         //
 101         // This method is for internal use only. Using this method can cause behavioral, security-related,
 102         // and consistency-related issues in the application.
 103         //
 104         //
 105         // This method is reserved and may change its name at any time without prior notice.
 106         //
 107         // @since 2.0
 108         //
 109         virtual void EffectManager_Reserved1(void) {}
 110
 111         //
 112         // This method is for internal use only. Using this method can cause behavioral, security-related,
 113         // and consistency-related issues in the application.
 114         //
 115         //
 116         // This method is reserved and may change its name at any time without prior notice.
 117         //
 118         // @since 2.0
 119         //
 120         virtual void EffectManager_Reserved2(void) {}
 121
 122         //
 123         // This method is for internal use only. Using this method can cause behavioral, security-related,
 124         // and consistency-related issues in the application.
 125         //
 126         //
 127         // This method is reserved and may change its name at any time without prior notice.
 128         //
 129         // @since 2.0
 130         //
 131         virtual void EffectManager_Reserved3(void) {}
 132
 133 private:
 134         // This default constructor is intentionally declared as private to implement the Singleton semantic.
 135         EffectManager(void);
 136
 137         // This destructor is intentionally declared as private to implement the Singleton semantic.
 138         virtual ~EffectManager(void);
 139
 140         // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 141         EffectManager(const EffectManager& rhs);
 142
 143         // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 144         EffectManager& operator=(const EffectManager& rhs);
 145
 146 private:
 147         friend class _EffectManagerImpl;
 148         _EffectManagerImpl* __pEffectManagerImpl;
 149 }; //EffectManager
 150
 151 }}} // Tizen::Ui::Effects
 152
 153 #endif // _FUI_EFFECTS_EFFECT_MANAGER_H_
 154