Gazebo Rendering

API Reference

3.7.2
gz/rendering/GizmoVisual.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2019 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 #ifndef GZ_RENDERING_GIZMOVISUAL_HH_
18 #define GZ_RENDERING_GIZMOVISUAL_HH_
19 
20 #include "gz/rendering/config.hh"
23 #include "gz/rendering/Export.hh"
25 
26 namespace ignition
27 {
28  namespace rendering
29  {
30  inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
31  //
34  class IGNITION_RENDERING_VISIBLE GizmoVisual :
35  public virtual CompositeVisual
36  {
38  public: virtual ~GizmoVisual() { }
39 
46  public: virtual void SetTransformMode(TransformMode _mode) = 0;
47 
51  public: virtual TransformMode Mode() const = 0;
52 
55  public: virtual void SetActiveAxis(const math::Vector3d &_axis) = 0;
56 
60  public: virtual math::Vector3d ActiveAxis() const = 0;
61 
65  public: virtual TransformAxis AxisById(unsigned int _id) const = 0;
66 
71  public: virtual VisualPtr ChildByAxis(unsigned int _axis) const = 0;
72  };
73  }
74  }
75 }
76 #endif
STL class.
TransformAxis
Unique identifiers for transformation axes.
Definition: gz/rendering/TransformType.hh:34
virtual ~GizmoVisual()
Destructor.
Definition: gz/rendering/GizmoVisual.hh:38
virtual void SetTransformMode(TransformMode _mode)=0
Set the transform mode of the gizmo. This controls the visual appearance of the gizmo....
virtual void SetActiveAxis(const math::Vector3d &_axis)=0
Set the active axis in the gizmo visual.
virtual math::Vector3d ActiveAxis() const =0
Get the current active axis.
Represents a predefined collection of geometries and visuals.
Definition: gz/rendering/CompositeVisual.hh:32
virtual TransformMode Mode() const =0
Get the current transform mode.
virtual VisualPtr ChildByAxis(unsigned int _axis) const =0
Get the child visual by axis.
TransformMode
Unique identifiers for transformation modes.
Definition: gz/rendering/TransformType.hh:60
A gizmo that contains rotate, translate, and scale visuals.
Definition: gz/rendering/GizmoVisual.hh:34
virtual TransformAxis AxisById(unsigned int _id) const =0
Get the Transform axis associated with the given id.