QWidgetPanel.hpp

Go to the documentation of this file.

/***********************************
   Copyright 2017 Ravishankar Mathur

   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 _OF_QWIDGETPANEL_
#define _OF_QWIDGETPANEL_

// OpenFrames and OpenSceneGraph headers
#include <OpenFrames/Export.h>
#include <OpenFrames/ReferenceFrame.hpp>
#include <osg/Geode>
#include <osg/Geometry>
#include <osgViewer/ViewerEventHandlers>

// Qt forward declarations
#include <qglobal.h> // for QT_FORWARD_DECLARE_CLASS
QT_FORWARD_DECLARE_CLASS(QWidget);

// OpenFrames forward declarations
namespace OpenFrames
{
  class QWidgetImage;
}

namespace OpenFrames
{
  class OF_EXPORT QWidgetPanel : public ReferenceFrame
  {
    public:
      QWidgetPanel( const std::string &name );
      QWidgetPanel( const std::string &name, const osg::Vec3 &color );
      QWidgetPanel( const std::string &name, const osg::Vec4 &color );
      QWidgetPanel( const std::string &name , float r, float g, float b, float a = 1.0 );

      // Show/hide this frame's contents, e.g. everything a frame shows (excluding axes, labels, and children)
      // Inherited from ReferenceFrame
      virtual void showContents(bool showContents);
      virtual bool getContentsShown() const;

      void setSize(const double &width, const double &height);
      void getSize(double &width, double &height);

      bool setWidget( QWidget *widget );

      void setIgnoreWidget( QWidget *widget, bool ignore );

      osg::Image* getImage() { return (osg::Image*)_image.get(); }

      void setImageHandler(osgViewer::InteractiveImageHandler *handler);
      osgViewer::InteractiveImageHandler* getImageHandler() const;

      virtual void setColor( const osg::Vec4 &color );
      using ReferenceFrame::setColor; // Unhide other setColor() functions

      virtual const osg::BoundingSphere& getBound() const;

    protected:
      virtual ~QWidgetPanel();

      osg::ref_ptr<osg::Geode> _geode; // Node containing the box
      osg::ref_ptr<osg::Geometry> _panel; // A panel for rendering the controls
      osg::ref_ptr<osg::Geometry> _panelBack; // Controls mirrored on back of panel
      osg::ref_ptr<QWidgetImage> _image; // The image to which controls are drawn

    private:
      static const double DEFAULT_LENGTH;
      static const double DEFAULT_PIXELS_PER_UNIT; // Only when QWidget has an invalid preferred size

      std::vector<QWidget *> _ignoredWidgets;

      void _init();
      void _rescaleWidget();
  };

} // !namespace OpenFrames

#endif