AlignTool.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2020 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_SIM_GUI_ALIGNTOOL_HH_
#define GZ_SIM_GUI_ALIGNTOOL_HH_
 
#include <memory>
 
#include <gz/sim/gui/GuiSystem.hh>
#include <gz/gui/Plugin.hh>
#include <gz/rendering/Node.hh>
 
namespace gz
{
namespace sim
{
  enum class AlignState
  {
    HOVER = 0,
    RESET = 1,
    ALIGN = 2,
    NONE = 3
  };
 
  enum class AlignAxis
  {
    ALIGN_X = 0,
    ALIGN_Y = 1,
    ALIGN_Z = 2
  };
 
  enum class AlignConfig
  {
    ALIGN_MIN,
    ALIGN_MID,
    ALIGN_MAX
  };
 
  class AlignToolPrivate;
 
  class AlignTool :
    public gz::sim::GuiSystem
  {
    Q_OBJECT
 
    public: AlignTool();
 
    public: ~AlignTool() override;
 
    // Documentation inherited
    public: void LoadConfig(const tinyxml2::XMLElement *_pluginElem) override;
 
    // Documentation inherited
    public: void Update(const UpdateInfo &_info,
        EntityComponentManager &_ecm) override;
 
    public slots: void OnAlignAxis(const QString &_mode);
 
    public slots: void OnAlignTarget(const QString &_target);
 
    public slots: void OnAlignConfig(const QString &_mode);
 
    public slots: void OnReverse(bool _reverse);
 
    public slots: void OnHoveredEntered();
 
    public slots: void OnHoveredExited();
 
    public slots: void OnAlign();
 
    public: void AddState(const AlignState &_state);
 
    public: void UpdateTransparency(const rendering::NodePtr &_node,
        bool _makeTransparent);
 
    public: void Align();
 
    public: rendering::VisualPtr TopLevelVisual(rendering::ScenePtr &_scene,
            rendering::VisualPtr &_visual) const;
 
    public: rendering::NodePtr TopLevelNode(rendering::ScenePtr &_scene,
            rendering::NodePtr &_node) const;
 
    // Documentation inherited
    protected: bool eventFilter(QObject *_obj, QEvent *_event) override;
 
    private: std::unique_ptr<AlignToolPrivate> dataPtr;
  };
}
}
 
#endif