dali-toolkit/devel-api/shader-effects/motion-stretch-effect.h

   1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_MOTION_STRETCH_H__
   2 #define __DALI_TOOLKIT_SHADER_EFFECT_MOTION_STRETCH_H__
   3
   4 /*
   5  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/actors/actor.h>
  23 #include <dali/public-api/animation/constraint.h>
  24 #include <dali/public-api/object/property-map.h>
  25 #include <dali/public-api/rendering/shader.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali-toolkit/public-api/visuals/visual-properties.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 /**
  37  * @brief Set the properties for the motion stretch
  38  */
  39 inline void SetMotionStretchProperties( Actor& actor )
  40 {
  41   actor.RegisterProperty( "uGeometryStretchFactor", 0.5f );
  42   actor.RegisterProperty( "uSpeedScalingFactor", 0.5f );
  43   actor.RegisterProperty( "uObjectFadeStart", Vector2( 0.25f, 0.25f ) );
  44   actor.RegisterProperty( "uObjectFadeEnd", Vector2( 0.5f, 0.5f ) );
  45   actor.RegisterProperty( "uAlphaScale", 0.75f );
  46   Property::Index uModelProperty = actor.RegisterProperty( "uModelLastFrame", Matrix::IDENTITY );
  47
  48   Constraint constraint = Constraint::New<Matrix>( actor, uModelProperty, EqualToConstraint() );
  49   constraint.AddSource( Source( actor , Actor::Property::WORLD_MATRIX ) );
  50   constraint.Apply();
  51 }
  52
  53 /**
  54  * @brief Creates a new MotionStretchEffect
  55  *
  56  * Motion stretch shader works on a per object basis. Objects will stretch in the direction of motion when they move, or if the camera moves.
  57  *
  58  * Animatable/Constrainable uniforms:
  59  *  "uGeometryStretchFactor"  - This scales the amount the geometry stretches along the motion velocity vector.
  60  *                              A smaller value means the geometry stretches less, larger it stretches more. Default 0.5.
  61  *  "uSpeedScalingFactor"     - This value is used to control how much to fade the actor near the edges, based on the
  62  *                              speed the actor is moving. When the actor is at rest this is not applied. Default 0.5.
  63  *  "uObjectFadeStart"        - The displacement from the centre of the actor that the actor will start to fade towards
  64  *                              its edges. This is used to prevent an unsightly hard edge between the stretched actor and
  65  *                              the scene. Depends on the values of the vertices in the vertex stream. When the actor is at
  66  *                              rest this is not applied. Default Vector2(0.25, 0.25), which is half way towards the edge for
  67  *                              an ImageVisual::QUAD.
  68  *  "uObjectFadeEnd"          - The displacement from the centre of the actor that the actor will finish fading towards its edges.
  69  *                              This is used to prevent an unsightly hard edge between the stretched actor and the scene. Depends
  70  *                              on the values of the vertices in the vertex stream. When the actor is at rest this is not applied.
  71  *                              Default 0.5, which is all the way towards the edge for an ImageVisual::QUAD.
  72  *  "uAlphaScale"             - Global scaler applied to the alpha of the actor. Used to make the stretched actor a bit more subtle
  73  *                              and reveal a bit of the background behind it as it moves. When the actor is at rest this is not
  74  *                              applied. Default 0.75.
  75  *  "uModelLastFrame"         - The model to world space transformation matrix of the actor in the previous frame.
  76  *
  77  * @return The newly created Property::Map with the motion stretch effect
  78  */
  79 inline Property::Map CreateMotionStretchEffect()
  80 {
  81   std::string vertexSource;
  82   vertexSource =
  83       "precision mediump float;\n"
  84
  85       "attribute vec2 aPosition;\n"
  86
  87       "uniform mat4 uMvpMatrix;\n"
  88       "uniform mat4 uModelView;\n"
  89       "uniform mat4 uViewMatrix;\n"
  90       "uniform mat4 uProjection;\n"
  91       "uniform vec3 uSize;\n"
  92
  93       "uniform mat4  uModelLastFrame;\n"
  94       "float timeDelta = 0.0167;\n"
  95
  96       "uniform float uGeometryStretchFactor;\n"
  97       "uniform float uSpeedScalingFactor;\n"
  98
  99       // outputs
 100       "varying vec2 vModelSpaceCenterToPos;\n"
 101       "varying vec2 vScreenSpaceVelocityVector;\n"
 102       "varying float vSpeed;\n"
 103       "varying vec2 vTexCoord;\n"
 104
 105       "void main()\n"
 106       "{\n"
 107       // get view space position of vertex this frame and last frame
 108       " vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n"
 109       " vertexPosition.xyz *= uSize;\n"
 110
 111       " vec4 viewSpaceVertex = uModelView * vertexPosition;\n"
 112       " vec4 viewSpaceVertexLastFrame = uViewMatrix * uModelLastFrame * vertexPosition;\n"
 113
 114       // work out vertex's last movement in view space
 115       " vec3 viewSpacePosDelta = viewSpaceVertex.xyz - viewSpaceVertexLastFrame.xyz;\n"
 116       " float reciprocalTimeDelta = 1.0 / timeDelta;\n"
 117
 118       // get clip space position of vertex this frame and last frame
 119       " vec4 clipSpaceVertex = uMvpMatrix * vertexPosition;\n"
 120       " vec4 clipSpaceVertexLastFrame = uProjection * viewSpaceVertexLastFrame;\n"
 121
 122       // decide how much this vertex is 'trailing', i.e. at the back of the object relative to its direction of motion. We do this
 123       // 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
 124       " float t = 0.0;\n"
 125       " float posDeltaLength = length(viewSpacePosDelta);\n"
 126       " if(posDeltaLength > 0.001)\n" // avoid div by 0 if object has barely moved
 127       " {\n"
 128       "   vec4 viewSpaceCenterToPos = uModelView * vec4(aPosition, 0.0, 0.0);\n"
 129       "   float centerToVertexDist = length(viewSpaceCenterToPos);\n"
 130       "   if(centerToVertexDist > 0.001)\n" // avoid div by 0 if object has vertex at model space origin
 131       "   {\n"
 132       "     vec3 viewSpacePosDeltaNormalised = viewSpacePosDelta / posDeltaLength;\n"
 133       "     vec3 viewSpaceCenterToPosNormalised = viewSpaceCenterToPos.xyz / centerToVertexDist;\n"
 134       "     t = (dot(viewSpacePosDeltaNormalised, viewSpaceCenterToPosNormalised) * 0.5 ) + 0.5;\n" // scale and bias from [-1..1] to [0..1]
 135       "   }\n"
 136       " }\n"
 137       // output vertex position lerped with its last position, based on how much it is trailing,
 138       // this stretches the geom back along where it has just been, giving a warping effect
 139       // We raise t to a power in order that non-trailing vertices are effected much more than trailing ones
 140       // 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)
 141       " gl_Position = mix(clipSpaceVertexLastFrame, clipSpaceVertex, t * t * t * uGeometryStretchFactor * reciprocalTimeDelta);\n"
 142
 143       // work out vertex's last movement in normalised device coordinates [-1..1] space, i.e. perspective divide
 144       " vec2 ndcVertex = clipSpaceVertex.xy / clipSpaceVertex.w;\n"
 145       " vec2 ndcVertexLastFrame = clipSpaceVertexLastFrame.xy / clipSpaceVertexLastFrame.w;\n"
 146       // scale and bias so that a value of 1.0 corresponds to screen size (NDC is [-1..1] = 2)
 147       " vScreenSpaceVelocityVector = ((ndcVertex - ndcVertexLastFrame) * 0.5 * reciprocalTimeDelta);\n"
 148       " vScreenSpaceVelocityVector.y = -vScreenSpaceVelocityVector.y;\n" // TODO negated due to y being inverted in our coordinate system?
 149       // calculate a scaling factor proportional to velocity, which we can use to tweak how things look
 150       " vSpeed = length(vScreenSpaceVelocityVector) * uSpeedScalingFactor;\n"
 151       " vSpeed = clamp(vSpeed, 0.0, 1.0);\n"
 152
 153       // 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)
 154       " vModelSpaceCenterToPos = viewSpaceVertex.xy;\n"
 155
 156       " vec2 texCoord = aPosition + vec2(0.5);"
 157       " vTexCoord = texCoord;\n"
 158       "}\n";
 159
 160   std::string fragmentSource;
 161   fragmentSource =
 162       "precision mediump float;\n"
 163
 164       "uniform sampler2D sTexture;\n"
 165       "uniform vec4 uColor;\n"
 166
 167       "uniform vec2 uObjectFadeStart;\n"
 168       "uniform vec2 uObjectFadeEnd;\n"
 169       "uniform float uAlphaScale;\n"
 170
 171       // inputs
 172       "varying vec2 vModelSpaceCenterToPos;\n"
 173       "varying vec2 vScreenSpaceVelocityVector;\n"
 174       "varying float vSpeed;\n"
 175       "varying vec2 vTexCoord;\n"
 176
 177       "void main()\n"
 178       "{\n"
 179       // 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
 180       // the stretched object and the background. Use smoothstep also to hide any hard edges (discontinuities) in rate of change of this alpha gradient
 181       " vec2 centerToPixel = abs( vModelSpaceCenterToPos );\n"
 182       " vec2 fadeToEdges = smoothstep(0.0, 1.0, 1.0 - ((centerToPixel - uObjectFadeStart) / (uObjectFadeEnd - uObjectFadeStart)));\n"
 183       " float fadeToEdgesScale = fadeToEdges.x * fadeToEdges.y * uAlphaScale;\n" // apply global scaler
 184       " fadeToEdgesScale = mix(1.0, fadeToEdgesScale, vSpeed);\n" // fade proportional to speed, so opaque when at rest
 185
 186       // standard actor texel
 187       " vec4 colActor = texture2D(sTexture, vTexCoord);\n"
 188       " gl_FragColor = colActor;\n"
 189       " gl_FragColor.a *= fadeToEdgesScale;\n" // fade actor to its edges based on speed of motion
 190       " gl_FragColor *= uColor;\n"
 191       "}";
 192
 193   Property::Map map;
 194
 195   Property::Map customShader;
 196   customShader[ Visual::Shader::Property::VERTEX_SHADER ] = vertexSource;
 197   customShader[ Visual::Shader::Property::FRAGMENT_SHADER ] = fragmentSource;
 198
 199   customShader[ Visual::Shader::Property::SUBDIVIDE_GRID_X ] = 10;
 200   customShader[ Visual::Shader::Property::SUBDIVIDE_GRID_Y ] = 10;
 201
 202   customShader[ Visual::Shader::Property::HINTS ] = Shader::Hint::OUTPUT_IS_TRANSPARENT;
 203
 204   map[ Toolkit::Visual::Property::SHADER ] = customShader;
 205   return map;
 206 }
 207
 208 }
 209
 210 }
 211
 212 #endif //#ifndef __DALI_TOOLKIT_SHADER_EFFECT_MOTION_STRETCH_H__