OgreScene.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2015 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_OGRE_OGRESCENE_HH_
#define GZ_RENDERING_OGRE_OGRESCENE_HH_
 
#include <array>
#include <string>
#include "gz/rendering/base/BaseScene.hh"
#include "gz/rendering/ogre/Export.hh"
#include "gz/rendering/ogre/OgreRenderTypes.hh"
 
 
namespace Ogre
{
  class Root;
  class SceneManager;
}
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
    //
    class GZ_RENDERING_OGRE_VISIBLE OgreScene :
      public BaseScene
    {
      protected: OgreScene(unsigned int _id, const std::string &_name);
 
      public: virtual ~OgreScene();
 
      public: virtual void Fini() override;
 
      public: virtual RenderEngine *Engine() const override;
 
      public: virtual VisualPtr RootVisual() const override;
 
      public: virtual math::Color AmbientLight() const override;
 
      public: virtual void SetAmbientLight(const math::Color &_color) override;
 
      public: virtual void SetBackgroundColor(
        const math::Color &_color) override;
 
      // Documentation inherited.
      public: virtual void SetGradientBackgroundColor(
                     const std::array<math::Color, 4> &_colors) override;
 
      // Documentation inherited.
      public: virtual void RemoveGradientBackgroundColor() override;
 
      public: virtual void PreRender() override;
 
      public: virtual void Clear() override;
 
      public: virtual void Destroy() override;
 
      public: virtual Ogre::SceneManager *OgreSceneManager() const;
 
      protected: virtual bool LoadImpl() override;
 
      protected: virtual bool InitImpl() override;
 
      protected: virtual DirectionalLightPtr CreateDirectionalLightImpl(
                     unsigned int _id, const std::string &_name) 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;
 
      protected: virtual LightVisualPtr CreateLightVisualImpl(unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual PointLightPtr CreatePointLightImpl(unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual SpotLightPtr CreateSpotLightImpl(unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual CameraPtr CreateCameraImpl(unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual DepthCameraPtr CreateDepthCameraImpl(
                     const unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual ThermalCameraPtr CreateThermalCameraImpl(
                     const unsigned int _id,
                     const std::string &_name) override;
 
      // Documentation inherited
      protected: virtual WideAngleCameraPtr CreateWideAngleCameraImpl(
                     const unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual GpuRaysPtr CreateGpuRaysImpl(
                     const unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual VisualPtr CreateVisualImpl(unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual ArrowVisualPtr CreateArrowVisualImpl(unsigned int _id,
                     const std::string &_name) override;
 
      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;
 
      protected: virtual GeometryPtr CreateBoxImpl(unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual GeometryPtr CreateConeImpl(unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual GeometryPtr CreateCylinderImpl(unsigned int _id,
                     const std::string &_name) override;
 
      protected: virtual GeometryPtr CreatePlaneImpl(unsigned int _id,
                     const std::string &_name) override;
 
      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);
 
      protected: virtual MeshPtr CreateMeshImpl(
        unsigned int _id,
        const std::string &_name,
        const MeshDescriptor &_desc) override;
 
      // Documentation inherited
      protected: virtual HeightmapPtr CreateHeightmapImpl(
        unsigned int _id,
        const std::string &_name,
        const HeightmapDescriptor &_desc) override;
 
      // Documentation inherited
      protected: virtual CapsulePtr CreateCapsuleImpl(unsigned int _id,
                     const std::string &_name) override;
 
      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
      // \todo(iche033) make this virtual in gz-rendering10
      protected: FrustumVisualPtr CreateFrustumVisualImpl(
                     unsigned int _id, const std::string &_name);
 
      // 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;
 
      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;
 
      protected: virtual bool InitObject(OgreObjectPtr _object,
                     unsigned int _id, const std::string &_name);
 
      protected: virtual LightStorePtr Lights() const override;
 
      protected: virtual SensorStorePtr Sensors() const override;
 
      protected: virtual VisualStorePtr Visuals() const override;
 
      protected: virtual MaterialMapPtr Materials() const override;
 
      // Documentation inherited
      protected: unsigned int CreateObjectId() override;
 
      public: void ClearMaterialsCache(const std::string &_name);
 
      private: void CreateContext();
 
      private: void CreateRootVisual();
 
      private: void CreateMeshFactory();
 
      private: void CreateStores();
 
      private: OgreScenePtr SharedThis();
 
      protected: OgreVisualPtr rootVisual;
 
      protected: OgreMeshFactoryPtr meshFactory;
 
      protected: OgreLightStorePtr lights;
 
      protected: OgreSensorStorePtr sensors;
 
      protected: OgreVisualStorePtr visuals;
 
      protected: OgreMaterialMapPtr materials;
 
      protected: Ogre::Root *ogreRoot;
 
      protected: Ogre::SceneManager *ogreSceneManager;
 
      private: friend class OgreRenderEngine;
      private: friend class OgreSceneExt;
    };
 
    class OgreSceneExt : public SceneExt
    {
      public: OgreSceneExt(Scene *_scene);
 
      // Documentation inherited
      public: virtual ObjectPtr CreateExt(const std::string &_type,
          const std::string &_name = "") override;
    };
    }
  }
}
#endif