dali-toolkit/internal/visuals/mesh/mesh-visual.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_MESH_VISUAL_H
   2 #define DALI_TOOLKIT_INTERNAL_MESH_VISUAL_H
   3
   4 /*
   5  * Copyright (c) 2016 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 <fstream>
  23 #include <string.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/public-api/visuals/mesh-visual-properties.h>
  27 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
  28 #include <dali-toolkit/internal/controls/model3d-view/obj-loader.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Toolkit
  34 {
  35
  36 namespace Internal
  37 {
  38
  39 /**
  40  * The visual which renders a 3D object to the control's quad
  41  *
  42  * The following Property::Map keys are required to create a MeshVisual
  43  *
  44  * | %Property Name  | Type        | Representing                                                          |
  45  * |-----------------|-------------|-----------------------------------------------------------------------|
  46  * | objectUrl       | STRING      | A URL to the .obj file                                                |
  47  * | materialUrl     | STRING      | A URL to the .mtl file                                                |
  48  * | texturesPath    | STRING      | A URL of the path to the texture images                               |
  49  * | shadingMode     | STRING      | An enum of shading modes                                              |
  50  * | useMipmapping   | BOOLEAN     | If true, use mipmaps for textures. Default true.                      |
  51  * | useSoftNormals  | BOOLEAN     | If true, average normals at points for smooth textures. Default true. |
  52  * | lightPosition   | VECTOR3     | The position (on stage) of the light                                  |
  53  */
  54 class MeshVisual: public Visual::Base
  55 {
  56 public:
  57
  58   /**
  59    * @brief Constructor.
  60    *
  61    * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object
  62    */
  63   MeshVisual( VisualFactoryCache& factoryCache );
  64
  65   /**
  66    * @brief A reference counted object may only be deleted by calling Unreference().
  67    */
  68   virtual ~MeshVisual();
  69
  70 public:  // from Visual
  71
  72   /**
  73    * @copydoc Visual::Base::SetSize
  74    */
  75   virtual void SetSize( const Vector2& size );
  76
  77   /**
  78    * @copydoc Visual::Base::CreatePropertyMap
  79    */
  80   virtual void DoCreatePropertyMap( Property::Map& map ) const;
  81
  82 protected:
  83
  84   /**
  85    * @copydoc Visual::Base::DoInitialize
  86    */
  87   virtual void DoInitialize( Actor& actor, const Property::Map& propertyMap );
  88
  89   /**
  90    * @copydoc Visual::Base::DoSetOnStage
  91    */
  92   virtual void DoSetOnStage( Actor& actor );
  93
  94 public:
  95
  96   /**
  97    * Declare whether a texture map should be used for the object, if it's present. Defaults to true.
  98    * @param[in] useTexture boolean declaration.
  99    */
 100   void SetUseTexture( bool useTexture );
 101
 102   /**
 103    * Declare whether a normal map should be used for the object, if it's present. Defaults to true.
 104    * @param[in] useNormalMap boolean declaration.
 105    */
 106   void SetUseNormalMap( bool useNormalMap );
 107
 108 private:
 109
 110   /**
 111    * @brief Provide an empty geometry for the visual to use.
 112    * @details For use in error cases where the initialisation has failed for varying reasons.
 113    */
 114   void SupplyEmptyGeometry();
 115
 116   /**
 117    * @brief Initialize the visual with the geometry and shader from the cache, if not available, create and save to the cache for sharing.
 118    */
 119   void InitializeRenderer();
 120
 121   /**
 122    * @brief Create a shader for the object to use.
 123    */
 124   void CreateShader();
 125
 126   /**
 127    * @brief Update shader related info, uniforms, etc. for the new shader.
 128    */
 129   void UpdateShaderUniforms();
 130
 131   /**
 132    * @brief Use the object URL stored in the mesh visual to load and create the geometry of the object.
 133    * @return Boolean of success of operation.
 134    */
 135   bool CreateGeometry();
 136
 137   /**
 138    * @brief Use the object URL stored in the visual to load the geometry of the object.
 139    * @return Boolean of success of operation.
 140    */
 141   bool LoadGeometry();
 142
 143   /**
 144    * @brief Use the material URL stored in the mesh visual to load the material of the object.
 145    * @return Boolean of success of operation.
 146    */
 147   bool LoadMaterial();
 148
 149   /**
 150    * @brief Use the image and texture URL components to load the different types of texture.
 151    * @return Boolean of success of operation. Returns false if any texture fails to load from a url.
 152    */
 153   bool LoadTextures();
 154
 155 private:
 156
 157   // Undefined
 158   MeshVisual( const MeshVisual& meshVisual );
 159
 160   // Undefined
 161   MeshVisual& operator=( const MeshVisual& meshVisual );
 162
 163 private:
 164
 165   std::string mObjectUrl;
 166   std::string mMaterialUrl;
 167
 168   std::string mDiffuseTextureUrl;
 169   std::string mNormalTextureUrl;
 170   std::string mGlossTextureUrl;
 171   std::string mTexturesPath;
 172
 173   Shader mShader;
 174   Geometry mGeometry;
 175   TextureSet mTextureSet;
 176
 177   ObjLoader mObjLoader;
 178   Vector3 mSceneCenter;
 179   Vector3 mSceneSize;
 180
 181   Vector3 mLightPosition;
 182   Toolkit::MeshVisual::ShadingMode::Value mShadingMode;
 183
 184   bool mUseTexture;
 185   bool mUseMipmapping;
 186   bool mUseSoftNormals;
 187 };
 188
 189 } // namespace Internal
 190
 191 } // namespace Toolkit
 192
 193 } // namespace Dali
 194
 195 #endif /* DALI_TOOLKIT_INTERNAL_MESH_VISUAL_H */