Program Listing for File render_system.hpp
↰ Return to documentation for file (include/rviz_rendering/render_system.hpp
)
/*
* Copyright (c) 2011, Willow Garage, Inc.
* Copyright (c) 2017, Open Source Robotics Foundation, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the Willow Garage, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef RVIZ_RENDERING__RENDER_SYSTEM_HPP_
#define RVIZ_RENDERING__RENDER_SYSTEM_HPP_
#include <cstdint>
#include <string>
#include <OgreRoot.h>
#include <Overlay/OgreOverlaySystem.h> // NOLINT cpplint cannot handle include order here
#include <RenderSystems/GL/OgreGLPlugin.h> // NOLINT cpplint cannot handle include order here
#include <QDir> // NOLINT cpplint cannot handle include order here
#ifdef __linux__
#include <X11/Xutil.h>
#include <GL/glx.h>
#endif
#include "rviz_rendering/visibility_control.hpp"
#include "rviz_rendering/ogre_logging.hpp"
namespace rviz_rendering
{
class RVIZ_RENDERING_PUBLIC RenderSystem
{
public:
#if defined(__APPLE__) || defined(_WIN32)
typedef size_t WindowIDType;
#else
typedef unsigned long WindowIDType; // NOLINT: we need to use C longs here
#endif
static
RenderSystem *
get();
Ogre::RenderWindow *
makeRenderWindow(
WindowIDType window_id,
unsigned int width,
unsigned int height,
double pixel_ratio = 1.0);
Ogre::Root *
getOgreRoot();
~RenderSystem();
void Destroy();
// Prepare a scene_manager to render overlays.
// Needed for Ogre >= 1.9 to use fonts; does nothing for prior versions.
void
prepareOverlays(Ogre::SceneManager * scene_manager);
int
getGlVersion();
int
getGlslVersion();
static
void
disableAntiAliasing();
static
void
forceGlVersion(int version);
static
void
forceNoStereo();
bool
isStereoSupported();
private:
RenderSystem();
void
setupDummyWindowId();
void
loadOgrePlugins();
// helper for makeRenderWindow()
Ogre::RenderWindow *
tryMakeRenderWindow(
const std::string & name,
unsigned int width,
unsigned int height,
const Ogre::NameValuePairList * params,
int max_attempts);
// Find and configure the render system.
void
setupRenderSystem();
void
setResourceDirectory();
void
setPluginDirectory();
void
setupResources();
void
addAdditionalResourcesFromAmentIndex() const;
void
detectGlVersion();
static RenderSystem * instance_;
// ID for a dummy window of size 1x1, used to keep Ogre happy.
WindowIDType dummy_window_id_;
Ogre::Root * ogre_root_;
Ogre::OverlaySystem * ogre_overlay_system_;
int gl_version_;
int glsl_version_;
static bool use_anti_aliasing_;
static int force_gl_version_;
bool stereo_supported_;
static bool force_no_stereo_;
rviz_rendering::OgreLogging * ogre_logging;
#if !defined(__APPLE__) && !defined(_WIN32)
void * dummyDisplay = nullptr;
void * dummyContext = nullptr;
XVisualInfo * dummyVisual = nullptr;
#endif
};
} // namespace rviz_rendering
#endif // RVIZ_RENDERING__RENDER_SYSTEM_HPP_