dali-toolkit/internal/controls/bubble-effect/bubble-emitter-impl.cpp

   1 /*
   2  * Copyright (c) 2014 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 // CLASS HEADER
  19 #include "bubble-emitter-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/animation/animation.h>
  23 #include <dali/public-api/render-tasks/render-task-list.h>
  24 #include <dali/public-api/images/resource-image.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/internal/controls/bubble-effect/bubble-actor.h>
  28 #include <dali-toolkit/internal/controls/bubble-effect/color-adjuster.h>
  29 #include <dali-toolkit/internal/controls/bubble-effect/bubble-effect.h>
  30
  31 namespace
  32 {
  33 struct Vertex
  34 {
  35   float index;
  36   Dali::Vector2 position;
  37   Dali::Vector2 textureCoord;
  38
  39   Vertex()
  40   {}
  41
  42   Vertex( float index, const Dali::Vector2& position, const Dali::Vector2& textureCoord )
  43   : index( index ), position( position ), textureCoord( textureCoord )
  44   {}
  45 };
  46
  47 /**
  48  * Return a random value between the given interval.
  49  * @param[in] f0 The low bound
  50  * @param[in] f1 The up bound
  51  * @param[in] seed The seed to genergate random number
  52  * @return A random value between the given interval
  53  */
  54 float RandomRange(float f0, float f1, unsigned int& seed)
  55 {
  56   return f0 + (rand_r( &seed ) & 0xfff) * (f1-f0) * (1.0f/4095.0f);
  57 }
  58
  59 }
  60
  61 namespace Dali
  62 {
  63
  64 namespace Toolkit
  65 {
  66
  67 namespace Internal
  68 {
  69 BubbleEmitter::BubbleEmitter( const Vector2& movementArea,
  70                               Image shapeImage,
  71                               unsigned int maximumNumberOfBubble,
  72                               const Vector2& bubbleSizeRange )
  73 : Control( ControlBehaviour( REQUIRES_TOUCH_EVENTS ) ),
  74   mShapeImage( shapeImage ),
  75   mMovementArea( movementArea ),
  76   mBubbleSizeRange( bubbleSizeRange ),
  77   mDensity( 5 ),
  78   mTotalNumOfBubble( maximumNumberOfBubble ),
  79   mCurrentBubble( 0 ),
  80   mRandomSeed( 0 ),
  81   mRenderTaskRunning(false)
  82 {
  83   // Calculate how many shaders are required
  84   if( mTotalNumOfBubble>100 )
  85   {
  86     mNumBubblePerActor = 100;
  87     mNumActor = mTotalNumOfBubble / 100;
  88     if( mNumActor*mNumBubblePerActor < mTotalNumOfBubble )
  89     {
  90       mNumActor++;
  91       mNumBubblePerActor =  mTotalNumOfBubble / mNumActor+1;
  92       mTotalNumOfBubble = mNumActor * mNumBubblePerActor;
  93     }
  94   }
  95   else
  96   {
  97     mNumBubblePerActor = mTotalNumOfBubble;
  98     mNumActor = 1;
  99   }
 100
 101   mRandomSeed = time( NULL );
 102 }
 103
 104 BubbleEmitter::~BubbleEmitter()
 105 {
 106 }
 107
 108 Toolkit::BubbleEmitter BubbleEmitter::New( const Vector2& winSize,
 109                                            Image shapeImage,
 110                                            unsigned int maximumNumberOfBubble,
 111                                            const Vector2& bubbleSizeRange )
 112 {
 113   // Create the implementation
 114    IntrusivePtr<BubbleEmitter> internalBubbleEmitter ( new BubbleEmitter( winSize, shapeImage,
 115                                                             maximumNumberOfBubble,bubbleSizeRange ) );
 116
 117   // Pass ownership to Toolkit::BubbleEmitter handle
 118   Toolkit::BubbleEmitter bubbleEmitter( *internalBubbleEmitter );
 119
 120   //Second phase of implementeation : Initialization
 121   internalBubbleEmitter->OnInitialize();
 122
 123   return bubbleEmitter;
 124 }
 125
 126 void BubbleEmitter::OnInitialize()
 127 {
 128   // Create the root actor, all the meshActor should be its children
 129   mBubbleRoot = Actor::New();
 130   mBubbleRoot.SetSize(mMovementArea);
 131
 132   // Prepare the frame buffer to store the color adjusted background image
 133   mEffectImage = FrameBufferImage::New( mMovementArea.width/4.f, mMovementArea.height/4.f, Pixel::RGBA8888, Dali::Image::UNUSED );
 134
 135   // Generate the geometry, which is used by all bubbleActors
 136   mMeshGeometry =  CreateGeometry( mNumBubblePerActor*mDensity );
 137
 138   Shader bubbleShader = CreateBubbleShader (mNumBubblePerActor );
 139
 140   mMaterial = Material::New( bubbleShader );
 141   mMaterial.AddTexture( mEffectImage, "sBackground" );
 142   mMaterial.AddTexture( mShapeImage,  "sBubbleShape" );
 143
 144   mBubbleActors.resize( mNumActor );
 145
 146   // Create the meshActor group and bubbleEffect group to emit bubbles following the given track, such as finger touch track.
 147   for(unsigned int i=0; i < mNumActor; i++ )
 148   {
 149     mBubbleActors[i] = new BubbleActor( mNumBubblePerActor, mMovementArea );
 150     (mBubbleActors[i])->MakeRenderable( mMeshGeometry, mMaterial );
 151     mBubbleRoot.Add( (mBubbleActors[i])->GetMeshActor() );
 152   }
 153
 154   // Create a cameraActor for the off screen render task.
 155   mCameraActor = CameraActor::New(mMovementArea);
 156   mCameraActor.SetParentOrigin(ParentOrigin::CENTER);
 157
 158   Stage stage = Stage::GetCurrent();
 159
 160   stage.Add(mCameraActor);
 161   stage.ContextRegainedSignal().Connect(this, &BubbleEmitter::OnContextRegained);
 162 }
 163
 164 Actor BubbleEmitter::GetRootActor()
 165 {
 166   return mBubbleRoot;
 167 }
 168
 169 void BubbleEmitter::SetBackground( Image bgImage, const Vector3& hsvDelta )
 170 {
 171   mBackgroundImage = bgImage;
 172   mHSVDelta = hsvDelta;
 173
 174   ImageActor sourceActor = ImageActor::New( bgImage );
 175   sourceActor.SetSize( mMovementArea );
 176   sourceActor.SetParentOrigin(ParentOrigin::CENTER);
 177   Stage::GetCurrent().Add( sourceActor );
 178
 179   ShaderEffect colorAdjuster = CreateColorAdjuster( hsvDelta, true /*ignore alpha to make bubble color always*/ );
 180   sourceActor.SetShaderEffect( colorAdjuster );
 181
 182   RenderTaskList taskList = Stage::GetCurrent().GetRenderTaskList();
 183   RenderTask task = taskList.CreateTask();
 184   task.SetRefreshRate( RenderTask::REFRESH_ONCE );
 185   task.SetSourceActor( sourceActor );
 186   task.SetExclusive(true);
 187   task.SetCameraActor(mCameraActor);
 188   task.GetCameraActor().SetInvertYAxis(true);
 189   task.SetTargetFrameBuffer( mEffectImage );
 190   task.FinishedSignal().Connect(this, &BubbleEmitter::OnRenderFinished);
 191   mRenderTaskRunning = true;
 192 }
 193
 194 void BubbleEmitter::SetShapeImage( Image shapeImage )
 195 {
 196   mMaterial.SetTextureImage( 1, shapeImage );
 197 }
 198
 199 void BubbleEmitter::SetBubbleScale( float scale )
 200 {
 201   for(unsigned int i=0; i < mNumActor; i++ )
 202   {
 203     (mBubbleActors[i])->SetDynamicScale( scale );
 204   }
 205 }
 206
 207 void BubbleEmitter::SetBubbleDensity( unsigned int density )
 208 {
 209   DALI_ASSERT_ALWAYS( density>0 && density<=9 && " Only densities between 1 to 9 are valid " );
 210
 211   if( density == mDensity )
 212   {
 213     return;
 214   }
 215   else
 216   {
 217     mDensity = density;
 218     mMeshGeometry =  CreateGeometry( mNumBubblePerActor*mDensity );
 219     for(unsigned int i=0; i < mNumActor; i++ )
 220     {
 221       (mBubbleActors[i])->SetGeometry( mMeshGeometry );
 222     }
 223   }
 224 }
 225
 226 void BubbleEmitter::SetBlendMode( bool enable )
 227 {
 228   if(enable)
 229   {
 230     // linear overlay
 231     mMaterial.SetBlendFunc(BlendingFactor::SRC_ALPHA, BlendingFactor::ONE,
 232                            BlendingFactor::ZERO, BlendingFactor::ONE);
 233   }
 234   else
 235   {
 236     // using default blend func
 237     mMaterial.SetBlendFunc( BlendingFactor::SRC_ALPHA,   BlendingFactor::ONE_MINUS_SRC_ALPHA,
 238                             BlendingFactor::ONE, BlendingFactor::ONE_MINUS_SRC_ALPHA );
 239   }
 240 }
 241
 242 // clear the resources created for the off screen rendering
 243 void BubbleEmitter::OnRenderFinished(RenderTask& source)
 244 {
 245   mRenderTaskRunning = false;
 246   Actor sourceActor = source.GetSourceActor();
 247   if( sourceActor )
 248   {
 249     ImageActor renderable = ImageActor::DownCast( sourceActor );
 250     if( renderable )
 251     {
 252       renderable.RemoveShaderEffect();
 253     }
 254   }
 255
 256   Stage stage = Stage::GetCurrent();
 257   stage.Remove(sourceActor);
 258   stage.GetRenderTaskList().RemoveTask(source);
 259 }
 260
 261 void BubbleEmitter::OnContextRegained()
 262 {
 263   // Context was lost, so the framebuffer has been destroyed. Re-create render task
 264   // and trigger re-draw if not already running
 265   if( ! mRenderTaskRunning )
 266   {
 267     SetBackground( mBackgroundImage, mHSVDelta );
 268   }
 269 }
 270
 271 void BubbleEmitter::EmitBubble( Animation& animation, const Vector2& emitPosition, const Vector2& direction, const Vector2& displacement )
 272 {
 273   unsigned int curUniform = mCurrentBubble  % mNumBubblePerActor;
 274   unsigned int groupIdx = mCurrentBubble / mNumBubblePerActor;
 275   SetBubbleParameter( mBubbleActors[groupIdx], curUniform, emitPosition, direction, displacement);
 276   animation.AnimateTo( (mBubbleActors[groupIdx])->GetPercentageProperty(curUniform),
 277                        1.f, AlphaFunction::LINEAR );
 278
 279   mCurrentBubble = (mCurrentBubble + 1) % mTotalNumOfBubble;
 280 }
 281
 282 void BubbleEmitter::Restore()
 283 {
 284   for(unsigned int i=0; i < mNumActor; i++ )
 285   {
 286     (mBubbleActors[i])->ResetProperties();
 287   }
 288 }
 289
 290 Geometry BubbleEmitter::CreateGeometry( unsigned int numOfPatch )
 291 {
 292   unsigned int numVertex = numOfPatch*4u;
 293   std::vector<Vertex> vertexData;
 294   vertexData.reserve( numVertex );
 295
 296   unsigned int numIndex = numOfPatch*6u;
 297   Vector<unsigned int> indexData;
 298   indexData.Reserve( numIndex );
 299
 300   for(unsigned int i = 0; i < numOfPatch; i++)
 301   {
 302     float curSize = RandomRange(mBubbleSizeRange.x, mBubbleSizeRange.y, mRandomSeed);
 303
 304     float index = static_cast<float>( i );
 305     vertexData.push_back( Vertex( index, Vector2(0.f,0.f),         Vector2(0.f,0.f) ) );
 306     vertexData.push_back( Vertex( index, Vector2(0.f,curSize),     Vector2(0.f,1.f)  ) );
 307     vertexData.push_back( Vertex( index, Vector2(curSize,curSize), Vector2(1.f,1.f)  ) );
 308     vertexData.push_back( Vertex( index, Vector2(curSize,0.f),     Vector2(1.f,0.f)  ) );
 309
 310     unsigned int idx = index * 4;
 311     indexData.PushBack( idx );
 312     indexData.PushBack( idx+1 );
 313     indexData.PushBack( idx+2 );
 314     indexData.PushBack( idx );
 315     indexData.PushBack( idx+2 );
 316     indexData.PushBack( idx+3 );
 317   }
 318
 319   Property::Map vertexFormat;
 320   vertexFormat["aIndex"] = Property::FLOAT;
 321   vertexFormat["aPosition"] = Property::VECTOR2;
 322   vertexFormat["aTexCoord"] = Property::VECTOR2;
 323   PropertyBuffer vertices = PropertyBuffer::New( vertexFormat, numVertex  );
 324   vertices.SetData( &vertexData[0] );
 325
 326   Property::Map indexFormat;
 327   indexFormat["indices"] = Property::INTEGER;
 328   PropertyBuffer indices = PropertyBuffer::New( indexFormat, numIndex  );
 329   indices.SetData( &indexData[0] );
 330
 331   Geometry geometry = Geometry::New();
 332   geometry.AddVertexBuffer( vertices );
 333   geometry.SetIndexBuffer( indices );
 334
 335   return geometry;
 336 }
 337
 338 void BubbleEmitter::SetBubbleParameter( BubbleActorPtr bubbleActor, unsigned int curUniform,
 339                                         const Vector2& emitPosition, const Vector2& direction, const Vector2& displacement )
 340 {
 341   Vector2 dir(direction);
 342
 343   int halfRange = displacement.x / 2;
 344   // for the y coordinate, always negative, so bubbles always go upwards
 345   Vector2 randomVec( rand_r( &mRandomSeed ) % static_cast<int>(displacement.x) - halfRange, -rand_r( &mRandomSeed ) % static_cast<int>(displacement.y) );
 346   dir.Normalize();
 347   randomVec.x -= dir.x*halfRange;
 348   randomVec.y *= 1.0f - fabsf(dir.x)*0.33f;
 349
 350   if(randomVec.y > 0.0f)
 351   {
 352     randomVec.y *= 0.33f;
 353   }
 354   Vector4 startAndEndPos( emitPosition.x, emitPosition.y, emitPosition.x+randomVec.x, emitPosition.y+randomVec.y );
 355   bubbleActor->SetStartAndEndPosition( curUniform, startAndEndPos );
 356
 357   bubbleActor->SetPercentage( curUniform, 0.f);
 358 }
 359
 360 } // namespace Internal
 361
 362 } // namespace Toolkit
 363
 364 } // namespace Dali