X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fbuilder%2Fbuilder.h;h=f3975f6623e033e37bec87346866456e957fb08a;hp=703d54e07c06a1edbffee11d87c96dad1e53e24b;hb=acbe10c62c46a30c58e08d8971a736f04e68dbf8;hpb=820c66e71516e7a25600b8b5de2e84b5d44d8ff3 diff --git a/dali-toolkit/devel-api/builder/builder.h b/dali-toolkit/devel-api/builder/builder.h old mode 100644 new mode 100755 index 703d54e..f3975f6 --- a/dali-toolkit/devel-api/builder/builder.h +++ b/dali-toolkit/devel-api/builder/builder.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_UIBUILDER_H__ -#define __DALI_TOOLKIT_UIBUILDER_H__ +#ifndef DALI_TOOLKIT_UIBUILDER_H +#define DALI_TOOLKIT_UIBUILDER_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -24,7 +24,9 @@ #include #include #include -#include + +// INTERNAL INCLUDES +#include namespace Dali { @@ -47,17 +49,17 @@ class Builder; * { * "templates": // are named instantiable actor trees * { - * "default-text": + * "defaultText": * { * "type":"TextActor", * "font":"", - * "parent-origin":[0.5,0.5,0], + * "parentOrigin":[0.5,0.5,0], * "scale": [50,50,1] * } * }, * "styles": // are named property sets applied to actor trees * { - * "my-style": + * "myStyle": * { * "size": [10,10,1] // root properties applied to a given root actor * "actors": // properties applied to actors found by name from root @@ -76,7 +78,7 @@ class Builder; * "stage": * [ * { - * "type":"default-text", + * "type":"defaultText", * "text":"Hello World", * "position":[0,0,0] * }, @@ -99,12 +101,12 @@ class Builder; * * - Create an actor tree from the "templates" section * @code - * TextActor actor = TextActor::DownCast( builder.Create( "default-text" ) ); + * TextActor actor = TextActor::DownCast( builder.Create( "defaultText" ) ); * @endcode * * - Style an actor tree from the "styles" section * @code - * builder.ApplyStyle( "my-style", actor ); + * builder.ApplyStyle( "myStyle", actor ); * @endcode * * - Create an actor tree from json @@ -119,7 +121,7 @@ class Builder; * */ -class DALI_IMPORT_API Builder : public BaseHandle +class DALI_TOOLKIT_API Builder : public BaseHandle { public: /** @@ -188,6 +190,14 @@ class DALI_IMPORT_API Builder : public BaseHandle void AddConstant( const std::string& key, const Property::Value& value ); /** + * @brief Gets all currently defined configurations. + * + * @pre The Builder has been initialized. + * @return A reference to the currently defined configurations. + */ + const Property::Map& GetConfigurations() const; + + /** * @brief Gets all currently defined constants. * * e.g. @@ -253,7 +263,7 @@ class DALI_IMPORT_API Builder : public BaseHandle * * The animation is applied to a specific actor. * e.g. - * Actor myInstance = builder.Create( "template-actor-tree" ) + * Actor myInstance = builder.Create( "templateActorTree" ) * Animation a = builder.CreateAnimation( "wobble", myInstance ); * * @pre The Builder has been initialized. @@ -272,7 +282,7 @@ class DALI_IMPORT_API Builder : public BaseHandle * e.g. * Property::Map map; * map["ACTOR"] = actor.GetName(); // replaces '{ACTOR} in the template - * Actor myInstance = builder.Create( "template-actor-tree" ) + * Actor myInstance = builder.Create( "templateActorTree" ) * Animation a = builder.CreateAnimation( "wobble", myInstance); * * @pre The Builder has been initialized. @@ -290,7 +300,7 @@ class DALI_IMPORT_API Builder : public BaseHandle * @brief Creates an object (e.g. an actor) from the set of known style templates * * e.g. - * mActor.Add( Actor::DownCast(builder.Create( "default-text")) ); + * mActor.Add( Actor::DownCast(builder.Create( "defaultText")) ); * * @pre The Builder has been initialized. * @pre Preconditions have been met for creating dali objects ie Images, Actors etc @@ -307,7 +317,7 @@ class DALI_IMPORT_API Builder : public BaseHandle * e.g. * Property::Map map; * map["IMAGE_DIR"] = "/usr/share/images"; // replaces '{IMAGE_DIR} in the template - * mActor.Add( Actor::DownCast(builder.Create( "default-image", map) ) ); + * mActor.Add( Actor::DownCast(builder.Create( "defaultImage", map) ) ); * * @pre The Builder has been initialized. * @pre Preconditions have been met for creating dali objects ie Images, Actors etc @@ -384,15 +394,6 @@ class DALI_IMPORT_API Builder : public BaseHandle void CreateRenderTask( const std::string &name ); /** - * Get or create ShaderEffect from the ShaderEffect instance library. - * An empty handle is returned otherwise. - * @pre The Builder has been initialized. - * @param name The name of a ShaderEffect in the loaded representation - * @return A handle to a ShaderEffect if found, otherwise empty - */ - ShaderEffect GetShaderEffect( const std::string &name ); - - /** * Get or create FrameBufferImage from the FrameBufferImage instance library. * An empty handle is returned otherwise. * @pre The Builder has been initialized. @@ -413,7 +414,7 @@ class DALI_IMPORT_API Builder : public BaseHandle /** * Get or create a PathConstrainer from the set of known PathConstrainers * e.g. - * PathConstrainer a = builder.GetPathConstrainer( "my-path-constrainer"); + * PathConstrainer a = builder.GetPathConstrainer( "myPathConstrainer"); * * @pre The Builder has been initialized. * @pre The pathConstrainerName exists in the Constrainers section of the data representation @@ -425,7 +426,7 @@ class DALI_IMPORT_API Builder : public BaseHandle /** * Get or create a LinearConstrainer from the set of known LinearConstrainers * e.g. - * LinearConstrainer a = builder.GetLinearConstrainer( "my-linear-constrainer"); + * LinearConstrainer a = builder.GetLinearConstrainer( "myLinearConstrainer"); * * @pre The Builder has been initialized. * @pre The linearConstrainerName exists in the Constrainers section of the data representation @@ -455,4 +456,4 @@ private: } // namespace Dali -#endif // __DALI_TOOLKIT_UIBUILDER_H__ +#endif // DALI_TOOLKIT_UIBUILDER_H