1 #ifndef __DALI_TOOLKIT_SHADER_EFFECT_MOTION_STRETCH_H__
2 #define __DALI_TOOLKIT_SHADER_EFFECT_MOTION_STRETCH_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/shader-effects/shader-effect.h>
31 * @brief Set the properties for the motion stretch
33 inline void SetMotionStretchProperties( Actor& actor )
35 actor.RegisterProperty( "uGeometryStretchFactor", 0.5f );
36 actor.RegisterProperty( "uSpeedScalingFactor", 0.5f );
37 actor.RegisterProperty( "uObjectFadeStart", Vector2( 0.25f, 0.25f ) );
38 actor.RegisterProperty( "uObjectFadeEnd", Vector2( 0.5f, 0.5f ) );
39 actor.RegisterProperty( "uAlphaScale", 0.75f );
40 Property::Index uModelProperty = actor.RegisterProperty( "uModelLastFrame", Matrix::IDENTITY );
42 Constraint constraint = Constraint::New<Matrix>( actor, uModelProperty, EqualToConstraint() );
43 constraint.AddSource( Source( actor , Actor::Property::WORLD_MATRIX ) );
48 * @brief Creates a new MotionStretchEffect
50 * 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.
52 * Animatable/Constrainable uniforms:
53 * "uGeometryStretchFactor" - This scales the amount the geometry stretches along the motion velocity vector.
54 * A smaller value means the geometry stretches less, larger it stretches more. Default 0.5.
55 * "uSpeedScalingFactor" - This value is used to control how much to fade the actor near the edges, based on the
56 * speed the actor is moving. When the actor is at rest this is not applied. Default 0.5.
57 * "uObjectFadeStart" - The displacement from the centre of the actor that the actor will start to fade towards
58 * its edges. This is used to prevent an unsightly hard edge between the stretched actor and
59 * the scene. Depends on the values of the vertices in the vertex stream. When the actor is at
60 * rest this is not applied. Default Vector2(0.25, 0.25), which is half way towards the edge for
61 * an ImageVisual::QUAD.
62 * "uObjectFadeEnd" - The displacement from the centre of the actor that the actor will finish fading towards its edges.
63 * This is used to prevent an unsightly hard edge between the stretched actor and the scene. Depends
64 * on the values of the vertices in the vertex stream. When the actor is at rest this is not applied.
65 * Default 0.5, which is all the way towards the edge for an ImageVisual::QUAD.
66 * "uAlphaScale" - Global scaler applied to the alpha of the actor. Used to make the stretched actor a bit more subtle
67 * and reveal a bit of the background behind it as it moves. When the actor is at rest this is not
68 * applied. Default 0.75.
69 * "uModelLastFrame" - The model to world space transformation matrix of the actor in the previous frame.
71 * @return The newly created Property::Map with the motion stretch effect
73 inline Property::Map CreateMotionStretchEffect()
75 std::string vertexSource;
77 "precision mediump float;\n"
79 "attribute vec2 aPosition;\n"
81 "uniform mat4 uMvpMatrix;\n"
82 "uniform mat4 uModelView;\n"
83 "uniform mat4 uViewMatrix;\n"
84 "uniform mat4 uProjection;\n"
85 "uniform vec3 uSize;\n"
87 "uniform mat4 uModelLastFrame;\n"
88 "float timeDelta = 0.0167;\n"
90 "uniform float uGeometryStretchFactor;\n"
91 "uniform float uSpeedScalingFactor;\n"
94 "varying vec2 vModelSpaceCenterToPos;\n"
95 "varying vec2 vScreenSpaceVelocityVector;\n"
96 "varying float vSpeed;\n"
97 "varying vec2 vTexCoord;\n"
101 // get view space position of vertex this frame and last frame
102 " vec4 vertexPosition = vec4(aPosition, 0.0, 1.0);\n"
103 " vertexPosition.xyz *= uSize;\n"
105 " vec4 viewSpaceVertex = uModelView * vertexPosition;\n"
106 " vec4 viewSpaceVertexLastFrame = uViewMatrix * uModelLastFrame * vertexPosition;\n"
108 // work out vertex's last movement in view space
109 " vec3 viewSpacePosDelta = viewSpaceVertex.xyz - viewSpaceVertexLastFrame.xyz;\n"
110 " float reciprocalTimeDelta = 1.0 / timeDelta;\n"
112 // get clip space position of vertex this frame and last frame
113 " vec4 clipSpaceVertex = uMvpMatrix * vertexPosition;\n"
114 " vec4 clipSpaceVertexLastFrame = uProjection * viewSpaceVertexLastFrame;\n"
116 // decide how much this vertex is 'trailing', i.e. at the back of the object relative to its direction of motion. We do this
117 // 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
119 " float posDeltaLength = length(viewSpacePosDelta);\n"
120 " if(posDeltaLength > 0.001)\n" // avoid div by 0 if object has barely moved
122 " vec4 viewSpaceCenterToPos = uModelView * vec4(aPosition, 0.0, 0.0);\n"
123 " float centerToVertexDist = length(viewSpaceCenterToPos);\n"
124 " if(centerToVertexDist > 0.001)\n" // avoid div by 0 if object has vertex at model space origin
126 " vec3 viewSpacePosDeltaNormalised = viewSpacePosDelta / posDeltaLength;\n"
127 " vec3 viewSpaceCenterToPosNormalised = viewSpaceCenterToPos.xyz / centerToVertexDist;\n"
128 " t = (dot(viewSpacePosDeltaNormalised, viewSpaceCenterToPosNormalised) * 0.5 ) + 0.5;\n" // scale and bias from [-1..1] to [0..1]
131 // output vertex position lerped with its last position, based on how much it is trailing,
132 // this stretches the geom back along where it has just been, giving a warping effect
133 // We raise t to a power in order that non-trailing vertices are effected much more than trailing ones
134 // 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)
135 " gl_Position = mix(clipSpaceVertexLastFrame, clipSpaceVertex, t * t * t * uGeometryStretchFactor * reciprocalTimeDelta);\n"
137 // work out vertex's last movement in normalised device coordinates [-1..1] space, i.e. perspective divide
138 " vec2 ndcVertex = clipSpaceVertex.xy / clipSpaceVertex.w;\n"
139 " vec2 ndcVertexLastFrame = clipSpaceVertexLastFrame.xy / clipSpaceVertexLastFrame.w;\n"
140 // scale and bias so that a value of 1.0 corresponds to screen size (NDC is [-1..1] = 2)
141 " vScreenSpaceVelocityVector = ((ndcVertex - ndcVertexLastFrame) * 0.5 * reciprocalTimeDelta);\n"
142 " vScreenSpaceVelocityVector.y = -vScreenSpaceVelocityVector.y;\n" // TODO negated due to y being inverted in our coordinate system?
143 // calculate a scaling factor proportional to velocity, which we can use to tweak how things look
144 " vSpeed = length(vScreenSpaceVelocityVector) * uSpeedScalingFactor;\n"
145 " vSpeed = clamp(vSpeed, 0.0, 1.0);\n"
147 // 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)
148 " vModelSpaceCenterToPos = viewSpaceVertex.xy;\n"
150 " vec2 texCoord = aPosition + vec2(0.5);"
151 " vTexCoord = texCoord;\n"
154 std::string fragmentSource;
156 "precision mediump float;\n"
158 "uniform sampler2D sTexture;\n"
159 "uniform vec4 uColor;\n"
161 "uniform vec2 uObjectFadeStart;\n"
162 "uniform vec2 uObjectFadeEnd;\n"
163 "uniform float uAlphaScale;\n"
166 "varying vec2 vModelSpaceCenterToPos;\n"
167 "varying vec2 vScreenSpaceVelocityVector;\n"
168 "varying float vSpeed;\n"
169 "varying vec2 vTexCoord;\n"
173 // 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
174 // the stretched object and the background. Use smoothstep also to hide any hard edges (discontinuities) in rate of change of this alpha gradient
175 " vec2 centerToPixel = abs( vModelSpaceCenterToPos );\n"
176 " vec2 fadeToEdges = smoothstep(0.0, 1.0, 1.0 - ((centerToPixel - uObjectFadeStart) / (uObjectFadeEnd - uObjectFadeStart)));\n"
177 " float fadeToEdgesScale = fadeToEdges.x * fadeToEdges.y * uAlphaScale;\n" // apply global scaler
178 " fadeToEdgesScale = mix(1.0, fadeToEdgesScale, vSpeed);\n" // fade proportional to speed, so opaque when at rest
180 // standard actor texel
181 " vec4 colActor = texture2D(sTexture, vTexCoord);\n"
182 " gl_FragColor = colActor;\n"
183 " gl_FragColor.a *= fadeToEdgesScale;\n" // fade actor to its edges based on speed of motion
184 " gl_FragColor *= uColor;\n"
189 Property::Map customShader;
190 customShader[ "vertexShader" ] = vertexSource;
191 customShader[ "fragmentShader" ] = fragmentSource;
193 customShader[ "subdivideGridX" ] = 10;
194 customShader[ "subdivideGridY" ] = 10;
196 // NOTE: we must turn on alpha blending for the actor (HINT_BLENDING)
197 customShader[ "hints" ] = "outputIsTransparent";
199 map[ "shader" ] = customShader;
207 #endif //#ifndef __DALI_TOOLKIT_SHADER_EFFECT_MOTION_STRETCH_H__