From: Andrew Poor Date: Thu, 22 Sep 2016 14:00:09 +0000 (+0100) Subject: Documentation cleanup. X-Git-Tag: dali_1.2.8~5^2 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=fa4b303a4a03e2be990839bb43c8955dc4df3a47 Documentation cleanup. Change-Id: Ie4fab2a634ccd47f655a99680a97aa057bcf6578 --- diff --git a/docs/content/programming-guide/constraints.h b/docs/content/programming-guide/constraints.h index 7780cc2..6c4f194 100644 --- a/docs/content/programming-guide/constraints.h +++ b/docs/content/programming-guide/constraints.h @@ -202,7 +202,7 @@ struct MyFunctor else { // Otherwise it will blend between fully opaque and transparent - current.a = ( 100.0f - mDistance ) / 100.0f; + current.a = ( mDistance - distance ) / mDistance; } } diff --git a/docs/content/programming-guide/dali-application.h b/docs/content/programming-guide/dali-application.h index 3ca80c2..acd37f8 100644 --- a/docs/content/programming-guide/dali-application.h +++ b/docs/content/programming-guide/dali-application.h @@ -39,8 +39,8 @@ void CreateProgram(Application& app) int main (int argc, char **argv) { - Dali::Application app = Application::New(argc, argv); - app.SignalInit().Connect(&CreateProgram); + Dali::Application app = Application::New(&argc, &argv); + app.InitSignal().Connect(&CreateProgram); app.MainLoop(); } @endcode @@ -60,7 +60,7 @@ bool Tick() // Elsewhere Dali::Timer timer = Dali::Timer::New(2000); // 2 second timeout -timer.SignalTick().Connect(&Tick); +timer.TickSignal().Connect(&Tick); ... @endcode diff --git a/docs/content/programming-guide/properties.h b/docs/content/programming-guide/properties.h index 40ce183..aafaf25 100644 --- a/docs/content/programming-guide/properties.h +++ b/docs/content/programming-guide/properties.h @@ -189,10 +189,10 @@ shows the index range of the different properties in place. |:----------------------|:--------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------:| | Default | Properties defined within DALi Core, e.g. Dali::Actor, Dali::ShaderEffect default properties etc. | \link Dali::DEFAULT_OBJECT_PROPERTY_START_INDEX DEFAULT_OBJECT_PROPERTY_START_INDEX\endlink | \link Dali::DEFAULT_PROPERTY_MAX_COUNT DEFAULT_PROPERTY_MAX_COUNT\endlink (9999999) | | Registered | Properties registered using Dali::PropertyRegistration | \link Dali::PROPERTY_REGISTRATION_START_INDEX PROPERTY_REGISTRATION_START_INDEX\endlink (10000000) | \link Dali::PROPERTY_REGISTRATION_MAX_INDEX PROPERTY_REGISTRATION_MAX_INDEX\endlink (19999999) | -| Registered Animatable | Animatable properties registered using Dali::AnimatablePropertyRegistration | \link Dali::ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX\endlink (20000000) | \link Dali::ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX\endlink (29999999) | -| Registered Child | Child properties (which parent supports in its children) registered using Dali::ChildPropertyRegistration | \link Dali::ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX\endlink (20000000) | \link Dali::CHILD_PROPERTY_REGISTRATION_MAX_INDEX CHILD_PROPERTY_REGISTRATION_MAX_INDEX\endlink (49999999) | | Control | Property range reserved by Dali::Toolkit::Control | \link Dali::Toolkit::Control::CONTROL_PROPERTY_START_INDEX CONTROL_PROPERTY_START_INDEX\endlink (10000000) | \link Dali::Toolkit::Control::CONTROL_PROPERTY_END_INDEX CONTROL_PROPERTY_END_INDEX\endlink (10001000) | | Derived Control | Property range for control deriving directly from Dali::Toolkit::Control | 10001001 | \link Dali::PROPERTY_REGISTRATION_MAX_INDEX PROPERTY_REGISTRATION_MAX_INDEX\endlink (19999999) | +| Registered Animatable | Animatable properties registered using Dali::AnimatablePropertyRegistration | \link Dali::ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX\endlink (20000000) | \link Dali::ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX\endlink (29999999) | +| Registered Child | Child properties (which parent supports in its children) registered using Dali::ChildPropertyRegistration | \link Dali::CHILD_PROPERTY_REGISTRATION_START_INDEX CHILD_PROPERTY_REGISTRATION_START_INDEX\endlink (45000000) | \link Dali::CHILD_PROPERTY_REGISTRATION_MAX_INDEX CHILD_PROPERTY_REGISTRATION_MAX_INDEX\endlink (49999999) | | Custom | Custom properties added to instance using Dali::Handle::RegisterProperty | \link Dali::PROPERTY_CUSTOM_START_INDEX PROPERTY_CUSTOM_START_INDEX\endlink (50000000) | Onwards... |
@@ -214,8 +214,6 @@ Property lookup via index should always be used unless the indicies cannot be kn @clip{"properties.cpp", // C++ EXAMPLE, // C++ EXAMPLE END} -Once run, a grid of buttons will appear. When a button is pressed, the unique number stored in the property (in this case the index) is displayed at the bottom of the screen. -
@section property-use-example-js Property use in JavaScript diff --git a/docs/content/shared-javascript-and-cpp-documentation/animation.md b/docs/content/shared-javascript-and-cpp-documentation/animation.md index 0e927a6..f979870 100644 --- a/docs/content/shared-javascript-and-cpp-documentation/animation.md +++ b/docs/content/shared-javascript-and-cpp-documentation/animation.md @@ -75,7 +75,7 @@ void ExampleCallback( Animation& source ) std::cout << "Animation has finished" << std::endl; } ... -animation.FinishedSignal().Connect( ExampleCallback ); +animation.FinishedSignal().Connect( &ExampleCallback ); ~~~ ### Alpha Functions diff --git a/docs/content/shared-javascript-and-cpp-documentation/fundamentals.md b/docs/content/shared-javascript-and-cpp-documentation/fundamentals.md index cce3bd4..d341445 100644 --- a/docs/content/shared-javascript-and-cpp-documentation/fundamentals.md +++ b/docs/content/shared-javascript-and-cpp-documentation/fundamentals.md @@ -38,6 +38,7 @@ downwards**. This is intended to be convenient when laying-out 2D views. ## Positioning Actors {#positioning-actors} An actor inherits its parent's position. The relative position between the actor & parent is determined by 3 properties: + 1) ParentOrigin. This Vector3 property defines a point within the parent actor's area. ![ ](../assets/img/parent-origin.png) @@ -57,9 +58,9 @@ The default is "center", which can be visualized in 2D as (0.5, 0.5), but is act ![ ](../assets/img/actor-position.png) ![ ](actor-position.png) -Therefore by default, an actors position is the distance between its center and the top-left corner of its parent. +The default is (X = 0, Y = 0), so an actor placed directly without modifying the parent origin, anchor point or position would appear centred around the top left corner of its parent. -An actor added directly to the stage with position (X = stageWidth*0.5, Y = stageHeight*0.5), would appear in the center of the screen. Likewise an actor with position (X = actorWidth*0.5, Y = actorWidth*0.5), would appear at the top-left of the screen. +An actor added directly to the stage with position (X = stageWidth*0.5, Y = stageHeight*0.5), would appear in the center of the screen. Likewise an actor with position (X = actorWidth*0.5, Y = actorWidth*0.5), would appear at the top-left of the screen. However, basic positioning like that is normally done via changing the parent origin and/or anchor point instead - use ParentOrigin::CENTER and AnchorPoint::CENTER to place the actor in the center of the screen, and ParentOrigin::TOP_LEFT and AnchorPoint::TOP_LEFT to place it inside the screen on the top left. Note that since DALi is a 3D toolkit, this behaviour is the result of a default perspective camera setup.