plugins/dali-script-v8/src/actors/actor-wrapper.h

   1 #ifndef __DALI_V8PLUGIN_ACTOR_WRAPPER_H__
   2 #define __DALI_V8PLUGIN_ACTOR_WRAPPER_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // EXTERNAL INCLUDES
  22 #include <v8.h>
  23 #include <dali/public-api/actors/actor.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <object/handle-wrapper.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace V8Plugin
  32 {
  33
  34
  35 /**
  36  * Wraps a Dali Actor.
  37  */
  38 class ActorWrapper : public HandleWrapper
  39 {
  40
  41 public:
  42
  43   /**
  44    * Actor type used an index.
  45    * These enums are used to index the ActorApiLookup table in actor-wrapper.cpp.
  46    * Any changes made must be reflected in the ActorApiLookup otherwise it may segfault when creating an actor
  47    */
  48   enum ActorType
  49   {
  50     UNKNOWN_ACTOR = -1,
  51     ACTOR        = 0,
  52     IMAGE_ACTOR  = 1,
  53     LAYER_ACTOR  = 2,
  54     CAMERA_ACTOR = 3
  55   };
  56
  57   /**
  58    * Constructor
  59    * @param actor DALi actor
  60    * @param gc garbage collection interface
  61    */
  62   ActorWrapper( Actor actor,
  63                 GarbageCollectorInterface& gc );
  64
  65   /**
  66    * destructor
  67    */
  68   virtual ~ActorWrapper()
  69   {
  70   }
  71
  72   /**
  73    * @brief Creates a new Actor wrapped inside a Javascript Object.
  74    * @note: the actor type ie 'ImageActor' is expected to be the name of the callee function.
  75    * @param[in] args v8 function call arguments interpreted
  76    */
  77   static void NewActor( const v8::FunctionCallbackInfo< v8::Value >& args);
  78
  79   /**
  80    * @brief Creates a new Control wrapped inside a Javascript Object.
  81    * @note: the control type is passed as a parameter e.g. 'TextField'
  82    * @param[in] args v8 function call arguments interpreted
  83    */
  84   static void NewControl( const v8::FunctionCallbackInfo< v8::Value >& args);
  85
  86   /**
  87    * @brief Wraps an actor of a given type
  88    */
  89   static v8::Handle<v8::Object> WrapActor(v8::Isolate* isolate, Dali::Actor actor,ActorType actorType);
  90
  91   /**
  92    * @brief Wraps an actor, the type is looked up from the actor
  93    */
  94   static v8::Handle<v8::Object> WrapActor(v8::Isolate* isolate, Dali::Actor actor );
  95
  96   // The Actor ObjectTemplates.
  97   static v8::Persistent<v8::ObjectTemplate> mActorTemplate;
  98   static v8::Persistent<v8::ObjectTemplate> mImageActorTemplate;
  99   static v8::Persistent<v8::ObjectTemplate> mCameraActorTemplate;
 100   static v8::Persistent<v8::ObjectTemplate> mLayerActorTemplate;
 101
 102   /**
 103    * @return the wrapped actor
 104    */
 105   Actor GetActor();
 106
 107   /**
 108    * @return they actor type
 109    */
 110   static ActorWrapper::ActorType GetActorType( const std::string& name );
 111
 112 private:
 113
 114   /**
 115    * Helper to make the actor template
 116    *
 117    */
 118   static v8::Handle<v8::ObjectTemplate> MakeDaliActorTemplate( v8::Isolate* isolate, ActorType actorType );
 119
 120   /**
 121    * Helper, get an actor template given an actor type
 122    */
 123   static v8::Local<v8::ObjectTemplate> GetActorTemplate( v8::Isolate* isolate, ActorType type );
 124
 125   Actor mActor;
 126
 127 };
 128
 129 } // namespace V8Plugin
 130
 131 } // namespace Dali
 132
 133 #endif // header