From a7257c65b5ea875bf27ce7b7f1387559aa359c20 Mon Sep 17 00:00:00 2001 From: "dongsug.song" Date: Tue, 15 Nov 2016 11:45:05 +0900 Subject: [PATCH] Revert "[3.0] Rename DebugVisual to WireframeVisual" This reverts commit b354da3127a34527e3b78eb46ed0d8f6baf33012. Change-Id: I17c0ebf21ef31418f90b541d8cf8160bf636e48e --- automated-tests/src/dali-toolkit/CMakeLists.txt | 2 +- ...DebugRendering.cpp => utc-Dali-DebugVisual.cpp} | 14 +- .../src/dali-toolkit/utc-Dali-Visual.cpp | 208 --------------------- dali-toolkit/internal/file.list | 10 +- .../debug-visual.cpp} | 20 +- .../wireframe-visual.h => debug/debug-visual.h} | 20 +- .../internal/visuals/visual-factory-cache.cpp | 10 +- .../internal/visuals/visual-factory-cache.h | 10 +- .../internal/visuals/visual-factory-impl.cpp | 23 +-- .../public-api/visuals/visual-properties.h | 2 +- .../debug-blocks.png | Bin docs/content/images/visuals/wireframe-visual.png | Bin 483 -> 0 bytes docs/content/main.md | 2 +- .../debug-rendering.md | 19 -- .../debug-visual.md | 21 +++ .../visuals.md | 37 ---- 16 files changed, 78 insertions(+), 320 deletions(-) rename automated-tests/src/dali-toolkit/{utc-Dali-DebugRendering.cpp => utc-Dali-DebugVisual.cpp} (92%) rename dali-toolkit/internal/visuals/{wireframe/wireframe-visual.cpp => debug/debug-visual.cpp} (85%) rename dali-toolkit/internal/visuals/{wireframe/wireframe-visual.h => debug/debug-visual.h} (78%) rename docs/content/images/{debug-rendering => debug-visual}/debug-blocks.png (100%) delete mode 100644 docs/content/images/visuals/wireframe-visual.png delete mode 100644 docs/content/shared-javascript-and-cpp-documentation/debug-rendering.md create mode 100644 docs/content/shared-javascript-and-cpp-documentation/debug-visual.md diff --git a/automated-tests/src/dali-toolkit/CMakeLists.txt b/automated-tests/src/dali-toolkit/CMakeLists.txt index 42bf106..0db0538 100644 --- a/automated-tests/src/dali-toolkit/CMakeLists.txt +++ b/automated-tests/src/dali-toolkit/CMakeLists.txt @@ -50,7 +50,7 @@ SET(TC_SOURCES utc-Dali-Model3dView.cpp utc-Dali-Visual.cpp utc-Dali-VisualFactory.cpp - utc-Dali-DebugRendering.cpp + utc-Dali-DebugVisual.cpp utc-Dali-ImageAtlas.cpp utc-Dali-VideoView.cpp ) diff --git a/automated-tests/src/dali-toolkit/utc-Dali-DebugRendering.cpp b/automated-tests/src/dali-toolkit/utc-Dali-DebugVisual.cpp similarity index 92% rename from automated-tests/src/dali-toolkit/utc-Dali-DebugRendering.cpp rename to automated-tests/src/dali-toolkit/utc-Dali-DebugVisual.cpp index b2cb02c..f93f2e2 100644 --- a/automated-tests/src/dali-toolkit/utc-Dali-DebugRendering.cpp +++ b/automated-tests/src/dali-toolkit/utc-Dali-DebugVisual.cpp @@ -42,7 +42,7 @@ bool IsDebugVisual( Visual::Base& visual ) Property::Value* typeValue = propertyMap.Find( Visual::Property::TYPE, Property::INTEGER ); if ( typeValue ) { - isDebugVisualType = ( typeValue->Get() == Visual::WIREFRAME ); // Debug Rendering uses the WireframeVisual + isDebugVisualType = ( typeValue->Get() == Visual::DEBUG ); } Actor actor = Actor::New(); @@ -54,21 +54,21 @@ bool IsDebugVisual( Visual::Base& visual ) } } -void dali_debug_rendering_startup(void) +void dali_debug_renderer_startup(void) { test_return_value = TET_UNDEF; } -void dali_debug_rendering_cleanup(void) +void dali_debug_renderer_cleanup(void) { test_return_value = TET_PASS; } -int UtcDaliDebugRenderingGetVisual1(void) +int UtcDaliDebugVisualGetVisual1(void) { EnvironmentVariable::SetTestingEnvironmentVariable(true); ToolkitTestApplication application; - tet_infoline( "UtcDaliDebugRenderingGetVisual1: Request visual with a Property::Map" ); + tet_infoline( "UtcDaliDebugVisualGetVisual1: Request visual with a Property::Map" ); VisualFactory factory = VisualFactory::Get(); DALI_TEST_CHECK( factory ); @@ -130,11 +130,11 @@ int UtcDaliDebugRenderingGetVisual1(void) END_TEST; } -int UtcDaliDebugRenderingGetVisual2(void) +int UtcDaliDebugVisualGetVisual2(void) { EnvironmentVariable::SetTestingEnvironmentVariable(true); ToolkitTestApplication application; - tet_infoline( "UtcDaliDebugRenderingGetVisual2: Request visual with various parameters" ); + tet_infoline( "UtcDaliDebugVisualGetVisual2: Request visual with various parameters" ); VisualFactory factory = VisualFactory::Get(); DALI_TEST_CHECK( factory ); diff --git a/automated-tests/src/dali-toolkit/utc-Dali-Visual.cpp b/automated-tests/src/dali-toolkit/utc-Dali-Visual.cpp index f603472..b6080c3 100644 --- a/automated-tests/src/dali-toolkit/utc-Dali-Visual.cpp +++ b/automated-tests/src/dali-toolkit/utc-Dali-Visual.cpp @@ -777,211 +777,3 @@ int UtcDaliVisualGetPropertyMap9(void) END_TEST; } - -int UtcDaliVisualAnimateBorderVisual01(void) -{ - ToolkitTestApplication application; - tet_infoline( "UtcDaliAnimateBorderVisual Color" ); - - VisualFactory factory = VisualFactory::Get(); - Property::Map propertyMap; - propertyMap.Insert(Visual::Property::TYPE, Visual::BORDER); - propertyMap.Insert(BorderVisual::Property::COLOR, Color::BLUE); - propertyMap.Insert(BorderVisual::Property::SIZE, 5.f); - Visual::Base borderVisual = factory.CreateVisual( propertyMap ); - - Actor actor = Actor::New(); - actor.SetSize(2000, 2000); - actor.SetParentOrigin(ParentOrigin::CENTER); - Stage::GetCurrent().Add(actor); - borderVisual.SetOnStage( actor ); - - DALI_TEST_EQUALS( actor.GetRendererCount(), 1u, TEST_LOCATION); - - Renderer renderer = actor.GetRendererAt(0); - Property::Index index = renderer.GetPropertyIndex( BorderVisual::Property::COLOR ); - - Animation animation = Animation::New(4.0f); - animation.AnimateTo( Property(renderer, index), Color::WHITE ); - animation.Play(); - - application.SendNotification(); - application.Render(0); - application.Render(2000u); // halfway point between blue and white - - Vector4 color = renderer.GetProperty( index ); - Vector4 testColor = (Color::BLUE + Color::WHITE)*0.5f; - DALI_TEST_EQUALS( color, testColor, TEST_LOCATION ); - DALI_TEST_EQUALS( application.GetGlAbstraction().CheckUniformValue("borderColor", testColor ), true, TEST_LOCATION ); - - application.Render(2000u); // halfway point between blue and white - - color = renderer.GetProperty( index ); - DALI_TEST_EQUALS( color, Color::WHITE, TEST_LOCATION ); - DALI_TEST_EQUALS( application.GetGlAbstraction().CheckUniformValue("borderColor", Color::WHITE ), true, TEST_LOCATION ); - - END_TEST; -} - - -int UtcDaliVisualAnimateBorderVisual02(void) -{ - ToolkitTestApplication application; - tet_infoline( "UtcDaliAnimateBorderVisual Size" ); - - VisualFactory factory = VisualFactory::Get(); - Property::Map propertyMap; - propertyMap.Insert(Visual::Property::TYPE, Visual::BORDER); - propertyMap.Insert(BorderVisual::Property::COLOR, Color::BLUE); - propertyMap.Insert(BorderVisual::Property::SIZE, 5.f); - Visual::Base borderVisual = factory.CreateVisual( propertyMap ); - - Actor actor = Actor::New(); - actor.SetSize(2000, 2000); - actor.SetParentOrigin(ParentOrigin::CENTER); - Stage::GetCurrent().Add(actor); - borderVisual.SetOnStage( actor ); - - DALI_TEST_EQUALS( actor.GetRendererCount(), 1u, TEST_LOCATION); - - Renderer renderer = actor.GetRendererAt(0); - Property::Index index = renderer.GetPropertyIndex( BorderVisual::Property::SIZE ); - - Animation animation = Animation::New(4.0f); - animation.AnimateTo( Property(renderer, index), 9.0f ); - animation.Play(); - - application.SendNotification(); - application.Render(0); - application.Render(2000u); // halfway point - - float size = renderer.GetProperty( index ); - DALI_TEST_EQUALS( size, 7.0f, 0.0001f, TEST_LOCATION ); - DALI_TEST_EQUALS( application.GetGlAbstraction().CheckUniformValue("borderSize", 7.0f ), true, TEST_LOCATION ); - - application.Render(2000u); // halfway point between blue and white - - size = renderer.GetProperty( index ); - DALI_TEST_EQUALS( size, 9.0f, 0.0001f, TEST_LOCATION ); - DALI_TEST_EQUALS( application.GetGlAbstraction().CheckUniformValue("borderSize", 9.0f ), true, TEST_LOCATION ); - - END_TEST; -} - -int UtcDaliVisualAnimateColorVisual(void) -{ - ToolkitTestApplication application; - tet_infoline( "UtcDaliAnimateColorVisual mixColor" ); - - VisualFactory factory = VisualFactory::Get(); - Property::Map propertyMap; - propertyMap.Insert(Visual::Property::TYPE, Visual::COLOR); - propertyMap.Insert(ColorVisual::Property::MIX_COLOR, Color::BLUE); - Visual::Base borderVisual = factory.CreateVisual( propertyMap ); - - Actor actor = Actor::New(); - actor.SetSize(2000, 2000); - actor.SetParentOrigin(ParentOrigin::CENTER); - Stage::GetCurrent().Add(actor); - borderVisual.SetOnStage( actor ); - - DALI_TEST_EQUALS( actor.GetRendererCount(), 1u, TEST_LOCATION); - - Renderer renderer = actor.GetRendererAt(0); - Property::Index index = renderer.GetPropertyIndex( ColorVisual::Property::MIX_COLOR ); - - Animation animation = Animation::New(4.0f); - animation.AnimateTo( Property(renderer, index), Color::WHITE ); - animation.Play(); - - application.SendNotification(); - application.Render(0); - application.Render(2000u); // halfway point - - Vector4 color = renderer.GetProperty( index ); - Vector4 testColor = (Color::BLUE + Color::WHITE)*0.5f; - DALI_TEST_EQUALS( color, testColor, TEST_LOCATION ); - - DALI_TEST_EQUALS( application.GetGlAbstraction().CheckUniformValue("mixColor", testColor ), true, TEST_LOCATION ); - - application.Render(2000u); // halfway point between blue and white - - color = renderer.GetProperty( index ); - DALI_TEST_EQUALS( color, Color::WHITE, TEST_LOCATION ); - - DALI_TEST_EQUALS( application.GetGlAbstraction().CheckUniformValue("mixColor", Color::WHITE ), true, TEST_LOCATION ); - - - END_TEST; -} - - -int UtcDaliVisualAnimatePrimitiveVisual(void) -{ - ToolkitTestApplication application; - tet_infoline( "UtcDaliAnimatePrimitiveVisual color" ); - - VisualFactory factory = VisualFactory::Get(); - Property::Map propertyMap; - propertyMap.Insert(Visual::Property::TYPE, Visual::COLOR); - propertyMap.Insert(ColorVisual::Property::MIX_COLOR, Color::BLUE); - Visual::Base borderVisual = factory.CreateVisual( propertyMap ); - - Actor actor = Actor::New(); - actor.SetSize(2000, 2000); - actor.SetParentOrigin(ParentOrigin::CENTER); - actor.SetColor(Color::BLACK); - Stage::GetCurrent().Add(actor); - borderVisual.SetOnStage( actor ); - - DALI_TEST_EQUALS( actor.GetRendererCount(), 1u, TEST_LOCATION); - - Renderer renderer = actor.GetRendererAt(0); - Property::Index index = renderer.GetPropertyIndex( PrimitiveVisual::Property::COLOR ); - - // The property isn't registered on the renderer, it's instead registered on the shader. - DALI_TEST_EQUALS( index, Property::INVALID_INDEX, TEST_LOCATION ); - - Animation animation = Animation::New(4.0f); - animation.AnimateTo( Property(actor, Actor::Property::COLOR), Color::WHITE ); - animation.Play(); - - application.SendNotification(); - application.Render(0); - application.Render(2000u); // halfway point - - // Actor color overrides renderer color. - DALI_TEST_EQUALS( application.GetGlAbstraction().CheckUniformValue("uColor", Vector4(0.5f, 0.5f, 0.5f, 1.0f )), true, TEST_LOCATION ); - - application.Render(2000u); // halfway point between blue and white - - DALI_TEST_EQUALS( actor.GetCurrentColor(), Color::WHITE, TEST_LOCATION ); - DALI_TEST_EQUALS( application.GetGlAbstraction().CheckUniformValue("uColor", Color::WHITE ), true, TEST_LOCATION ); - - - END_TEST; -} - -int UtcDaliVisualWireframeVisual(void) -{ - ToolkitTestApplication application; - - VisualFactory factory = VisualFactory::Get(); - Property::Map propertyMap; - propertyMap.Insert( Visual::Property::TYPE, Visual::WIREFRAME ); - - // Create the visual. - Visual::Base visual = factory.CreateVisual( propertyMap ); - - DALI_TEST_CHECK( visual ); - - Property::Map resultMap; - visual.CreatePropertyMap( resultMap ); - - // Check the property values from the returned map from visual - Property::Value* value = resultMap.Find( Visual::Property::TYPE, Property::INTEGER ); - DALI_TEST_CHECK( value ); - DALI_TEST_CHECK( value->Get() == Visual::WIREFRAME ); - END_TEST; -} - diff --git a/dali-toolkit/internal/file.list b/dali-toolkit/internal/file.list index 78940ad..2c22b61 100644 --- a/dali-toolkit/internal/file.list +++ b/dali-toolkit/internal/file.list @@ -18,17 +18,17 @@ toolkit_src_files = \ $(toolkit_src_dir)/visuals/visual-string-constants.cpp \ $(toolkit_src_dir)/visuals/border/border-visual.cpp \ $(toolkit_src_dir)/visuals/color/color-visual.cpp \ + $(toolkit_src_dir)/visuals/debug/debug-visual.cpp \ + $(toolkit_src_dir)/visuals/image/image-visual.cpp \ + $(toolkit_src_dir)/visuals/npatch/npatch-visual.cpp \ $(toolkit_src_dir)/visuals/gradient/gradient.cpp \ $(toolkit_src_dir)/visuals/gradient/linear-gradient.cpp \ $(toolkit_src_dir)/visuals/gradient/radial-gradient.cpp \ $(toolkit_src_dir)/visuals/gradient/gradient-visual.cpp \ - $(toolkit_src_dir)/visuals/image/image-visual.cpp \ - $(toolkit_src_dir)/visuals/mesh/mesh-visual.cpp \ - $(toolkit_src_dir)/visuals/npatch/npatch-visual.cpp \ - $(toolkit_src_dir)/visuals/primitive/primitive-visual.cpp \ $(toolkit_src_dir)/visuals/svg/svg-rasterize-thread.cpp \ $(toolkit_src_dir)/visuals/svg/svg-visual.cpp \ - $(toolkit_src_dir)/visuals/wireframe/wireframe-visual.cpp \ + $(toolkit_src_dir)/visuals/mesh/mesh-visual.cpp \ + $(toolkit_src_dir)/visuals/primitive/primitive-visual.cpp \ $(toolkit_src_dir)/controls/alignment/alignment-impl.cpp \ $(toolkit_src_dir)/controls/bloom-view/bloom-view-impl.cpp \ $(toolkit_src_dir)/controls/bubble-effect/bubble-emitter-impl.cpp \ diff --git a/dali-toolkit/internal/visuals/wireframe/wireframe-visual.cpp b/dali-toolkit/internal/visuals/debug/debug-visual.cpp similarity index 85% rename from dali-toolkit/internal/visuals/wireframe/wireframe-visual.cpp rename to dali-toolkit/internal/visuals/debug/debug-visual.cpp index 47474a6..d3af3ca 100644 --- a/dali-toolkit/internal/visuals/wireframe/wireframe-visual.cpp +++ b/dali-toolkit/internal/visuals/debug/debug-visual.cpp @@ -17,7 +17,7 @@ // CLASS HEADER -#include "wireframe-visual.h" +#include "debug-visual.h" // INTERNAL INCLUDES #include @@ -65,39 +65,39 @@ void main()\n } -WireframeVisual::WireframeVisual( VisualFactoryCache& factoryCache ) +DebugVisual::DebugVisual( VisualFactoryCache& factoryCache ) : Visual::Base( factoryCache ) { } -WireframeVisual::~WireframeVisual() +DebugVisual::~DebugVisual() {} -void WireframeVisual::DoSetOnStage( Actor& actor ) +void DebugVisual::DoSetOnStage( Actor& actor ) { InitializeRenderer(); } -void WireframeVisual::DoCreatePropertyMap( Property::Map& map ) const +void DebugVisual::DoCreatePropertyMap( Property::Map& map ) const { map.Clear(); - map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::WIREFRAME ); + map.Insert( Toolkit::Visual::Property::TYPE, Toolkit::Visual::DEBUG ); } -void WireframeVisual::InitializeRenderer() +void DebugVisual::InitializeRenderer() { - mImpl->mRenderer = mFactoryCache.GetWireframeRenderer(); + mImpl->mRenderer = mFactoryCache.GetDebugRenderer(); if( !mImpl->mRenderer ) { Geometry geometry = CreateQuadWireframeGeometry(); Shader shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER ); mImpl->mRenderer = Renderer::New( geometry, shader); - mFactoryCache.CacheWireframeRenderer( mImpl->mRenderer ); + mFactoryCache.CacheDebugRenderer( mImpl->mRenderer ); } } -Geometry WireframeVisual::CreateQuadWireframeGeometry() +Geometry DebugVisual::CreateQuadWireframeGeometry() { const float halfWidth = 0.5f; const float halfHeight = 0.5f; diff --git a/dali-toolkit/internal/visuals/wireframe/wireframe-visual.h b/dali-toolkit/internal/visuals/debug/debug-visual.h similarity index 78% rename from dali-toolkit/internal/visuals/wireframe/wireframe-visual.h rename to dali-toolkit/internal/visuals/debug/debug-visual.h index b14452a..c4c6248 100644 --- a/dali-toolkit/internal/visuals/wireframe/wireframe-visual.h +++ b/dali-toolkit/internal/visuals/debug/debug-visual.h @@ -1,8 +1,8 @@ -#ifndef DALI_TOOLKIT_INTERNAL_WIREFRAME_VISUAL_H -#define DALI_TOOLKIT_INTERNAL_WIREFRAME_VISUAL_H +#ifndef DALI_TOOLKIT_INTERNAL_DEBUG_VISUAL_H +#define DALI_TOOLKIT_INTERNAL_DEBUG_VISUAL_H /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2015 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. @@ -31,10 +31,10 @@ namespace Internal { /** - * The visual which renders a wireframe outline to the control's quad. + * The visual which renders a wireframe outline to the control's quad for debugging * */ -class WireframeVisual: public Visual::Base +class DebugVisual: public Visual::Base { public: @@ -43,12 +43,12 @@ public: * * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object */ - WireframeVisual( VisualFactoryCache& factoryCache ); + DebugVisual( VisualFactoryCache& factoryCache ); /** * @brief A reference counted object may only be deleted by calling Unreference(). */ - virtual ~WireframeVisual(); + virtual ~DebugVisual(); protected: @@ -78,10 +78,10 @@ private: private: // Undefined - WireframeVisual( const WireframeVisual& visual); + DebugVisual( const DebugVisual& debugVisual); // Undefined - WireframeVisual& operator=( const WireframeVisual& visual ); + DebugVisual& operator=( const DebugVisual& debugVisual ); }; @@ -91,4 +91,4 @@ private: } // namespace Dali -#endif // DALI_TOOLKIT_INTERNAL_WIREFRAME_VISUAL_H +#endif /* DALI_TOOLKIT_INTERNAL_DEBUG_VISUAL_H */ diff --git a/dali-toolkit/internal/visuals/visual-factory-cache.cpp b/dali-toolkit/internal/visuals/visual-factory-cache.cpp index b3f8ab6..aef0fc8 100644 --- a/dali-toolkit/internal/visuals/visual-factory-cache.cpp +++ b/dali-toolkit/internal/visuals/visual-factory-cache.cpp @@ -1,5 +1,5 @@ /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2015 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. @@ -143,14 +143,14 @@ bool VisualFactoryCache::CleanRendererCache( const std::string& key ) return false; } -void VisualFactoryCache::CacheWireframeRenderer( Renderer& renderer ) +void VisualFactoryCache::CacheDebugRenderer( Renderer& renderer ) { - mWireframeRenderer = renderer; + mDebugRenderer = renderer; } -Renderer VisualFactoryCache::GetWireframeRenderer() +Renderer VisualFactoryCache::GetDebugRenderer() { - return mWireframeRenderer; + return mDebugRenderer; } Geometry VisualFactoryCache::CreateQuadGeometry() diff --git a/dali-toolkit/internal/visuals/visual-factory-cache.h b/dali-toolkit/internal/visuals/visual-factory-cache.h index 232495d..488be15 100644 --- a/dali-toolkit/internal/visuals/visual-factory-cache.h +++ b/dali-toolkit/internal/visuals/visual-factory-cache.h @@ -152,14 +152,14 @@ public: bool CleanRendererCache( const std::string& key ); /** - * @brief Cache the wireframe renderer + * @brief Cache the debug renderer */ - void CacheWireframeRenderer( Renderer& renderer ); + void CacheDebugRenderer( Renderer& renderer ); /** - * @brief Request the wireframe renderer; + * @brief Request the debug renderer; */ - Renderer GetWireframeRenderer(); + Renderer GetDebugRenderer(); /** * Get the SVG rasterization thread. @@ -220,7 +220,7 @@ private: HashVector mRendererHashes; CachedRenderers mRenderers; - Renderer mWireframeRenderer; + Renderer mDebugRenderer; SvgRasterizeThread* mSvgRasterizeThread; }; diff --git a/dali-toolkit/internal/visuals/visual-factory-impl.cpp b/dali-toolkit/internal/visuals/visual-factory-impl.cpp index 71152d9..799fe6d 100644 --- a/dali-toolkit/internal/visuals/visual-factory-impl.cpp +++ b/dali-toolkit/internal/visuals/visual-factory-impl.cpp @@ -31,21 +31,22 @@ #include #include #include +#include #include +#include #include +#include #include -#include #include -#include -#include #include #include +#include namespace { const char * const BROKEN_VISUAL_IMAGE_URL( DALI_IMAGE_DIR "broken.png"); } - + namespace Dali { @@ -65,7 +66,7 @@ DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, GRADIENT ) DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, IMAGE ) DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, MESH ) DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, PRIMITIVE ) -DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, WIREFRAME ) +DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::Visual, DEBUG ) DALI_ENUM_TO_STRING_TABLE_END( VISUAL_TYPE ) const char * const VISUAL_TYPE( "visualType" ); @@ -99,10 +100,10 @@ Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& property mFactoryCache = new VisualFactoryCache(); } - // Return a new WireframeVisual if we have debug enabled + // Return a new DebugVisual if we have debug enabled if( mDebugEnabled ) { - return Toolkit::Visual::Base( new WireframeVisual( *( mFactoryCache.Get() ) ) ); + return Toolkit::Visual::Base( new DebugVisual( *( mFactoryCache.Get() ) ) ); } Visual::Base* visualPtr = NULL; @@ -173,9 +174,9 @@ Toolkit::Visual::Base VisualFactory::CreateVisual( const Property::Map& property break; } - case Toolkit::Visual::WIREFRAME: + case Toolkit::Visual::DEBUG: { - visualPtr = new WireframeVisual( *( mFactoryCache.Get() ) ); + visualPtr = new DebugVisual( *( mFactoryCache.Get() ) ); break; } } @@ -202,7 +203,7 @@ Toolkit::Visual::Base VisualFactory::CreateVisual( const Image& image ) if( mDebugEnabled ) { - return Toolkit::Visual::Base( new WireframeVisual( *( mFactoryCache.Get() ) ) ); + return Toolkit::Visual::Base( new DebugVisual( *( mFactoryCache.Get() ) ) ); } NinePatchImage npatchImage = NinePatchImage::DownCast( image ); @@ -233,7 +234,7 @@ Toolkit::Visual::Base VisualFactory::CreateVisual( const std::string& url, Image if( mDebugEnabled ) { - return Toolkit::Visual::Base( new WireframeVisual( *( mFactoryCache.Get() ) ) ); + return Toolkit::Visual::Base( new DebugVisual( *( mFactoryCache.Get() ) ) ); } if( NinePatchImage::IsNinePatchUrl( url ) ) diff --git a/dali-toolkit/public-api/visuals/visual-properties.h b/dali-toolkit/public-api/visuals/visual-properties.h index 8b2272d..4952ebb 100644 --- a/dali-toolkit/public-api/visuals/visual-properties.h +++ b/dali-toolkit/public-api/visuals/visual-properties.h @@ -42,7 +42,7 @@ enum Type IMAGE, ///< Renders an image into the control's quad. @SINCE_1_1.45 MESH, ///< Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file. @SINCE_1_1.45 PRIMITIVE, ///< Renders a simple 3D shape, such as a cube or sphere. @SINCE_1_1.45 - WIREFRAME, ///< Renders a simple wire-frame outlining a quad. @SINCE_1_1.45 + DEBUG, ///< Renders a simple wire-frame outlining a quad. @SINCE_1_1.45 }; namespace Property diff --git a/docs/content/images/debug-rendering/debug-blocks.png b/docs/content/images/debug-visual/debug-blocks.png similarity index 100% rename from docs/content/images/debug-rendering/debug-blocks.png rename to docs/content/images/debug-visual/debug-blocks.png diff --git a/docs/content/images/visuals/wireframe-visual.png b/docs/content/images/visuals/wireframe-visual.png deleted file mode 100644 index b22bd942cddeaf1b740ded4074625a16c2269d1e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 483 zcmeAS@N?(olHy`uVBq!ia0vp^tAKbl2OE(5rp2xfq}Y|gW!U_%O?XxI14-? ziy0WWg+Z8+Vb&Z8pdfpRr>`sf0}cUx6X8C?hzte>#sW_l$B>F!Z*MtrH7E$QU93O! zJH9filwqpUtG#~}PPFgZFsbChQ@-ei0LK*^qAgrbt}7Hm1hkx37amGI!&mZK>cG5J zyX>!AZB2N-p!n - -# Debug rendering {#debugrendering} - -Setting DALI_DEBUG_RENDERING environment variable will enable the visual debugging. - -Then, every concrete visual ( ColorVisual, BorderVisual, ImageVisual, GradientVisual, etc. ) is replaced with a wireframe visual. -The wireframe visual renders a simple quad wireframe, so that the control layout and scene structure is clearly displayed. - -## Example: -~~~{.bash} -sh-4.1$ DALI_DEBUG_RENDERING=1 /usr/apps/com.samsung.dali-demo/bin/blocks.example -~~~ - -![ ](../assets/img/debug-rendering/debug-blocks.png) -![ ](debug-blocks.png) - - diff --git a/docs/content/shared-javascript-and-cpp-documentation/debug-visual.md b/docs/content/shared-javascript-and-cpp-documentation/debug-visual.md new file mode 100644 index 0000000..588f046 --- /dev/null +++ b/docs/content/shared-javascript-and-cpp-documentation/debug-visual.md @@ -0,0 +1,21 @@ + + +# Debug Visual {#debugvisual} + +## Enable debug rendering + +Setting DALI_DEBUG_RENDERING environment variable will enable the visual debugging. + +Then, every concrete visual ( ColorVisual, BorderVisual, ImageVisual, GradientVisual, etc. ) is replaced with a DebugVisual object. +Debug visual renders a simple quad wireframe, so that the control layout and scene structure is clearly displayed. + +### Example: +~~~{.bash} +sh-4.1$ DALI_DEBUG_RENDERING=1 /usr/apps/com.samsung.dali-demo/bin/blocks.example +~~~ + +![ ](../assets/img/debug-visual/debug-blocks.png) +![ ](debug-blocks.png) + + diff --git a/docs/content/shared-javascript-and-cpp-documentation/visuals.md b/docs/content/shared-javascript-and-cpp-documentation/visuals.md index 728f080..95a40c3 100644 --- a/docs/content/shared-javascript-and-cpp-documentation/visuals.md +++ b/docs/content/shared-javascript-and-cpp-documentation/visuals.md @@ -16,7 +16,6 @@ DALi provides the following visuals: + [Border](@ref border-visual) + [Mesh](@ref mesh-visual) + [Primitive](@ref primitive-visual) - + [Wireframe](@ref wireframe-visual) Controls can provide properties that allow users to specify the visual type ( visualType ). Setting visual properties are done via a property map. @@ -607,42 +606,6 @@ map[ PrimitiveVisual::Property::BEVEL_PERCENTAGE ] = 0.4f; control.SetProperty( Control::Property::BACKGROUND, map ); ~~~ -___________________________________________________________________________________________________ - -## Wireframe Visual {#wireframe-visual} - -Renders a wireframe around a control's quad. -Is mainly used for debugging and is the visual that replaces all other visuals when [Visual Debug Rendering](@ref debugrendering) is turned on. - -![ ](../assets/img/visuals/wireframe-visual.png) -![ ](visuals/wireframe-visual.png) - -### Properties - -**VisualType:** Dali::Toolkit::Visual::WIREFRAME, "WIREFRAME" - -### Usage - -~~~{.cpp} -// C++ -Dali::Toolkit::Control control = Dali::Toolkit::Control::New(); - -Dali::Property::Map map; -map[ Visual::Property::TYPE ] = Dali::Toolkit::Visual::WIREFRAME; - -control.SetProperty( Control::Property::BACKGROUND, map ); -~~~ - -~~~{.js} -// JavaScript -var control = new dali.Control( "Control" ); - -control.background = -{ - visualType : "WIREFRAME" -}; -~~~ - @class _Guide_Control_Visuals -- 2.7.4