optional/dali-toolkit/public-api/shader-effects/motion-stretch-effect.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 <dali-toolkit/public-api/shader-effects/motion-stretch-effect.h>
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/animation/constraints.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace
  31 {
  32
  33 struct MatrixFromPropertiesConstraint
  34 {
  35   MatrixFromPropertiesConstraint()
  36   {
  37   }
  38
  39   Matrix operator()( const Matrix& current,
  40                      const PropertyInput& propertyPosition,
  41                      const PropertyInput& propertyOrientation,
  42                      const PropertyInput& propertyScale )
  43   {
  44     Matrix mat4( false );
  45     mat4.SetTransformComponents( propertyScale.GetVector3(),
  46                                  propertyOrientation.GetQuaternion(),
  47                                  propertyPosition.GetVector3() );
  48
  49     return mat4;
  50   }
  51 };
  52
  53 const std::string MOTION_STRETCH_GEOMETRY_STRETCH_SCALING_FACTOR_PROPERTY_NAME( "uGeometryStretchFactor" );
  54 const std::string MOTION_STRETCH_SPEED_SCALING_FACTOR_PROPERTY_NAME( "uSpeedScalingFactor" );
  55 const std::string MOTION_STRETCH_OBJECT_FADE_START_PROPERTY_NAME( "uObjectFadeStart" );
  56 const std::string MOTION_STRETCH_OBJECT_FADE_END_PROPERTY_NAME( "uObjectFadeEnd" );
  57 const std::string MOTION_STRETCH_ALPHA_SCALE_PROPERTY_NAME( "uAlphaScale" );
  58 const std::string MOTION_STRETCH_MODELVIEW_LASTFRAME( "uModelLastFrame" );  ///< Matrix
  59
  60 ////////////////////////////////////////////////////
  61 //
  62 // Motion stretch shader / actor tweaking parameters
  63 //
  64
  65 // half width and half height respectively of actor, corresponding to values in vertex attribute stream
  66 // Note that these values work for normal image actor (verts +/- 0.5) but a grid or a nine square seemsi
  67 // to have verts in pixel space (e.g. 256,256). Need to fix this somehow,
  68 // either in Dali or by passing uniforms which we can use to 'normalise' the verts in the vertex shader
  69 const Vector2 MOTION_STRETCH_ACTOR_VERTEX( 0.5f, 0.5f );
  70
  71 const float MOTION_STRETCH_GEOM_STRETCH_SCALING_FACTOR = 0.5f; // scaling factor for how much to stretch actor geom as it moves
  72 const float MOTION_STRETCH_SPEED_SCALING_FACTOR = 0.5f;        // scales the speed, producing a number affecting how much the actor stretches & fades at the edges
  73
  74 const Vector2 MOTION_STRETCH_OBJECT_FADE_END( MOTION_STRETCH_ACTOR_VERTEX );             // displacement from center at which actor fully fades to zero alpha
  75 const Vector2 MOTION_STRETCH_OBJECT_FADE_START( MOTION_STRETCH_OBJECT_FADE_END * 0.5f ); // displacement from center at which actor start to fade from full alpha
  76
  77 const float MOTION_STRETCH_ALPHA_SCALE = 0.75f; // global scaler applied to actor alpha as it is stretched + moving
  78
  79 } // namespace
  80
  81
  82 MotionStretchEffect::MotionStretchEffect()
  83 {
  84 }
  85
  86 // Call the Parent copy constructor to add reference to the implementation for this object
  87 MotionStretchEffect::MotionStretchEffect( ShaderEffect handle )
  88 :ShaderEffect( handle )
  89 {
  90 }
  91
  92 MotionStretchEffect::~MotionStretchEffect()
  93 {
  94 }
  95
  96 MotionStretchEffect MotionStretchEffect::Apply( RenderableActor renderable )
  97 {
  98   MotionStretchEffect newEffect = New();
  99   renderable.SetShaderEffect( newEffect );
 100
 101   Property::Index uModelProperty = newEffect.GetPropertyIndex( MOTION_STRETCH_MODELVIEW_LASTFRAME );
 102
 103   Constraint constraint = Constraint::New<Matrix>( uModelProperty,
 104                                                    Source( renderable, Actor::WORLD_MATRIX ),
 105                                                    EqualToConstraint() );
 106
 107   // and set up constraint.
 108   newEffect.ApplyConstraint(constraint);
 109   return newEffect;
 110 }
 111
 112 MotionStretchEffect MotionStretchEffect::New()
 113 {
 114   // Dali vertexSource prefix for reference:
 115   // precision highp float;
 116   // attribute vec3  aPosition;
 117   // attribute vec2  aTexCoord;
 118   // uniform   mat4  uMvpMatrix;
 119   // uniform   mat4  uModelView;
 120   // uniform   mat3  uNormalMatrix;
 121   // uniform   mat4  uProjection;
 122   // uniform   vec4  uColor;
 123   // varying   vec2  vTexCoord;
 124   std::string vertexSource;
 125   vertexSource =
 126     "uniform mat4  uModelLastFrame;\n"
 127     "uniform float uTimeDelta;\n"
 128
 129     "uniform float uGeometryStretchFactor;\n"
 130     "uniform float uSpeedScalingFactor;\n"
 131
 132     // outputs
 133     "varying vec2 vModelSpaceCenterToPos;\n"
 134     "varying vec2 vScreenSpaceVelocityVector;\n"
 135     "varying float vSpeed;\n"
 136
 137     "void main()\n"
 138     "{\n"
 139     // get view space position of vertex this frame and last frame
 140     " vec4 vertex = vec4(aPosition, 1.0);\n"
 141     " vec4 viewSpaceVertex = uModelView * vertex;\n"
 142     " vec4 viewSpaceVertexLastFrame = uViewMatrix * uModelLastFrame * vertex;\n"
 143
 144     // work out vertex's last movement in view space
 145     " vec3 viewSpacePosDelta = viewSpaceVertex.xyz - viewSpaceVertexLastFrame.xyz;\n"
 146     " float reciprocalTimeDelta = 1.0 / ((uTimeDelta > 0.0) ? uTimeDelta : 0.01);\n"
 147
 148     // get clip space position of vertex this frame and last frame
 149     " vec4 clipSpaceVertex = uMvpMatrix * vertex;\n"
 150     " vec4 clipSpaceVertexLastFrame = uProjection * viewSpaceVertexLastFrame;\n"
 151
 152     // decide how much this vertex is 'trailing', i.e. at the back of the object relative to its direction of motion. We do this
 153     // by assuming the objects model space origin is at its center and taking the dot product of the vector from center to vertex with the motion direction
 154     " float t = 0.0;\n"
 155     " float posDeltaLength = length(viewSpacePosDelta);\n"
 156     " if(posDeltaLength > 0.001)\n" // avoid div by 0 if object has barely moved
 157     " {\n"
 158     "   vec4 viewSpaceCenterToPos = uModelView * vec4(aPosition, 0.0);\n"
 159     "   float centerToVertexDist = length(viewSpaceCenterToPos);\n"
 160     "   if(centerToVertexDist > 0.001)\n" // avoid div by 0 if object has vertex at model space origin
 161     "   {\n"
 162     "     vec3 viewSpacePosDeltaNormalised = viewSpacePosDelta / posDeltaLength;\n"
 163     "     vec3 viewSpaceCenterToPosNormalised = viewSpaceCenterToPos.xyz / centerToVertexDist;\n"
 164     "     t = (dot(viewSpacePosDeltaNormalised, viewSpaceCenterToPosNormalised) * 0.5 ) + 0.5;\n" // scale and bias from [-1..1] to [0..1]
 165     "   }\n"
 166     " }\n"
 167     // output vertex position lerped with its last position, based on how much it is trailing,
 168     // this stretches the geom back along where it has just been, giving a warping effect
 169     // We raise t to a power in order that non-trailing vertices are effected much more than trailing ones
 170     // Note: we must take account of time delta to convert position delta into a velocity, so changes are smooth (take into account frame time correctly)
 171     " gl_Position = mix(clipSpaceVertexLastFrame, clipSpaceVertex, t * t * t * uGeometryStretchFactor * reciprocalTimeDelta);\n"
 172
 173     // work out vertex's last movement in normalised device coordinates [-1..1] space, i.e. perspective divide
 174     " vec2 ndcVertex = clipSpaceVertex.xy / clipSpaceVertex.w;\n"
 175     " vec2 ndcVertexLastFrame = clipSpaceVertexLastFrame.xy / clipSpaceVertexLastFrame.w;\n"
 176     // scale and bias so that a value of 1.0 corresponds to screen size (NDC is [-1..1] = 2)
 177     " vScreenSpaceVelocityVector = ((ndcVertex - ndcVertexLastFrame) * 0.5 * reciprocalTimeDelta);\n"
 178     " vScreenSpaceVelocityVector.y = -vScreenSpaceVelocityVector.y;\n" // TODO negated due to y being inverted in our coordinate system?
 179     // calculate a scaling factor proportional to velocity, which we can use to tweak how things look
 180     " vSpeed = length(vScreenSpaceVelocityVector) * uSpeedScalingFactor;\n"
 181     " vSpeed = clamp(vSpeed, 0.0, 1.0);\n"
 182
 183     // provide fragment shader with vector from center of object to pixel (assumes the objects model space origin is at its center and verts have same z)
 184     " vModelSpaceCenterToPos = aPosition.xy;\n"
 185
 186     " vTexCoord = aTexCoord;\n"
 187     "}\n";
 188
 189
 190   // Dali fragmentSource prefix for reference:
 191   // precision highp     float;
 192   // uniform   sampler2D sTexture;
 193   // uniform   sampler2D sEffect;
 194   // uniform   vec4      uColor;
 195   // varying   vec2      vTexCoord;
 196   std::string fragmentSource;
 197   fragmentSource =
 198     "precision mediump float;\n"
 199
 200     "uniform vec2 uObjectFadeStart;\n"
 201     "uniform vec2 uObjectFadeEnd;\n"
 202     "uniform float uAlphaScale;\n"
 203
 204     // inputs
 205     "varying vec2 vModelSpaceCenterToPos;\n"
 206     "varying vec2 vScreenSpaceVelocityVector;\n"
 207     "varying float vSpeed;\n"
 208
 209     "void main()\n"
 210     "{\n"
 211     // calculate an alpha value that will fade the object towards its extremities, we need this to avoid an unsightly hard edge between color values of
 212     // the stretched object and the background. Use smoothstep also to hide any hard edges (discontinuities) in rate of change of this alpha gradient
 213     " vec2 centerToPixel = abs( vModelSpaceCenterToPos );\n"
 214     " vec2 fadeToEdges = smoothstep(0.0, 1.0, 1.0 - ((centerToPixel - uObjectFadeStart) / (uObjectFadeEnd - uObjectFadeStart)));\n"
 215     " float fadeToEdgesScale = fadeToEdges.x * fadeToEdges.y * uAlphaScale;\n" // apply global scaler
 216     " fadeToEdgesScale = mix(1.0, fadeToEdgesScale, vSpeed);\n" // fade proportional to speed, so opaque when at rest
 217
 218     // standard actor texel
 219     " vec4 colActor = texture2D(sTexture, vTexCoord);\n"
 220     " gl_FragColor = colActor;\n"
 221     " gl_FragColor.a *= fadeToEdgesScale;\n" // fade actor to its edges based on speed of motion
 222     " gl_FragColor *= uColor;\n"
 223     "}";
 224
 225   // NOTE: we must turn on alpha blending for the actor (HINT_BLENDING)
 226   ShaderEffect shader = ShaderEffect::New( vertexSource,
 227                                            fragmentSource,
 228                                            GeometryType( GEOMETRY_TYPE_IMAGE ),
 229                                            ShaderEffect::GeometryHints( ShaderEffect::HINT_BLENDING | ShaderEffect::HINT_GRID ) );
 230
 231
 232
 233   MotionStretchEffect handle( shader );
 234
 235
 236   //////////////////////////////////////
 237   // Register uniform properties
 238   //
 239   //
 240
 241   // factors that scale the look, defaults
 242   handle.SetUniform( MOTION_STRETCH_GEOMETRY_STRETCH_SCALING_FACTOR_PROPERTY_NAME, MOTION_STRETCH_GEOM_STRETCH_SCALING_FACTOR );
 243   handle.SetUniform( MOTION_STRETCH_SPEED_SCALING_FACTOR_PROPERTY_NAME, MOTION_STRETCH_SPEED_SCALING_FACTOR );
 244   handle.SetUniform( MOTION_STRETCH_OBJECT_FADE_START_PROPERTY_NAME, MOTION_STRETCH_OBJECT_FADE_START );
 245   handle.SetUniform( MOTION_STRETCH_OBJECT_FADE_END_PROPERTY_NAME, MOTION_STRETCH_OBJECT_FADE_END );
 246   handle.SetUniform( MOTION_STRETCH_ALPHA_SCALE_PROPERTY_NAME, MOTION_STRETCH_ALPHA_SCALE );
 247   handle.SetUniform( MOTION_STRETCH_MODELVIEW_LASTFRAME, Matrix::IDENTITY );
 248
 249   return handle;
 250 }
 251
 252 void MotionStretchEffect::SetGeometryStretchFactor( float scalingFactor )
 253 {
 254   SetUniform( MOTION_STRETCH_GEOMETRY_STRETCH_SCALING_FACTOR_PROPERTY_NAME, scalingFactor );
 255 }
 256
 257 void MotionStretchEffect::SetSpeedScalingFactor( float scalingFactor )
 258 {
 259   SetUniform( MOTION_STRETCH_SPEED_SCALING_FACTOR_PROPERTY_NAME, scalingFactor );
 260 }
 261
 262 void MotionStretchEffect::SetObjectFadeStart( Vector2 displacement )
 263 {
 264   SetUniform( MOTION_STRETCH_OBJECT_FADE_START_PROPERTY_NAME, displacement );
 265 }
 266
 267 void MotionStretchEffect::SetObjectFadeEnd( Vector2 displacement )
 268 {
 269   SetUniform( MOTION_STRETCH_OBJECT_FADE_END_PROPERTY_NAME, displacement );
 270 }
 271
 272 void MotionStretchEffect::SetAlphaScale( float alphaScale )
 273 {
 274   SetUniform( MOTION_STRETCH_ALPHA_SCALE_PROPERTY_NAME, alphaScale );
 275 }
 276
 277 const std::string& MotionStretchEffect::GetGeometryStretchFactorPropertyName() const
 278 {
 279   return MOTION_STRETCH_GEOMETRY_STRETCH_SCALING_FACTOR_PROPERTY_NAME;
 280 }
 281
 282 const std::string& MotionStretchEffect::GetSpeedScalingFactorPropertyName() const
 283 {
 284   return MOTION_STRETCH_SPEED_SCALING_FACTOR_PROPERTY_NAME;
 285 }
 286
 287 const std::string& MotionStretchEffect::GetObjectFadeStartPropertyName() const
 288 {
 289   return MOTION_STRETCH_OBJECT_FADE_START_PROPERTY_NAME;
 290 }
 291
 292 const std::string& MotionStretchEffect::GetObjectFadeEndPropertyName() const
 293 {
 294   return MOTION_STRETCH_OBJECT_FADE_END_PROPERTY_NAME;
 295 }
 296
 297 const std::string& MotionStretchEffect::GetAlphaScalePropertyName() const
 298 {
 299   return MOTION_STRETCH_ALPHA_SCALE_PROPERTY_NAME;
 300 }
 301
 302 }
 303
 304 }
 305