dali/internal/event/object/custom-object-internal.h

   1 #ifndef __DALI_INTERNAL_CUSTOM_OBJECT_H__
   2 #define __DALI_INTERNAL_CUSTOM_OBJECT_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/internal/event/common/proxy-object.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Internal
  28 {
  29
  30 namespace SceneGraph
  31 {
  32 class PropertyOwner;
  33 }
  34
  35 class CustomObject : public ProxyObject
  36 {
  37 public:
  38
  39   /**
  40    * Create a new custom object.
  41    * @return A pointer to the newly allocated object.
  42    */
  43   static CustomObject* New();
  44
  45   /**
  46    * @copydoc Dali::Internal::ProxyObject::GetSceneObject()
  47    */
  48   virtual const SceneGraph::PropertyOwner* GetSceneObject() const;
  49
  50   /**
  51    * @copydoc Dali::Internal::ProxyObject::GetSceneObjectAnimatableProperty()
  52    */
  53   virtual const SceneGraph::PropertyBase* GetSceneObjectAnimatableProperty( Property::Index index ) const;
  54
  55   /**
  56    * @copydoc Dali::Internal::ProxyObject::GetSceneObjectInputProperty()
  57    */
  58   virtual const PropertyInputImpl* GetSceneObjectInputProperty( Property::Index index ) const;
  59
  60   /**
  61    * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyCount()
  62    */
  63   virtual unsigned int GetDefaultPropertyCount() const;
  64
  65   /**
  66    * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyIndices()
  67    */
  68   virtual void GetDefaultPropertyIndices( Property::IndexContainer& indices ) const;
  69
  70   /**
  71    * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyName()
  72    */
  73   virtual const char* GetDefaultPropertyName(Property::Index index) const;
  74
  75   /**
  76    * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyIndex()
  77    */
  78   virtual Property::Index GetDefaultPropertyIndex(const std::string& name) const;
  79
  80   /**
  81    * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyWritable()
  82    */
  83   virtual bool IsDefaultPropertyWritable(Property::Index index) const;
  84
  85   /**
  86    * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyAnimatable()
  87    */
  88   virtual bool IsDefaultPropertyAnimatable(Property::Index index) const;
  89
  90   /**
  91    * @copydoc Dali::Internal::ProxyObject::IsDefaultPropertyAConstraintInput()
  92    */
  93   virtual bool IsDefaultPropertyAConstraintInput( Property::Index index ) const;
  94
  95   /**
  96    * @copydoc Dali::Internal::ProxyObject::GetDefaultPropertyType()
  97    */
  98   virtual Property::Type GetDefaultPropertyType(Property::Index index) const;
  99
 100   /**
 101    * @copydoc Dali::Internal::ProxyObject::SetDefaultProperty()
 102    */
 103   virtual void SetDefaultProperty(Property::Index index, const Property::Value& propertyValue);
 104
 105   /**
 106    * @copydoc Dali::Internal::ProxyObject::GetDefaultProperty()
 107    */
 108   virtual Property::Value GetDefaultProperty( Property::Index index ) const;
 109
 110   /**
 111    * @copydoc Dali::Internal::ProxyObject::InstallSceneObjectProperty()
 112    */
 113   virtual void InstallSceneObjectProperty( SceneGraph::PropertyBase& newProperty, const std::string& name, unsigned int index );
 114
 115 protected:
 116
 117   /**
 118    * A reference counted object may only be deleted by calling Unreference()
 119    */
 120   virtual ~CustomObject();
 121
 122   /**
 123    * Private constructor; see also CustomObject::New()
 124    */
 125   CustomObject();
 126
 127   // Undefined
 128   CustomObject(const CustomObject&);
 129
 130   // Undefined
 131   CustomObject& operator=(const CustomObject& rhs);
 132
 133 protected:
 134
 135   SceneGraph::PropertyOwner* mUpdateObject;
 136 };
 137
 138 } // namespace Internal
 139
 140 } // namespace Dali
 141
 142 #endif // __DALI_INTERNAL_CUSTOM_OBJECT_H__