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 7bd5b20..9b4b4ff 100644 (file)
--- a/plugins/dali-script-v8/docs/content/actor.js
+++ b/plugins/dali-script-v8/docs/content/actor.js
@@ -9,14 +9,12 @@
 
 ```
 var actor = new dali.Actor();
-var imageActor = new dali.ImageActor();
 var textActor = new dali.TextActor("hello world");
-var meshActor = new dali.MeshActor();
 var camera = new dali.CameraActor();
 var layer = new dali.Layer();
 ```
 
-### Hello world example </h3>
+### Hello world example
 ```
 var myActor = new dali.TextActor("hello-world");
 
@@ -40,7 +38,8 @@ An actor inherits its parent's position.  The relative position between the acto
 
 1) ParentOrigin.  This Vector3 property defines a point within the parent actor's area.
 
-<img src="../assets/img/shared/parent-origin.png">
+![ ](../assets/img/parent-origin.png)
+
 
 The default is "top-left", which can be visualized in 2D as (0, 0), but is actually Vector3(0, 0, 0.5) in the 3D DALi world.  The actor's position is relative to this point.
 ```
@@ -50,7 +49,7 @@ myActor.parentOrigin = [0.5, 0.5, 0.5];
 
 2) AnchorPoint.  This Vector3 property defines a point within the child actor's area.
 
-<img src="../assets/img/shared/anchor-point.png">
+![ ](../assets/img/anchor-point.png)
 
 The default is "center", which can be visualized in 2D as (0.5, 0.5), but is actually Vector3(0.5, 0.5, 0.5) in the 3D DALi world.  The actor's position is also relative to this point.
 ```
@@ -60,7 +59,7 @@ myActor.anchorPoint = [0.5, 0.5, 0.5];
 
 3) Position.  This is the position vector between the parent-origin and anchor-point.
 
-<img src="../assets/img/shared/actor-position.png">
+![ ](../assets/img/actor-position.png)
 
 Therefore by default, an actors position is the distance between its center and the top-left corner of its parent.
 
@@ -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
 
@@ -226,6 +225,7 @@ See
 
 
  * @class Actor
+ * @extends Handle
  */
 
 
@@ -383,7 +383,7 @@ WORLD_POSITION_Z
 /**
  * Actors orientation
  * @property orientation
- * @type dali orientation object
+ * @type dali Rotation object
  */
 ORIENTATION
 
@@ -391,7 +391,7 @@ ORIENTATION
 /**
  * Actors world-orientation
  * @property worldOrientation
- * @type dali Orientation object ( read only)
+ * @type dali Rotation object ( read only)
  */
 WORLD_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