examples/renderer-stencil/renderer-stencil-example.cpp

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // EXTERNAL INCLUDES
  19 #include <dali-toolkit/dali-toolkit.h>
  20 #include <dali/devel-api/adaptor-framework/bitmap-loader.h>
  21
  22 // INTERNAL INCLUDES
  23 #include "renderer-stencil-shaders.h"
  24 #include "shared/view.h"
  25 #include "shared/utility.h"
  26
  27 using namespace Dali;
  28
  29 namespace
  30 {
  31
  32 // Constants:
  33
  34 // Application constants:
  35 const char * const APPLICATION_TITLE( "Renderer Stencil API Demo" );
  36 const char * const BACKGROUND_IMAGE( DEMO_IMAGE_DIR "background-gradient.jpg" );
  37
  38 // Texture filenames:
  39 const char * const CUBE_TEXTURE( DEMO_IMAGE_DIR "people-medium-1.jpg" );
  40 const char * const FLOOR_TEXTURE( DEMO_IMAGE_DIR "wood.png" );
  41
  42 // Scale dimensions: These values are relative to the stage size. EG. width = 0.32f * stageSize.
  43 const float   CUBE_WIDTH_SCALE( 0.32f );                   ///< The width (and height + depth) of the main and reflection cubes.
  44 const Vector2 FLOOR_DIMENSION_SCALE( 0.67f, 0.017f );      ///< The width and height of the floor object.
  45
  46 // Configurable animation characteristics:
  47 const float ANIMATION_ROTATION_DURATION( 10.0f );          ///< Time in seconds to rotate the scene 360 degrees around Y.
  48 const float ANIMATION_BOUNCE_TOTAL_TIME( 1.6f );           ///< Time in seconds to perform 1 full bounce animation cycle.
  49 const float ANIMATION_BOUNCE_DEFORMATION_TIME( 0.4f );     ///< Time in seconds that the cube deformation animation will occur for (on contact with the floor).
  50 const float ANIMATION_BOUNCE_DEFORMATION_PERCENT( 20.0f ); ///< Percentage (of the cube's size) to deform the cube by (on contact with floor).
  51 const float ANIMATION_BOUNCE_HEIGHT_PERCENT( 40.0f );      ///< Percentage (of the cube's size) to bounce up in to the air by.
  52
  53 // Base colors for the objects:
  54 const Vector4 TEXT_COLOR( 1.0f, 1.0f, 1.0f, 1.0f );        ///< White.
  55 const Vector4 CUBE_COLOR( 1.0f, 1.0f, 1.0f, 1.0f );        ///< White.
  56 const Vector4 FLOOR_COLOR( 1.0f, 1.0f, 1.0f, 1.0f );       ///< White.
  57 const Vector4 REFLECTION_COLOR( 0.6f, 0.6f, 0.6f, 0.6f );  ///< Note that alpha is not 1.0f, to make the blend more photo-realistic.
  58
  59 // We need to control the draw order as we are controlling both the stencil and depth buffer per renderer.
  60 const int DEPTH_INDEX_GRANULARITY( 10000 );                ///< This value is the gap in depth-index in-between each renderer.
  61
  62 } // Anonymous namespace
  63
  64 /**
  65  * @brief This example shows how to manipulate stencil and depth buffer properties within the Renderer API.
  66  */
  67 class RendererStencilExample : public ConnectionTracker
  68 {
  69 public:
  70
  71   /**
  72    * @brief Constructor.
  73    * @param[in] application The DALi application object
  74    */
  75   RendererStencilExample( Application& application )
  76   : mApplication( application )
  77   {
  78     // Connect to the Application's Init signal.
  79     mApplication.InitSignal().Connect( this, &RendererStencilExample::Create );
  80   }
  81
  82   /**
  83    * @brief Destructor (non-virtual).
  84    */
  85   ~RendererStencilExample()
  86   {
  87   }
  88
  89 private:
  90
  91   /**
  92    * @brief Enum to facilitate more readable use of the cube array.
  93    */
  94   enum CubeType
  95   {
  96     MAIN_CUBE,      ///< The main cube that bounces above the floor object.
  97     REFLECTION_CUBE ///< The reflected cube object.
  98   };
  99
 100   /**
 101    * @brief Struct to store the position, normal and texture coordinates of a single vertex.
 102    */
 103   struct TexturedVertex
 104   {
 105     Vector3 position;
 106     Vector3 normal;
 107     Vector2 textureCoord;
 108   };
 109
 110   /**
 111    * @brief This is the main scene setup method for this demo.
 112    * This is called via the Init signal which is received once (only) during the Application lifetime.
 113    * @param[in] application The DALi application object
 114    */
 115   void Create( Application& application )
 116   {
 117     Stage stage = Stage::GetCurrent();
 118
 119     // Creates the background image.
 120     Toolkit::Control background = Dali::Toolkit::Control::New();
 121     background.SetAnchorPoint( Dali::AnchorPoint::CENTER );
 122     background.SetParentOrigin( Dali::ParentOrigin::CENTER );
 123     background.SetResizePolicy( Dali::ResizePolicy::FILL_TO_PARENT, Dali::Dimension::ALL_DIMENSIONS );
 124     Dali::Property::Map map;
 125     map["rendererType"] = "IMAGE";
 126     map["url"] = BACKGROUND_IMAGE;
 127     background.SetProperty( Dali::Toolkit::Control::Property::BACKGROUND, map );
 128     stage.Add( background );
 129
 130     // Create a TextLabel for the application title.
 131     Toolkit::TextLabel label = Toolkit::TextLabel::New( APPLICATION_TITLE );
 132     label.SetAnchorPoint( AnchorPoint::TOP_CENTER );
 133     // Set the parent origin to a small percentage below the top (so the demo will scale for different resolutions).
 134     label.SetParentOrigin( Vector3( 0.5f, 0.03f, 0.5f ) );
 135     label.SetProperty( Toolkit::TextLabel::Property::HORIZONTAL_ALIGNMENT, "CENTER" );
 136     label.SetProperty( Toolkit::TextLabel::Property::VERTICAL_ALIGNMENT, "CENTER" );
 137     label.SetProperty( Toolkit::TextLabel::Property::TEXT_COLOR, TEXT_COLOR );
 138     stage.Add( label );
 139
 140     // Layer to hold the 3D scene.
 141     Layer layer = Layer::New();
 142     layer.SetAnchorPoint( AnchorPoint::CENTER );
 143     // Set the parent origin to a small percentage below the center (so the demo will scale for different resolutions).
 144     layer.SetParentOrigin( Vector3( 0.5f, 0.58f, 0.5f ) );
 145     layer.SetBehavior( Layer::LAYER_2D );
 146     layer.SetDepthTestDisabled( false );
 147     stage.Add( layer );
 148
 149     // Main cube:
 150     // Make the demo scalable with different resolutions by basing
 151     // the cube size on a percentage of the stage size.
 152     float scaleSize( std::min( stage.GetSize().width, stage.GetSize().height ) );
 153     float cubeWidth( scaleSize * CUBE_WIDTH_SCALE );
 154     Vector3 cubeSize( cubeWidth, cubeWidth, cubeWidth );
 155     // Create the geometry for the cube, and the texture.
 156     Geometry cubeGeometry = CreateCubeVertices( Vector3::ONE, false );
 157     TextureSet cubeTextureSet = CreateTextureSet( CUBE_TEXTURE );
 158     // Create the cube object and add it.
 159     // Note: The cube is anchored around its base for animation purposes, so the position can be zero.
 160     mCubes[ MAIN_CUBE ] = CreateMainCubeObject( cubeGeometry, cubeSize, cubeTextureSet );
 161     layer.Add( mCubes[ MAIN_CUBE ] );
 162
 163     // Floor:
 164     float floorWidth( scaleSize * FLOOR_DIMENSION_SCALE.x );
 165     Vector3 floorSize( floorWidth, scaleSize * FLOOR_DIMENSION_SCALE.y, floorWidth );
 166     // Create the floor object using the cube geometry with a new size, and add it.
 167     Actor floorObject( CreateFloorObject( cubeGeometry, floorSize ) );
 168     layer.Add( floorObject );
 169
 170     // Stencil:
 171     Vector3 planeSize( floorWidth, floorWidth, 0.0f );
 172     // Create the stencil plane object, and add it.
 173     Actor stencilPlaneObject( CreateStencilPlaneObject( planeSize ) );
 174     layer.Add( stencilPlaneObject );
 175
 176     // Reflection cube:
 177     // Create the reflection cube object and add it.
 178     // Note: The cube is anchored around its base for animation purposes, so the position can be zero.
 179     mCubes[ REFLECTION_CUBE ] = CreateReflectionCubeObject( cubeSize, cubeTextureSet );
 180     layer.Add( mCubes[ REFLECTION_CUBE ] );
 181
 182     // Rotate the layer so we can see some of the top of the cube for a more 3D effect.
 183     layer.SetProperty( Actor::Property::ORIENTATION, Quaternion( Degree( -24.0f ), Degree( 0.0f ), Degree( 0.0f ) ) );
 184
 185     // Set up the rotation on the Y axis.
 186     mRotationAnimation = Animation::New( ANIMATION_ROTATION_DURATION );
 187     float fullRotation = 360.0f;
 188     mRotationAnimation.AnimateBy( Property( mCubes[ MAIN_CUBE ], Actor::Property::ORIENTATION ),
 189                                  Quaternion( Degree( 0.0f ), Degree( fullRotation ), Degree( 0.0f ) ) );
 190     mRotationAnimation.AnimateBy( Property( floorObject, Actor::Property::ORIENTATION ),
 191                                  Quaternion( Degree( 0.0f ), Degree( fullRotation ), Degree( 0.0f ) ) );
 192     // Note the stencil is pre-rotated by 90 degrees on X, so we rotate relatively on its Z axis for an equivalent Y rotation.
 193     mRotationAnimation.AnimateBy( Property( stencilPlaneObject, Actor::Property::ORIENTATION ),
 194                                  Quaternion( Degree( 0.0f ), Degree( 0.0f ), Degree( fullRotation ) ) );
 195     mRotationAnimation.AnimateBy( Property( mCubes[ REFLECTION_CUBE ], Actor::Property::ORIENTATION ),
 196                                  Quaternion( Degree( 0.0f ), Degree( fullRotation ), Degree( 0.0f ) ) );
 197     mRotationAnimation.SetLooping( true );
 198
 199     // Set up the cube bouncing animation.
 200     float totalTime = ANIMATION_BOUNCE_TOTAL_TIME;
 201     float deformationTime = ANIMATION_BOUNCE_DEFORMATION_TIME;
 202     // Percentage based amounts allows the bounce and deformation to scale for different resolution screens.
 203     float deformationAmount = ANIMATION_BOUNCE_DEFORMATION_PERCENT / 100.0f;
 204     float heightChange = ( cubeSize.y * ANIMATION_BOUNCE_HEIGHT_PERCENT ) / 100.0f;
 205
 206     // Animation pre-calculations:
 207     float halfTime = totalTime / 2.0f;
 208     float halfDeformationTime = deformationTime / 2.0f;
 209
 210     // First position the cubes at the top of the animation cycle.
 211     mCubes[ MAIN_CUBE ].SetProperty(       Actor::Property::POSITION_Y, -heightChange );
 212     mCubes[ REFLECTION_CUBE ].SetProperty( Actor::Property::POSITION_Y,  heightChange );
 213
 214     mBounceAnimation = Animation::New( totalTime );
 215
 216     // The animations for the main and reflected cubes are almost identical, so we combine the code to do both.
 217     for( int cube = 0; cube < 2; ++cube )
 218     {
 219       // If iterating on the reflection cube, adjust the heightChange variable so the below code can be reused.
 220       if( cube == 1 )
 221       {
 222         heightChange = -heightChange;
 223       }
 224
 225       // 1st TimePeriod: Start moving down with increasing speed, until it is time to distort the cube due to impact.
 226       mBounceAnimation.AnimateBy( Property( mCubes[ cube ], Actor::Property::POSITION_Y ),  heightChange, AlphaFunction::EASE_IN_SQUARE, TimePeriod( 0.0f, halfTime - halfDeformationTime ) );
 227
 228       // 2nd TimePeriod: The cube is touching the floor, start deforming it - then un-deform it again.
 229       mBounceAnimation.AnimateBy( Property( mCubes[ cube ], Actor::Property::SCALE_X ),  deformationAmount, AlphaFunction::BOUNCE, TimePeriod( halfTime - halfDeformationTime, deformationTime ) );
 230       mBounceAnimation.AnimateBy( Property( mCubes[ cube ], Actor::Property::SCALE_Z ),  deformationAmount, AlphaFunction::BOUNCE, TimePeriod( halfTime - halfDeformationTime, deformationTime ) );
 231       mBounceAnimation.AnimateBy( Property( mCubes[ cube ], Actor::Property::SCALE_Y ), -deformationAmount, AlphaFunction::BOUNCE, TimePeriod( halfTime - halfDeformationTime, deformationTime ) );
 232
 233       // 3rd TimePeriod: Start moving up with decreasing speed, until at the apex of the animation.
 234       mBounceAnimation.AnimateBy( Property( mCubes[ cube ], Actor::Property::POSITION_Y ), -heightChange, AlphaFunction::EASE_OUT_SQUARE, TimePeriod( halfTime + halfDeformationTime, halfTime - halfDeformationTime ) );
 235     }
 236
 237     mBounceAnimation.SetLooping( true );
 238
 239     // Start the animations.
 240     mRotationAnimation.Play();
 241     mBounceAnimation.Play();
 242
 243     // Respond to a click anywhere on the stage
 244     stage.GetRootLayer().TouchSignal().Connect( this, &RendererStencilExample::OnTouch );
 245     // Connect signals to allow Back and Escape to exit.
 246     stage.KeyEventSignal().Connect( this, &RendererStencilExample::OnKeyEvent );
 247   }
 248
 249 private:
 250
 251   // Methods to setup each component of the 3D scene:
 252
 253   /**
 254    * @brief Creates the Main cube object.
 255    * This creates the renderer from existing geometry (as the cubes geometry is shared).
 256    * The texture is set and all relevant renderer properties are set-up.
 257    * @param[in] geometry Pre-calculated cube geometry
 258    * @param[in] size The desired cube size
 259    * @param[in] textureSet A pre-existing TextureSet with a texture set up, to be applied to the cube
 260    * @return An actor set-up containing the main cube object
 261    */
 262   Actor CreateMainCubeObject( Geometry& geometry, Vector3 size, TextureSet& textureSet )
 263   {
 264     Toolkit::Control container = Toolkit::Control::New();
 265     container.SetAnchorPoint( AnchorPoint::BOTTOM_CENTER );
 266     container.SetParentOrigin( ParentOrigin::BOTTOM_CENTER );
 267     container.SetSize( size );
 268     container.SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
 269
 270     // Create a renderer from the geometry and add the texture.
 271     Renderer renderer = CreateRenderer( geometry, size, true, CUBE_COLOR );
 272     renderer.SetTextures( textureSet );
 273
 274     // Setup the renderer properties:
 275     // We are writing to the color buffer & culling back faces.
 276     renderer.SetProperty( Renderer::Property::WRITE_TO_COLOR_BUFFER, true );
 277     renderer.SetProperty( Renderer::Property::FACE_CULLING_MODE, FaceCullingMode::BACK );
 278
 279     // No stencil is used for the main cube.
 280     renderer.SetProperty( Renderer::Property::STENCIL_MODE, StencilMode::OFF );
 281
 282     // We do need to write to the depth buffer as other objects need to appear underneath this cube.
 283     renderer.SetProperty( Renderer::Property::DEPTH_WRITE_MODE, DepthWriteMode::ON );
 284     // We do not need to test the depth buffer as we are culling the back faces.
 285     renderer.SetProperty( Renderer::Property::DEPTH_TEST_MODE, DepthTestMode::OFF );
 286
 287     // This object must be rendered 1st.
 288     renderer.SetProperty( Renderer::Property::DEPTH_INDEX, 0 * DEPTH_INDEX_GRANULARITY );
 289
 290     container.AddRenderer( renderer );
 291     return container;
 292   }
 293
 294   /**
 295    * @brief Creates the Floor object.
 296    * This creates the renderer from existing geometry (as the cube geometry can be re-used).
 297    * The texture is created and set and all relevant renderer properties are set-up.
 298    * @param[in] geometry Pre-calculated cube geometry
 299    * @param[in] size The desired floor size
 300    * @return An actor set-up containing the floor object
 301    */
 302   Actor CreateFloorObject( Geometry& geometry, Vector3 size )
 303   {
 304     Toolkit::Control container = Toolkit::Control::New();
 305     container.SetAnchorPoint( AnchorPoint::TOP_CENTER );
 306     container.SetParentOrigin( ParentOrigin::TOP_CENTER );
 307     container.SetSize( size );
 308     container.SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
 309
 310     // Create a renderer from the geometry and add the texture.
 311     TextureSet planeTextureSet = CreateTextureSet( FLOOR_TEXTURE );
 312     Renderer renderer = CreateRenderer( geometry, size, true, FLOOR_COLOR );
 313     renderer.SetTextures( planeTextureSet );
 314
 315     // Setup the renderer properties:
 316     // We are writing to the color buffer & culling back faces (as we are NOT doing depth write).
 317     renderer.SetProperty( Renderer::Property::WRITE_TO_COLOR_BUFFER, true );
 318     renderer.SetProperty( Renderer::Property::FACE_CULLING_MODE, FaceCullingMode::BACK );
 319
 320     // No stencil is used for the floor.
 321     renderer.SetProperty( Renderer::Property::STENCIL_MODE, StencilMode::OFF );
 322
 323     // We do not write to the depth buffer as its not needed.
 324     renderer.SetProperty( Renderer::Property::DEPTH_WRITE_MODE, DepthWriteMode::OFF );
 325     // We do need to test the depth buffer as we need the floor to be underneath the cube.
 326     renderer.SetProperty( Renderer::Property::DEPTH_TEST_MODE, DepthTestMode::ON );
 327
 328     // This object must be rendered 2nd.
 329     renderer.SetProperty( Renderer::Property::DEPTH_INDEX, 1 * DEPTH_INDEX_GRANULARITY );
 330
 331     container.AddRenderer( renderer );
 332     return container;
 333   }
 334
 335   /**
 336    * @brief Creates the Stencil-Plane object.
 337    * This is places on the floor object to allow the reflection to be drawn on to the floor.
 338    * This creates the geometry and renderer.
 339    * All relevant renderer properties are set-up.
 340    * @param[in] size The desired plane size
 341    * @return An actor set-up containing the stencil-plane object
 342    */
 343   Actor CreateStencilPlaneObject( Vector3 size )
 344   {
 345     Toolkit::Control container = Toolkit::Control::New();
 346     container.SetAnchorPoint( AnchorPoint::CENTER );
 347     container.SetParentOrigin( ParentOrigin::CENTER );
 348     container.SetSize( size );
 349     container.SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
 350
 351     // We rotate the plane as the geometry is created flat in X & Y. We want it to span X & Z axis.
 352     container.SetProperty( Actor::Property::ORIENTATION, Quaternion( Degree( -90.0f ), Degree( 0.0f ), Degree( 0.0f ) ) );
 353
 354     // Create geometry for a flat plane.
 355     Geometry planeGeometry = CreatePlaneVertices( Vector2::ONE );
 356     // Create a renderer from the geometry.
 357     Renderer renderer = CreateRenderer( planeGeometry, size, false, Vector4::ONE );
 358
 359     // Setup the renderer properties:
 360     // The stencil plane is only for stencilling, so disable writing to color buffer.
 361     renderer.SetProperty( Renderer::Property::WRITE_TO_COLOR_BUFFER, false );
 362
 363     // Enable stencil. Draw to the stencil buffer (only).
 364     renderer.SetProperty( Renderer::Property::STENCIL_MODE, StencilMode::ON );
 365     renderer.SetProperty( Renderer::Property::STENCIL_FUNCTION, StencilFunction::ALWAYS );
 366     renderer.SetProperty( Renderer::Property::STENCIL_FUNCTION_REFERENCE, 1 );
 367     renderer.SetProperty( Renderer::Property::STENCIL_FUNCTION_MASK, 0xFF );
 368     renderer.SetProperty( Renderer::Property::STENCIL_OPERATION_ON_FAIL, StencilOperation::KEEP );
 369     renderer.SetProperty( Renderer::Property::STENCIL_OPERATION_ON_Z_FAIL, StencilOperation::KEEP );
 370     renderer.SetProperty( Renderer::Property::STENCIL_OPERATION_ON_Z_PASS, StencilOperation::REPLACE );
 371     renderer.SetProperty( Renderer::Property::STENCIL_MASK, 0xFF );
 372
 373     // We don't want to write to the depth buffer, as this would block the reflection being drawn.
 374     renderer.SetProperty( Renderer::Property::DEPTH_WRITE_MODE, DepthWriteMode::OFF );
 375     // We test the depth buffer as we want the stencil to only exist underneath the cube.
 376     renderer.SetProperty( Renderer::Property::DEPTH_TEST_MODE, DepthTestMode::ON );
 377
 378     // This object must be rendered 3rd.
 379     renderer.SetProperty( Renderer::Property::DEPTH_INDEX, 2 * DEPTH_INDEX_GRANULARITY );
 380
 381     container.AddRenderer( renderer );
 382     return container;
 383   }
 384
 385   /**
 386    * @brief Creates the Reflection cube object.
 387    * This creates new geometry (as the texture UVs are different to the main cube).
 388    * The renderer is then created.
 389    * The texture is set and all relevant renderer properties are set-up.
 390    * @param[in] size The desired cube size
 391    * @param[in] textureSet A pre-existing TextureSet with a texture set up, to be applied to the cube
 392    * @return An actor set-up containing the reflection cube object
 393    */
 394   Actor CreateReflectionCubeObject( Vector3 size, TextureSet& textureSet )
 395   {
 396     Toolkit::Control container = Toolkit::Control::New();
 397     container.SetAnchorPoint( AnchorPoint::TOP_CENTER );
 398     container.SetParentOrigin( ParentOrigin::TOP_CENTER );
 399     container.SetSize( size );
 400     container.SetResizePolicy( ResizePolicy::FIXED, Dimension::ALL_DIMENSIONS );
 401
 402     // Create the cube geometry of unity size.
 403     // The "true" specifies we want the texture UVs flipped vertically as this is the reflection cube.
 404     Geometry reflectedCubeGeometry = CreateCubeVertices( Vector3::ONE, true );
 405     // Create a renderer from the geometry and add the texture.
 406     Renderer renderer = CreateRenderer( reflectedCubeGeometry, size, true, REFLECTION_COLOR );
 407     renderer.SetTextures( textureSet );
 408
 409     // Setup the renderer properties:
 410     // Write to color buffer so reflection is visible
 411     renderer.SetProperty( Renderer::Property::WRITE_TO_COLOR_BUFFER, true );
 412     // We cull to skip drawing the back faces.
 413     renderer.SetProperty( Renderer::Property::FACE_CULLING_MODE, FaceCullingMode::BACK );
 414
 415     // We use blending to blend the reflection with the floor texture.
 416     renderer.SetProperty( Renderer::Property::BLEND_MODE, BlendMode::ON );
 417     renderer.SetProperty( Renderer::Property::BLEND_EQUATION_RGB, BlendEquation::ADD );
 418     renderer.SetProperty( Renderer::Property::BLEND_EQUATION_ALPHA, BlendEquation::ADD );
 419     renderer.SetProperty( Renderer::Property::BLEND_FACTOR_DEST_RGB, BlendFactor::ONE );
 420
 421     // Enable stencil. Here we only draw to areas within the stencil.
 422     renderer.SetProperty( Renderer::Property::STENCIL_MODE, StencilMode::ON );
 423     renderer.SetProperty( Renderer::Property::STENCIL_FUNCTION, StencilFunction::EQUAL );
 424     renderer.SetProperty( Renderer::Property::STENCIL_FUNCTION_REFERENCE, 1 );
 425     renderer.SetProperty( Renderer::Property::STENCIL_FUNCTION_MASK, 0xff );
 426     // Don't write to the stencil.
 427     renderer.SetProperty( Renderer::Property::STENCIL_MASK, 0x00 );
 428
 429     // We don't need to write to the depth buffer, as we are culling.
 430     renderer.SetProperty( Renderer::Property::DEPTH_WRITE_MODE, DepthWriteMode::OFF );
 431     // We need to test the depth buffer as we need the reflection to be underneath the cube.
 432     renderer.SetProperty( Renderer::Property::DEPTH_TEST_MODE, DepthTestMode::ON );
 433
 434     // This object must be rendered last.
 435     renderer.SetProperty( Renderer::Property::DEPTH_INDEX, 3 * DEPTH_INDEX_GRANULARITY );
 436
 437     container.AddRenderer( renderer );
 438     return container;
 439   }
 440
 441   // Methods:
 442
 443   /**
 444    * @brief Creates a geometry object from vertices and indices.
 445    * @param[in] vertices The object vertices
 446    * @param[in] indices The object indices
 447    * @return A geometry object
 448    */
 449   Geometry CreateTexturedGeometry( Vector<TexturedVertex>& vertices, Vector<unsigned short>& indices )
 450   {
 451     // Vertices
 452     Property::Map vertexFormat;
 453     vertexFormat[POSITION] = Property::VECTOR3;
 454     vertexFormat[NORMAL] =   Property::VECTOR3;
 455     vertexFormat[TEXTURE] =  Property::VECTOR2;
 456
 457     PropertyBuffer surfaceVertices = PropertyBuffer::New( vertexFormat );
 458     surfaceVertices.SetData( &vertices[0u], vertices.Size() );
 459
 460     Geometry geometry = Geometry::New();
 461     geometry.AddVertexBuffer( surfaceVertices );
 462
 463     // Indices for triangle formulation
 464     geometry.SetIndexBuffer( &indices[0u], indices.Size() );
 465     return geometry;
 466   }
 467
 468   /**
 469    * @brief Creates a renderer from a geometry object.
 470    * @param[in] geometry The geometry to use
 471    * @param[in] dimensions The dimensions (will be passed in to the shader)
 472    * @param[in] textured Set to true to use the texture versions of the shaders
 473    * @param[in] color The base color for the renderer
 474    * @return A renderer object
 475    */
 476   Renderer CreateRenderer( Geometry geometry, Vector3 dimensions, bool textured, Vector4 color )
 477   {
 478     Stage stage = Stage::GetCurrent();
 479     Shader shader;
 480
 481     if( textured )
 482     {
 483       shader = Shader::New( VERTEX_SHADER_TEXTURED, FRAGMENT_SHADER_TEXTURED );
 484     }
 485     else
 486     {
 487       shader = Shader::New( VERTEX_SHADER, FRAGMENT_SHADER );
 488     }
 489
 490     // Here we modify the light position based on half the stage size as a pre-calculation step.
 491     // This avoids the work having to be done in the shader.
 492     shader.RegisterProperty( LIGHT_POSITION_UNIFORM_NAME, Vector3( -stage.GetSize().width / 2.0f, -stage.GetSize().width / 2.0f, 1000.0f ) );
 493     shader.RegisterProperty( COLOR_UNIFORM_NAME, color );
 494     shader.RegisterProperty( OBJECT_DIMENSIONS_UNIFORM_NAME, dimensions );
 495
 496     return Renderer::New( geometry, shader );
 497   }
 498
 499   /**
 500    * @brief Helper method to create a TextureSet from an image URL.
 501    * @param[in] url An image URL
 502    * @return A TextureSet object
 503    */
 504   TextureSet CreateTextureSet( const char* url )
 505   {
 506     TextureSet textureSet = TextureSet::New();
 507
 508     if( textureSet )
 509     {
 510       Texture texture = DemoHelper::LoadTexture( url );
 511       if( texture )
 512       {
 513         textureSet.SetTexture( 0u, texture );
 514       }
 515     }
 516
 517     return textureSet;
 518   }
 519
 520   // Geometry Creation:
 521
 522   /**
 523    * @brief Creates a geometry object for a flat plane.
 524    * The plane is oriented in X & Y axis (Z is 0).
 525    * @param[in] dimensions The desired plane dimensions
 526    * @return A Geometry object
 527    */
 528   Geometry CreatePlaneVertices( Vector2 dimensions )
 529   {
 530     Vector<TexturedVertex> vertices;
 531     Vector<unsigned short> indices;
 532     vertices.Resize( 4u );
 533     indices.Resize( 6u );
 534
 535     float scaledX = 0.5f * dimensions.x;
 536     float scaledY = 0.5f * dimensions.y;
 537
 538     vertices[0].position     = Vector3( -scaledX, -scaledY, 0.0f );
 539     vertices[0].textureCoord = Vector2( 0.0, 0.0f );
 540     vertices[1].position     = Vector3(  scaledX, -scaledY, 0.0f );
 541     vertices[1].textureCoord = Vector2( 1.0, 0.0f );
 542     vertices[2].position     = Vector3(  scaledX,  scaledY, 0.0f );
 543     vertices[2].textureCoord = Vector2( 1.0, 1.0f );
 544     vertices[3].position     = Vector3( -scaledX,  scaledY, 0.0f );
 545     vertices[3].textureCoord = Vector2( 0.0, 1.0f );
 546
 547     // All vertices have the same normal.
 548     for( int i = 0; i < 4; ++i )
 549     {
 550       vertices[i].normal = Vector3( 0.0f, 0.0f, -1.0f );
 551     }
 552
 553     indices[0] = 0;
 554     indices[1] = 1;
 555     indices[2] = 2;
 556     indices[3] = 2;
 557     indices[4] = 3;
 558     indices[5] = 0;
 559
 560     // Use the helper method to create the geometry object.
 561     return CreateTexturedGeometry( vertices, indices );
 562   }
 563
 564   /**
 565    * @brief Creates a geometry object for a cube (or cuboid).
 566    * @param[in] dimensions The desired cube dimensions
 567    * @param[in] reflectVerticalUVs Set to True to force the UVs to be vertically flipped
 568    * @return A Geometry object
 569    */
 570   Geometry CreateCubeVertices( Vector3 dimensions, bool reflectVerticalUVs )
 571   {
 572     Vector<TexturedVertex> vertices;
 573     Vector<unsigned short> indices;
 574     int vertexIndex = 0u; // Tracks progress through vertices.
 575     float scaledX = 0.5f * dimensions.x;
 576     float scaledY = 0.5f * dimensions.y;
 577     float scaledZ = 0.5f * dimensions.z;
 578     float verticalTextureCoord = reflectVerticalUVs ? 0.0f : 1.0f;
 579
 580     vertices.Resize( 4u * 6u ); // 4 vertices x 6 faces
 581
 582     Vector<Vector3> positions;  // Stores vertex positions, which are shared between vertexes at the same position but with a different normal.
 583     positions.Resize( 8u );
 584     Vector<Vector3> normals;    // Stores normals, which are shared between vertexes of the same face.
 585     normals.Resize( 6u );
 586
 587     positions[0] = Vector3( -scaledX,  scaledY, -scaledZ );
 588     positions[1] = Vector3(  scaledX,  scaledY, -scaledZ );
 589     positions[2] = Vector3(  scaledX,  scaledY,  scaledZ );
 590     positions[3] = Vector3( -scaledX,  scaledY,  scaledZ );
 591     positions[4] = Vector3( -scaledX, -scaledY, -scaledZ );
 592     positions[5] = Vector3(  scaledX, -scaledY, -scaledZ );
 593     positions[6] = Vector3(  scaledX, -scaledY,  scaledZ );
 594     positions[7] = Vector3( -scaledX, -scaledY,  scaledZ );
 595
 596     normals[0] = Vector3(  0,  1,  0 );
 597     normals[1] = Vector3(  0,  0, -1 );
 598     normals[2] = Vector3(  1,  0,  0 );
 599     normals[3] = Vector3(  0,  0,  1 );
 600     normals[4] = Vector3( -1,  0,  0 );
 601     normals[5] = Vector3(  0, -1,  0 );
 602
 603     // Top face, upward normals.
 604     for( int i = 0; i < 4; ++i, ++vertexIndex )
 605     {
 606       vertices[vertexIndex].position = positions[i];
 607       vertices[vertexIndex].normal = normals[0];
 608       // The below logic forms the correct U/V pairs for a quad when "i" goes from 0 to 3.
 609       vertices[vertexIndex].textureCoord = Vector2( ( i == 1 || i == 2 ) ? 1.0f : 0.0f, ( i == 2 || i == 3 ) ? 1.0f : 0.0f );
 610     }
 611
 612     // Top face, outward normals.
 613     for( int i = 0; i < 4; ++i, vertexIndex += 2 )
 614     {
 615       vertices[vertexIndex].position = positions[i];
 616       vertices[vertexIndex].normal = normals[i + 1];
 617
 618       if( i == 3 )
 619       {
 620         // End, so loop around.
 621         vertices[vertexIndex + 1].position = positions[0];
 622       }
 623       else
 624       {
 625         vertices[vertexIndex + 1].position = positions[i + 1];
 626       }
 627       vertices[vertexIndex + 1].normal = normals[i + 1];
 628
 629       vertices[vertexIndex].textureCoord = Vector2( 0.0f, verticalTextureCoord );
 630       vertices[vertexIndex+1].textureCoord = Vector2( 1.0f, verticalTextureCoord );
 631     }
 632
 633     // Flip the vertical texture coord for the UV values of the bottom points.
 634     verticalTextureCoord = 1.0f - verticalTextureCoord;
 635
 636     // Bottom face, outward normals.
 637     for( int i = 0; i < 4; ++i, vertexIndex += 2 )
 638     {
 639       vertices[vertexIndex].position = positions[i + 4];
 640       vertices[vertexIndex].normal = normals[i + 1];
 641
 642       if( i == 3 )
 643       {
 644         // End, so loop around.
 645         vertices[vertexIndex + 1].position = positions[4];
 646       }
 647       else
 648       {
 649         vertices[vertexIndex + 1].position = positions[i + 5];
 650       }
 651       vertices[vertexIndex + 1].normal = normals[i + 1];
 652
 653       vertices[vertexIndex].textureCoord = Vector2( 0.0f, verticalTextureCoord );
 654       vertices[vertexIndex+1].textureCoord = Vector2( 1.0f, verticalTextureCoord );
 655     }
 656
 657     // Bottom face, downward normals.
 658     for( int i = 0; i < 4; ++i, ++vertexIndex )
 659     {
 660       // Reverse positions for bottom face to keep triangles clockwise (for culling).
 661       vertices[vertexIndex].position = positions[ 7 - i ];
 662       vertices[vertexIndex].normal = normals[5];
 663       // The below logic forms the correct U/V pairs for a quad when "i" goes from 0 to 3.
 664       vertices[vertexIndex].textureCoord = Vector2( ( i == 1 || i == 2 ) ? 1.0f : 0.0f, ( i == 2 || i == 3 ) ? 1.0f : 0.0f );
 665     }
 666
 667     // Create cube indices.
 668     int triangleIndex = 0u;     //Track progress through indices.
 669     indices.Resize( 3u * 12u ); // 3 points x 12 triangles.
 670
 671     // Top face.
 672     indices[triangleIndex] =     0;
 673     indices[triangleIndex + 1] = 1;
 674     indices[triangleIndex + 2] = 2;
 675     indices[triangleIndex + 3] = 2;
 676     indices[triangleIndex + 4] = 3;
 677     indices[triangleIndex + 5] = 0;
 678     triangleIndex += 6;
 679
 680     int topFaceStart = 4u;
 681     int bottomFaceStart = topFaceStart + 8u;
 682
 683     // Side faces.
 684     for( int i = 0; i < 8; i += 2, triangleIndex += 6 )
 685     {
 686       indices[triangleIndex    ] = i + topFaceStart;
 687       indices[triangleIndex + 1] = i + bottomFaceStart + 1;
 688       indices[triangleIndex + 2] = i + topFaceStart + 1;
 689       indices[triangleIndex + 3] = i + topFaceStart;
 690       indices[triangleIndex + 4] = i + bottomFaceStart;
 691       indices[triangleIndex + 5] = i + bottomFaceStart + 1;
 692     }
 693
 694     // Bottom face.
 695     indices[triangleIndex] =     20;
 696     indices[triangleIndex + 1] = 21;
 697     indices[triangleIndex + 2] = 22;
 698     indices[triangleIndex + 3] = 22;
 699     indices[triangleIndex + 4] = 23;
 700     indices[triangleIndex + 5] = 20;
 701
 702     // Use the helper method to create the geometry object.
 703     return CreateTexturedGeometry( vertices, indices );
 704   }
 705
 706   // Signal handlers:
 707
 708   /**
 709    * @brief OnTouch signal handler.
 710    * @param[in] actor The actor that has been touched
 711    * @param[in] touch The touch information
 712    * @return True if the event has been handled
 713    */
 714   bool OnTouch( Actor actor, const TouchData& touch )
 715   {
 716     // Quit the application.
 717     mApplication.Quit();
 718     return true;
 719   }
 720
 721   /**
 722    * @brief OnKeyEvent signal handler.
 723    * @param[in] event The key event information
 724    */
 725   void OnKeyEvent( const KeyEvent& event )
 726   {
 727     if( event.state == KeyEvent::Down )
 728     {
 729       if ( IsKey( event, Dali::DALI_KEY_ESCAPE ) || IsKey( event, Dali::DALI_KEY_BACK ) )
 730       {
 731         mApplication.Quit();
 732       }
 733     }
 734   }
 735
 736 private:
 737
 738   // Member variables:
 739
 740   Application&     mApplication;       ///< The DALi application object
 741   Toolkit::Control mView;              ///< The view used to show the background
 742
 743   Animation        mRotationAnimation; ///< The animation to spin the cube & floor
 744   Animation        mBounceAnimation;   ///< The animation to bounce the cube
 745   Actor            mCubes[2];          ///< The cube object containers
 746 };
 747
 748
 749 /**
 750  * @brief Creates an instance of the example object and runs it.
 751  * @param[in] application The DALi application object
 752  */
 753 void RunExample( Application& application )
 754 {
 755   RendererStencilExample example( application );
 756
 757   application.MainLoop();
 758 }
 759
 760 /**
 761  * @brief Entry point for Linux & Tizen applications
 762  * @param[in] argc The executables argument count
 763  * @param[in] argv The executables argument vector
 764  * @return The executables exit code (0)
 765  */
 766 int DALI_EXPORT_API main( int argc, char **argv )
 767 {
 768   Application application = Application::New( &argc, &argv );
 769
 770   RunExample( application );
 771
 772   return 0;
 773 }