Fix JavaScript docs, where orientation property still called rotation

[platform/core/uifw/dali-toolkit.git] / plugins / dali-script-v8 / docs / content / actor.js

diff --git a/plugins/dali-script-v8/docs/content/actor.js b/plugins/dali-script-v8/docs/content/actor.js
index 4938c01..9b4b4ff 100644 (file)
--- a/plugins/dali-script-v8/docs/content/actor.js
+++ b/plugins/dali-script-v8/docs/content/actor.js
@@ -9,7 +9,6 @@
 
 ```
 var actor = new dali.Actor();
-var imageActor = new dali.ImageActor();
 var textActor = new dali.TextActor("hello world");
 var camera = new dali.CameraActor();
 var layer = new dali.Layer();
@@ -72,13 +71,13 @@ Note that since DALi is a 3D toolkit, this behaviour is the result of a default
 
 The actor provides the following call back events
 
-| Name              | Description                            | Parameters passed to call back |
-|-------------------|----------------------------------------|--------------------------|
-|touched            | touch event                            | (actor, touchEvent )     |
-|hovered            | mouse or pointer hovering over actor   | (actor, hoverEvent)      |
-|mouse-wheel-event  | mouse wheel events                     | (actor, wheelEvent)      |
-|on-stage           | actor has been moved on stage          | (actor)                  |
-|off-stage          | actor has been moved off stage         | (actor)                  |
+| Name            | Description                            | Parameters passed to call back |
+|-----------------|----------------------------------------|--------------------------|
+|touched          | touch event                            | (actor, touchEvent )     |
+|hovered          | mouse or pointer hovering over actor   | (actor, hoverEvent)      |
+|mouseWheelEvent  | mouse wheel events                     | (actor, wheelEvent)      |
+|onStage          | actor has been moved on stage          | (actor)                  |
+|offStage         | actor has been moved off stage         | (actor)                  |
 
 
 #### Touch event
@@ -119,13 +118,13 @@ function OnPressed( actor, touchEvent )
   
   var anim = new dali.Animation( 4 );
   var rotation = new dali.Rotation( 90, 0, 0 ); // pitch, yaw, roll
-  anim.animateBy( actor, "rotation", rotation );
+  anim.animateBy( actor, "orientation", rotation );
   anim.play();
   return true;
 }
   
 // connect to touch events
-myActor.connect( "touched", onPressed );
+myActor.on( "touched", onPressed );
 
 ```
 
@@ -144,7 +143,7 @@ hoverEvent = {
 }
 ```
       // connect to touch events
-      myActor.connect( "hovered", onHover);
+      myActor.on( "hovered", onHover);
 
 #### Mouse wheel event
 
@@ -162,7 +161,7 @@ mouseWheelEvent = {
 }
   
 // connect to touch events
-myActor.connect( "mouse-wheel-event", onMouseWheel );
+myActor.on( "mouseWheelEvent", onMouseWheel );
 ```
 #### Key events
 
@@ -196,8 +195,8 @@ See
  worldPositionX         |FLOAT       | ✘     | ✘
  worldPositionY         |FLOAT       | ✘     | ✘
  worldPositionZ         |FLOAT       | ✘     | ✘
- rotation               |ROTATION    | ✔     | ✔
- worldRotation          |ROTATION    | ✘     | ✘
+ orientation            |ROTATION    | ✔     | ✔
+ worldOrientation       |ROTATION    | ✘     | ✘
  scale                  |VECTOR3     | ✔     | ✔
  scaleX                 |FLOAT       | ✔     | ✔
  scaleY                 |FLOAT       | ✔     | ✔
@@ -214,7 +213,7 @@ See
  name                   |STRING      | ✔     | ✘
  sensitive              |BOOLEAN     | ✔     | ✘
  leaveRequired          |BOOLEAN     | ✔     | ✘
- inheritRotation        |BOOLEAN     | ✔     | ✘
+ inheritOrientation     |BOOLEAN     | ✔     | ✘
  inheritScale           |BOOLEAN     | ✔     | ✘
  colorMode              |NUMBER      | ✔     | ✘
  positionInheritance    |NUMBER      | ✔     | ✘
@@ -226,6 +225,7 @@ See
 
 
  * @class Actor
+ * @extends Handle
  */
 
 
@@ -381,19 +381,19 @@ WORLD_POSITION_Z
 
 
 /**
- * Actors rotation
- * @property rotation
+ * Actors orientation
+ * @property orientation
  * @type dali Rotation object
  */
-ROTATION
+ORIENTATION
 
 
 /**
- * Actors world-rotation
- * @property worldRotation
+ * Actors world-orientation
+ * @property worldOrientation
  * @type dali Rotation object ( read only)
  */
-WORLD_ROTATION
+WORLD_ORIENTATION
 
 /**
  * Actors scale
@@ -521,10 +521,10 @@ LEAVE_REQUIRED
 /**
  * Set whether a child actor inherits it's parent's orientation.
  * @type Boolean
- * @property inheritRotation
+ * @property inheritOrientation
  * @default true
  */
-INHERIT_ROTATION,
+INHERIT_ORIENTATION,
 
 
 /**
@@ -543,7 +543,7 @@ INHERIT_SCALE,
  * By default a renderable actor will be drawn as a 3D object. It will be depth-tested against
  * other objects in the world i.e. it may be obscured if other objects are in front.
  *
- * If OVERLAY is used, the actor and its children will be drawn as a 2D overlay.
+ * If OVERLAY_2D is used, the actor and its children will be drawn as a 2D overlay.
  * Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer.
  * For overlay actors, the drawing order is determined by the hierachy (depth-first search order),
  * and depth-testing will not be used.
@@ -554,9 +554,9 @@ INHERIT_SCALE,
  *
  * @example
  *
- *      var actor.drawMode = dali.DRAW_MODE_NORMAL;  // binary 00. The default draw-mode
- *      var actor.drawMode = dali.DRAW_MODE_OVERLAY; // binary 01. Draw the actor and its children as an overlay
- *      var actor.drawMode = dali.DRAW_MODE_STENCIL ;// binary 11. Draw the actor and its children into the stencil buffer
+ *      var actor.drawMode = dali.DRAW_MODE_NORMAL;     // binary 00. The default draw-mode
+ *      var actor.drawMode = dali.DRAW_MODE_OVERLAY_2D; // binary 01. Draw the actor and its children as an overlay
+ *      var actor.drawMode = dali.DRAW_MODE_STENCIL ;   // binary 11. Draw the actor and its children into the stencil buffer
  *
  *
  * @type Number