2 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <dali-toolkit/dali-toolkit.h>
25 #include "ktx-loader.h"
26 #include "model-skybox.h"
27 #include "model-pbr.h"
30 using namespace Toolkit;
34 * "papermill_pmrem.ktx" and "papermill_E_diffuse-64.ktx are image files generated from
35 * image file downloaded from "http://www.hdrlabs.com/sibl/archive.html" with title
36 * "Papermill Ruins E" by Blochi and is licensed under Creative Commons License
37 * http://creativecommons.org/licenses/by-nc-sa/3.0/us/
44 const char* NORMAL_ROUGH_TEXTURE_URL = DEMO_IMAGE_DIR "Test_100_normal_roughness.png";
45 const char* ALBEDO_METAL_TEXTURE_URL = DEMO_IMAGE_DIR "Test_wblue_100_albedo_metal.png";
46 const char* CUBEMAP_SPECULAR_TEXTURE_URL = DEMO_IMAGE_DIR "papermill_pmrem.ktx";
47 const char* CUBEMAP_DIFFUSE_TEXTURE_URL = DEMO_IMAGE_DIR "papermill_E_diffuse-64.ktx";
49 const char* SPHERE_URL = DEMO_MODEL_DIR "sphere.obj";
50 const char* TEAPOT_URL = DEMO_MODEL_DIR "teapot.obj";
52 const char* VERTEX_SHADER_URL = DEMO_SHADER_DIR "pbr_shader.vsh";
53 const char* FRAGMENT_SHADER_URL = DEMO_SHADER_DIR "pbr_shader.fsh";
55 const Vector3 SKYBOX_SCALE( 1.0f, 1.0f, 1.0f );
56 const Vector3 SPHERE_SCALE( 1.5f, 1.5f, 1.5f );
57 const Vector3 TEAPOT_SCALE( 2.0f, 2.0f, 2.0f );
59 const float CAMERA_DEFAULT_FOV( 60.0f );
60 const float CAMERA_DEFAULT_NEAR( 0.1f );
61 const float CAMERA_DEFAULT_FAR( 1000.0f );
62 const Vector3 CAMERA_DEFAULT_POSITION( 0.0f, 0.0f, 3.5f );
68 * This example shows a Physically Based Rendering illumination model.
70 * - Double-tap to toggle between 3D models (teapot & cube)
71 * - Pan up/down on left side of screen to change roughness
72 * - Pan up/down on right side of screen to change metalness
73 * - Pan anywhere else to rotate scene
77 class BasicPbrController : public ConnectionTracker
81 BasicPbrController( Application& application )
82 : mApplication( application ),
93 // Connect to the Application's Init signal
94 mApplication.InitSignal().Connect( this, &BasicPbrController::Create );
99 // Nothing to do here;
102 // The Init signal is received once (only) during the Application lifetime
103 void Create( Application& application )
106 Dali::Window winHandle = application.GetWindow();
107 winHandle.ShowIndicator( Dali::Window::INVISIBLE );
109 // Get a handle to the stage
110 Stage stage = Stage::GetCurrent();
111 stage.SetBackgroundColor( Color::BLACK );
112 mAnimation = Animation::New( 1.0f );
113 mLabel = TextLabel::New( "R:1 M:0" );
114 mLabel.SetAnchorPoint( AnchorPoint::TOP_CENTER );
115 mLabel.SetParentOrigin( ParentOrigin::TOP_CENTER );
116 mLabel.SetSize( stage.GetSize().width * 0.5f, stage.GetSize().height * 0.083f );
117 mLabel.SetProperty( TextLabel::Property::HORIZONTAL_ALIGNMENT, "CENTER" );
118 mLabel.SetProperty( TextLabel::Property::VERTICAL_ALIGNMENT, "CENTER" );
119 mLabel.SetProperty( TextLabel::Property::TEXT_COLOR, Color::WHITE );
120 mLabel.SetProperty( Actor::Property::COLOR_ALPHA, 0.0f );
121 // Step 1. Create shader
124 // Step 2. Create texture
127 // Step 3. Initialise Main Actor
130 // Respond to a click anywhere on the stage
131 stage.GetRootLayer().TouchSignal().Connect( this, &BasicPbrController::OnTouch );
133 // Respond to key events
134 stage.KeyEventSignal().Connect( this, &BasicPbrController::OnKeyEvent );
136 mDoubleTapTime = Timer::New(150);
137 mDoubleTapTime.TickSignal().Connect( this, &BasicPbrController::OnDoubleTapTime );
141 bool OnDoubleTapTime()
148 * This function will change the material Roughness, Metalness or the model orientation when touched
150 bool OnTouch( Actor actor, const TouchData& touch )
152 const PointState::Type state = touch.GetState( 0 );
156 case PointState::DOWN:
160 mTeapotView = !mTeapotView;
161 mModel[0].GetActor().SetProperty(Dali::Actor::Property::VISIBLE, !mTeapotView);
162 mModel[1].GetActor().SetProperty(Dali::Actor::Property::VISIBLE, mTeapotView);
164 mDoubleTapTime.Stop();
165 mStartTouch = touch.GetScreenPosition(0);
166 mPointZ = mStartTouch;
168 mLabel.SetProperty( Actor::Property::COLOR_ALPHA, 1.0f );
171 case PointState::MOTION:
173 const Stage stage = Stage::GetCurrent();
174 const Size size = stage.GetSize();
175 const float scaleX = size.width;
176 const float scaleY = size.height;
177 const Vector2 point = touch.GetScreenPosition(0);
178 bool process = false;
179 if( ( mStartTouch.x < ( scaleX * 0.3f ) ) && ( point.x < ( scaleX * 0.3f ) ) )
181 mRoughness += ( mStartTouch.y - point.y ) / ( scaleY * 0.9f );
183 //Clamp Roughness to 0.0 to 1.0
184 mRoughness = std::max( 0.f, std::min( 1.f, mRoughness ) );
186 mShader.SetProperty( mShader.GetPropertyIndex( "uRoughness" ), mRoughness );
187 std::ostringstream oss;
189 oss << " R:" << mRoughness<< "," << " M:" << mMetalness;
190 mLabel.SetProperty( TextLabel::Property::TEXT, oss.str() );
194 if( ( mStartTouch.x > ( scaleX * 0.7f ) ) && ( point.x > ( scaleX * 0.7f ) ) )
196 mMetalness += ( mStartTouch.y - point.y ) / ( scaleY * 0.9f );
198 //Clamp Metalness to 0.0 to 1.0
199 mMetalness = std::max( 0.f, std::min( 1.f, mMetalness ) );
201 mShader.SetProperty( mShader.GetPropertyIndex( "uMetallic" ), mMetalness );
202 std::ostringstream oss;
204 oss << " R:" << mRoughness<< "," << " M:" << mMetalness;
205 mLabel.SetProperty( TextLabel::Property::TEXT, oss.str() );
209 //If the touch is not processed above, then change the model orientation
213 const float angle1 = ( ( mPointZ.y - point.y ) / scaleY );
214 const float angle2 = ( ( mPointZ.x - point.x ) / scaleX );
215 Actor actor1 = mModel[0].GetActor();
216 Actor actor2 = mModel[1].GetActor();
218 Quaternion modelOrientation = mModelOrientation;
219 modelOrientation.Conjugate();
220 const Quaternion pitchRot(Radian(Degree(angle1 * -200.0f)), modelOrientation.Rotate( Vector3::XAXIS ) );
221 const Quaternion yawRot(Radian(Degree(angle2 * -200.0f)), modelOrientation.Rotate( Vector3::YAXIS ) );
223 mModelOrientation = mModelOrientation * yawRot * pitchRot ;
224 mSkybox.GetActor().SetOrientation( mModelOrientation );
225 actor1.SetOrientation( mModelOrientation );
226 actor2.SetOrientation( mModelOrientation );
234 mDoubleTapTime.Start();
236 mAnimation.AnimateTo( Property( mLabel, Actor::Property::COLOR_ALPHA ), 0.0f, TimePeriod( 0.5f, 1.0f ) );
250 * @brief Called when any key event is received
252 * Will use this to quit the application if Back or the Escape key is received
253 * @param[in] event The key event information
255 void OnKeyEvent( const KeyEvent& event )
257 if( event.state == KeyEvent::Down )
259 if( IsKey( event, Dali::DALI_KEY_ESCAPE ) || IsKey( event, Dali::DALI_KEY_BACK ) )
267 * Creates new main actor
271 Stage stage = Stage::GetCurrent();
273 mSkybox.Init( SKYBOX_SCALE );
274 mModel[0].Init( mShader, SPHERE_URL, Vector3::ZERO, SPHERE_SCALE );
275 mModel[1].Init( mShader, TEAPOT_URL, Vector3::ZERO, TEAPOT_SCALE );
277 // Hide the model according with mTeapotView variable
278 mModel[0].GetActor().SetProperty(Dali::Actor::Property::VISIBLE, !mTeapotView);
279 mModel[1].GetActor().SetProperty(Dali::Actor::Property::VISIBLE, mTeapotView);
281 // Creating root and camera actor for rendertask for 3D Scene rendering
282 mUiRoot = Actor::New();
283 m3dRoot = Actor::New();
284 CameraActor cameraUi = CameraActor::New(stage.GetSize());
285 cameraUi.SetAnchorPoint(AnchorPoint::CENTER);
286 cameraUi.SetParentOrigin(ParentOrigin::CENTER);
288 RenderTask rendertask = Stage::GetCurrent().GetRenderTaskList().CreateTask();
289 rendertask.SetCameraActor( cameraUi );
290 rendertask.SetSourceActor( mUiRoot );
292 mUiRoot.SetAnchorPoint(AnchorPoint::TOP_LEFT);
293 mUiRoot.SetParentOrigin(ParentOrigin::TOP_LEFT);
294 mUiRoot.SetSize(stage.GetSize());
296 m3dRoot.SetAnchorPoint(AnchorPoint::CENTER);
297 m3dRoot.SetParentOrigin(ParentOrigin::CENTER);
299 // Setting camera parameters for 3D Scene
300 mSkybox.GetActor().SetPosition( CAMERA_DEFAULT_POSITION );
301 CameraActor camera3d = stage.GetRenderTaskList().GetTask(0).GetCameraActor();
302 camera3d.SetInvertYAxis( true );
303 camera3d.SetPosition( CAMERA_DEFAULT_POSITION );
304 camera3d.SetNearClippingPlane( CAMERA_DEFAULT_NEAR );
305 camera3d.SetFarClippingPlane( CAMERA_DEFAULT_FAR );
306 camera3d.SetFieldOfView( Radian( Degree( CAMERA_DEFAULT_FOV ) ) );
308 stage.Add( cameraUi );
309 stage.Add( mUiRoot );
310 stage.Add( m3dRoot );
312 m3dRoot.Add( mSkybox.GetActor() );
313 m3dRoot.Add( mModel[0].GetActor() );
314 m3dRoot.Add( mModel[1].GetActor() );
317 if( (stage.GetSize().x > 360.0f) && (stage.GetSize().y > 360.0f) )
319 mUiRoot.Add( mLabel );
325 * Creates a shader using file path
327 void CreateModelShader()
329 const std::string mCurrentVShaderFile( VERTEX_SHADER_URL );
330 const std::string mCurrentFShaderFile( FRAGMENT_SHADER_URL );
332 mShader = LoadShaders( mCurrentVShaderFile, mCurrentFShaderFile );
334 // Initialise shader uniforms
335 // Level 8 because the environment texture has 6 levels plus 2 are missing (2x2 and 1x1)
336 mShader.RegisterProperty( "uMaxLOD", 8.0f );
337 mShader.RegisterProperty( "uRoughness", 1.0f );
338 mShader.RegisterProperty( "uMetallic" , 0.0f );
346 PixelData albeldoPixelData = SyncImageLoader::Load( ALBEDO_METAL_TEXTURE_URL );
347 Texture textureAlbedoMetal = Texture::New( TextureType::TEXTURE_2D, albeldoPixelData.GetPixelFormat(), albeldoPixelData.GetWidth(), albeldoPixelData.GetHeight() );
348 textureAlbedoMetal.Upload( albeldoPixelData, 0, 0, 0, 0, albeldoPixelData.GetWidth(), albeldoPixelData.GetHeight() );
350 PixelData normalPixelData = SyncImageLoader::Load( NORMAL_ROUGH_TEXTURE_URL );
351 Texture textureNormalRough = Texture::New( TextureType::TEXTURE_2D, normalPixelData.GetPixelFormat(), normalPixelData.GetWidth(), normalPixelData.GetHeight() );
352 textureNormalRough.Upload( normalPixelData, 0, 0, 0, 0, normalPixelData.GetWidth(), normalPixelData.GetHeight() );
354 // This texture should have 6 faces and only one mipmap
355 PbrDemo::CubeData diffuse;
356 PbrDemo::LoadCubeMapFromKtxFile( CUBEMAP_DIFFUSE_TEXTURE_URL, diffuse );
358 Texture diffuseTexture = Texture::New( TextureType::TEXTURE_CUBE, diffuse.img[0][0].GetPixelFormat(), diffuse.img[0][0].GetWidth(), diffuse.img[0][0].GetHeight() );
359 for( unsigned int midmapLevel = 0; midmapLevel < diffuse.img[0].size(); ++midmapLevel )
361 for( unsigned int i = 0; i < diffuse.img.size(); ++i )
363 diffuseTexture.Upload( diffuse.img[i][midmapLevel], CubeMapLayer::POSITIVE_X + i, midmapLevel, 0, 0, diffuse.img[i][midmapLevel].GetWidth(), diffuse.img[i][midmapLevel].GetHeight() );
367 // This texture should have 6 faces and 6 mipmaps
368 PbrDemo::CubeData specular;
369 PbrDemo::LoadCubeMapFromKtxFile( CUBEMAP_SPECULAR_TEXTURE_URL, specular);
371 Texture specularTexture = Texture::New( TextureType::TEXTURE_CUBE, specular.img[0][0].GetPixelFormat(), specular.img[0][0].GetWidth(), specular.img[0][0].GetHeight() );
372 for( unsigned int midmapLevel = 0; midmapLevel < specular.img[0].size(); ++midmapLevel )
374 for( unsigned int i = 0; i < specular.img.size(); ++i )
376 specularTexture.Upload( specular.img[i][midmapLevel], CubeMapLayer::POSITIVE_X + i, midmapLevel, 0, 0, specular.img[i][midmapLevel].GetWidth(), specular.img[i][midmapLevel].GetHeight() );
380 mModel[0].InitTexture( textureAlbedoMetal, textureNormalRough, diffuseTexture, specularTexture );
381 mModel[1].InitTexture( textureAlbedoMetal, textureNormalRough, diffuseTexture, specularTexture );
382 mSkybox.InitTexture( specularTexture );
386 * @brief Load a shader source file
387 * @param[in] The path of the source file
388 * @param[out] The contents of file
389 * @return True if the source was read successfully
391 bool LoadShaderCode( const std::string& fullpath, std::vector<char>& output )
393 FILE* file = fopen( fullpath.c_str(), "rb" );
399 bool retValue = false;
400 if( ! fseek( file, 0, SEEK_END ) )
402 long int size = ftell( file );
404 if( ( size != -1L ) &&
405 ( ! fseek( file, 0, SEEK_SET ) ) )
407 output.resize( size + 1 );
408 std::fill( output.begin(), output.end(), 0 );
409 ssize_t result = fread( output.data(), size, 1, file );
411 retValue = ( result >= 0 );
419 * @brief Load vertex and fragment shader source
420 * @param[in] shaderVertexFileName is the filepath of Vertex shader
421 * @param[in] shaderFragFileName is the filepath of Fragment shader
422 * @return the Dali::Shader object
424 Shader LoadShaders( const std::string& shaderVertexFileName, const std::string& shaderFragFileName )
427 std::vector<char> bufV, bufF;
429 if( LoadShaderCode( shaderVertexFileName.c_str(), bufV ) )
431 if( LoadShaderCode( shaderFragFileName.c_str(), bufF ) )
433 shader = Shader::New( bufV.data() , bufF.data() );
440 Application& mApplication;
445 Animation mAnimation;
446 Timer mDoubleTapTime;
454 Quaternion mModelOrientation;
462 int DALI_EXPORT_API main( int argc, char **argv )
464 Application application = Application::New( &argc, &argv);
465 BasicPbrController test( application );
466 application.MainLoop();