Ogre2Scene.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef GZ_RENDERING_OGRE2_OGRE2SCENE_HH_
#define GZ_RENDERING_OGRE2_OGRE2SCENE_HH_
 
#include <memory>
#include <string>
#include <vector>
 
#include "gz/rendering/Storage.hh"
#include "gz/rendering/base/BaseScene.hh"
#include "gz/rendering/ogre2/Ogre2RenderTypes.hh"
 
#include "gz/rendering/ogre2/Export.hh"
 
// This disables warning messages for OGRE
#ifndef _MSC_VER
  #pragma GCC system_header
#else
  #pragma warning(push, 0)
#endif
#include <Compositor/OgreCompositorShadowNode.h>
#ifdef _MSC_VER
  #pragma warning(pop)
#endif
 
namespace Ogre
{
  class Root;
  class SceneManager;
}
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
    //
    // forward declaration
    class Ogre2ScenePrivate;
    //
    class GZ_RENDERING_OGRE2_VISIBLE Ogre2Scene :
      public BaseScene
    {
      protected: Ogre2Scene(unsigned int _id, const std::string &_name);
 
      public: virtual ~Ogre2Scene();
 
      // Documentation inherited.
      public: virtual void Fini() override;
 
      // Documentation inherited.
      public: virtual RenderEngine *Engine() const override;
 
      // Documentation inherited.
      public: virtual VisualPtr RootVisual() const override;
 
      // Documentation inherited.
      public: virtual void SetTime(
        const std::chrono::steady_clock::duration &_time) override;
 
      // Documentation inherited.
      public: virtual math::Color AmbientLight() const override;
 
      // Documentation inherited.
      public: virtual void SetAmbientLight(const math::Color &_color) override;
 
      // Documentation inherited.
      public: void SetBackgroundColor(const math::Color &_color) override;
 
      // Documentation inherited
      public: virtual void PreRender() override;
 
      // Documentation inherited
      public: virtual void Clear() override;
 
      // Documentation inherited
      public: virtual void Destroy() override;
 
      // Documentation inherited
      public: virtual void SetSkyEnabled(bool _enabled) override;
 
      // Documentation inherited
      public: virtual bool SkyEnabled() const override;
 
      // Documentation inherited
      public: bool SetShadowTextureSize(LightType _lightType,
            unsigned int _textureSize);
 
      // Documentation inherited
      public: unsigned int ShadowTextureSize(LightType _lightType) const
            override;
 
      // Documentation inherited
      public: virtual void SetActiveGlobalIllumination(
            GlobalIlluminationBasePtr _gi) override;
 
      public: void SetLightsGiDirty();
 
      // Documentation inherited.
      public: virtual void SetCameraPassCountPerGpuFlush(
            uint8_t _numPass) override;
 
      // Documentation inherited.
      public: virtual uint8_t CameraPassCountPerGpuFlush() const override;
 
      // Documentation inherited.
      public: virtual bool LegacyAutoGpuFlush() const override;
 
      public: virtual Ogre::SceneManager *OgreSceneManager() const;
 
      // Documentation inherited
      public: virtual void PostRender() override;
 
      public: void StartForcedRender();
 
      public: void EndForcedRender();
 
      public: void StartRendering(Ogre::Camera *_camera);
 
      public: void FlushGpuCommandsAndStartNewFrame(uint8_t _numPasses,
                                                    bool _startNewFrame);
 
      protected: void FlushGpuCommandsOnly();
 
      protected: void EndFrame();
 
      public: void SetShadowsDirty(bool _dirty);
 
      public: bool ShadowsDirty() const;
 
      // Documentation inherited
      protected: virtual bool LoadImpl() override;
 
      // Documentation inherited
      protected: virtual bool InitImpl() override;
 
      // Documentation inherited
      protected: virtual COMVisualPtr CreateCOMVisualImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual InertiaVisualPtr CreateInertiaVisualImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual JointVisualPtr CreateJointVisualImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual LightVisualPtr CreateLightVisualImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual DirectionalLightPtr CreateDirectionalLightImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual PointLightPtr CreatePointLightImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual SpotLightPtr CreateSpotLightImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual CameraPtr CreateCameraImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual DepthCameraPtr CreateDepthCameraImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual ThermalCameraPtr CreateThermalCameraImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual WideAngleCameraPtr CreateWideAngleCameraImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual BoundingBoxCameraPtr CreateBoundingBoxCameraImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual SegmentationCameraPtr CreateSegmentationCameraImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual GpuRaysPtr CreateGpuRaysImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual VisualPtr CreateVisualImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual ArrowVisualPtr CreateArrowVisualImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual AxisVisualPtr CreateAxisVisualImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual GizmoVisualPtr CreateGizmoVisualImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual GeometryPtr CreateBoxImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual GeometryPtr CreateConeImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual GeometryPtr CreateCylinderImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual GeometryPtr CreatePlaneImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual GeometryPtr CreateSphereImpl(unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual MeshPtr CreateMeshImpl(unsigned int _id,
                     const std::string &_name, const std::string &_meshName);
 
      // Documentation inherited
      protected: virtual MeshPtr CreateMeshImpl(unsigned int _id,
                     const std::string &_name, const MeshDescriptor &_desc)
                     override;
 
      // Documentation inherited
      protected: virtual CapsulePtr CreateCapsuleImpl(unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual HeightmapPtr CreateHeightmapImpl(unsigned int _id,
                   const std::string &_name, const HeightmapDescriptor &_desc)
                   override;
 
      // Documentation inherited
      protected: virtual GridPtr CreateGridImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual MarkerPtr CreateMarkerImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual LidarVisualPtr CreateLidarVisualImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual FrustumVisualPtr CreateFrustumVisualImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual WireBoxPtr CreateWireBoxImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual TextPtr CreateTextImpl(unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual MaterialPtr CreateMaterialImpl(unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual RenderTexturePtr CreateRenderTextureImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited.
      protected: virtual RenderWindowPtr CreateRenderWindowImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual RayQueryPtr CreateRayQueryImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual ParticleEmitterPtr CreateParticleEmitterImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual ProjectorPtr CreateProjectorImpl(
                     unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual GlobalIlluminationVctPtr
          CreateGlobalIlluminationVctImpl(
                    unsigned int _id, const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual GlobalIlluminationCiVctPtr
          CreateGlobalIlluminationCiVctImpl(
                    unsigned int _id, const std::string &_name) override;
 
      protected: virtual bool InitObject(Ogre2ObjectPtr _object,
                     unsigned int _id, const std::string &_name);
 
      public: void UpdateAllHeightmaps(Ogre::Camera *_camera);
 
      public: const std::vector<std::weak_ptr<Ogre2Heightmap>> &Heightmaps()
          const;
 
      protected: void UpdateShadowNode();
 
      private: void CreateShadowNodeWithSettings(
          Ogre::CompositorManager2 *_compositorManager,
          const std::string &_shadowNodeName,
          const Ogre::ShadowNodeHelper::ShadowParamVec &_shadowParams);
 
      // Documentation inherited
      protected: virtual LightStorePtr Lights() const override;
 
      // Documentation inherited
      protected: virtual SensorStorePtr Sensors() const override;
 
      // Documentation inherited
      protected: virtual VisualStorePtr Visuals() const override;
 
      // Documentation inherited
      protected: virtual MaterialMapPtr Materials() const override;
 
      // Documentation inherited
      protected: unsigned int CreateObjectId() override;
 
      private: void CreateContext();
 
      private: void CreateRootVisual();
 
      private: void CreateMeshFactory();
 
      private: void CreateStores();
 
      public: void GZ_DEPRECATED(10) ClearMaterialsCache(
                  const std::string &_name);
 
      private: Ogre2ScenePtr SharedThis();
 
      protected: Ogre2VisualPtr rootVisual;
 
      protected: Ogre2MeshFactoryPtr meshFactory;
 
      protected: Ogre2SensorStorePtr sensors;
 
      protected: Ogre2VisualStorePtr visuals;
 
      protected: Ogre2LightStorePtr lights;
 
      protected: Ogre2MaterialMapPtr materials;
 
      protected: std::vector<std::weak_ptr<Ogre2Heightmap>> heightmaps;
 
      protected: Ogre::SceneManager *ogreSceneManager = nullptr;
 
      private: std::unique_ptr<Ogre2ScenePrivate> dataPtr;
 
      private: friend class Ogre2RenderEngine;
 
      private: friend class Ogre2SceneExt;
    };
 
    class Ogre2SceneExt : public SceneExt
    {
      public: Ogre2SceneExt(Scene *_scene);
 
      // Documentation inherited
      public: virtual ObjectPtr CreateExt(const std::string &_type,
          const std::string &_name = "") override;
    };
    }
  }
}
#endif