OgreRTShaderSystem.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 IGNITION_RENDERING_OGRE_OGRERTSHADERSYSTEM_HH_
#define IGNITION_RENDERING_OGRE_OGRERTSHADERSYSTEM_HH_

#include <memory>
#include <string>

#include <ignition/common/SingletonT.hh>
#include "ignition/rendering/ogre/OgreIncludes.hh"
#include "ignition/rendering/ogre/OgreRenderTypes.hh"
#include "ignition/rendering/ogre/Export.hh"

namespace ignition
{
  namespace rendering
  {
    // forward declaration
    class OgreRTShaderSystemPrivate;


    class IGNITION_RENDERING_OGRE_VISIBLE OgreRTShaderSystem :
      public common::SingletonT<OgreRTShaderSystem>
    {
      public: enum LightingModel
              {
                SSLM_PerVertexLighting,
                SSLM_PerPixelLighting,
                SSLM_NormalMapLightingTangentSpace,
                SSLM_NormalMapLightingObjectSpace
              };

      private: OgreRTShaderSystem();

      private: virtual ~OgreRTShaderSystem();

      public: bool Init();

      public: void Fini();

      public: void Clear();

      public: void AddScene(OgreScenePtr _scene);

      public: void RemoveScene(OgreScenePtr _scene);

      public: void RemoveScene(const std::string &_scene);

      public: void UpdateShaders();

      public: void AttachEntity(OgreSubMesh *vis);

      public: void DetachEntity(OgreSubMesh *_vis);

      public: static void AttachViewport(Ogre::Viewport *_viewport,
                                         OgreScenePtr _scene);

      public: static void DetachViewport(Ogre::Viewport *_viewport,
                                         OgreScenePtr _scene);

      public: void SetPerPixelLighting(bool _set);

      public: void GenerateShaders(OgreSubMesh *_vis);

      public: void ApplyShadows(OgreScenePtr _scene);

      public: void RemoveShadows(OgreScenePtr _scene);

      public: Ogre::PSSMShadowCameraSetup *PSSMShadowCameraSetup() const;

      private: bool Paths(std::string &_coreLibsPath,
                             std::string &_cachePath);

      public: bool SetShadowTextureSize(const unsigned int _size);

      public: unsigned int ShadowTextureSize() const;

      public: bool IsInitialized() const;

      public: void Update();

      private: friend class SingletonT<OgreRTShaderSystem>;

      private: std::unique_ptr<OgreRTShaderSystemPrivate> dataPtr;
    };
  }
}
#endif