RTShaderSystem.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012-2014 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.
 *
*/
/* Desc: Wrapper around the OGRE RTShader system
 * Author: Nate Koenig
 * Date: 27 Jan 2010
 */

#ifndef _RTSHADERSYSTEM_HH_
#define _RTSHADERSYSTEM_HH_

#include <list>
#include <string>
#include <vector>

#include "gazebo/rendering/ogre_gazebo.h"
#include "gazebo/gazebo_config.h"

#include "gazebo/rendering/Camera.hh"
#include "gazebo/common/SingletonT.hh"
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace rendering
  {
    class Visual;
    class Scene;


    class GAZEBO_VISIBLE RTShaderSystem : public SingletonT<RTShaderSystem>
    {
      public: enum LightingModel
              {
                SSLM_PerVertexLighting,
                SSLM_PerPixelLighting,
                SSLM_NormalMapLightingTangentSpace,
                SSLM_NormalMapLightingObjectSpace
              };

      private: RTShaderSystem();

      private: virtual ~RTShaderSystem();

      public: void Init();

      public: void Fini();

      public: void Clear();

      public: void AddScene(ScenePtr _scene);

      public: void RemoveScene(ScenePtr _scene);

      public: void UpdateShaders();

      public: void AttachEntity(Visual *vis);

      public: void DetachEntity(Visual *_vis);

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

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

      public: void SetPerPixelLighting(bool _set);

      public: void GenerateShaders(Visual *_vis);

      public: void ApplyShadows(ScenePtr _scene);

      public: void RemoveShadows(ScenePtr _scene);

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

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

#if OGRE_VERSION_MAJOR >= 1 && OGRE_VERSION_MINOR >= 7
      private: Ogre::RTShader::ShaderGenerator *shaderGenerator;

      private: Ogre::RTShader::SubRenderState *shadowRenderState;
#endif

      private: std::list<Visual*> entities;

      private: bool initialized;

      private: bool shadowsApplied;

      private: std::vector<ScenePtr> scenes;

      private: boost::mutex *entityMutex;

      private: Ogre::ShadowCameraSetupPtr pssmSetup;

      private: friend class SingletonT<RTShaderSystem>;
    };
  }
}
#endif