AxisVisual.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012-2016 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 
18 #ifndef _GAZEBO_AXISVISUAL_HH_
19 #define _GAZEBO_AXISVISUAL_HH_
20 
21 #include <string>
22 
23 #include "gazebo/math/Vector3.hh"
25 #include "gazebo/util/system.hh"
26 
27 namespace gazebo
28 {
29  namespace rendering
30  {
33 
36  class GZ_RENDERING_VISIBLE AxisVisual : public Visual
37  {
41  public: AxisVisual(const std::string &_name, VisualPtr _parent);
42 
44  public: virtual ~AxisVisual();
45 
47  public: virtual void Load();
48 
52  public: void ShowAxisRotation(unsigned int _axis, bool _show);
53 
57  public: void ShowAxisShaft(unsigned int _axis, bool _show);
58 
62  public: void ShowAxisHead(unsigned int _axis, bool _show);
63 
67  public: void ScaleXAxis(const math::Vector3 &_scale)
68  GAZEBO_DEPRECATED(7.0);
69 
72  public: void ScaleXAxis(const ignition::math::Vector3d &_scale);
73 
77  public: void ScaleYAxis(const math::Vector3 &_scale)
78  GAZEBO_DEPRECATED(7.0);
79 
82  public: void ScaleYAxis(const ignition::math::Vector3d &_scale);
83 
87  public: void ScaleZAxis(const math::Vector3 &_scale)
88  GAZEBO_DEPRECATED(7.0);
89 
92  public: void ScaleZAxis(const ignition::math::Vector3d &_scale);
93 
97  public: void SetAxisMaterial(unsigned int _axis,
98  const std::string &_material);
99 
103  public: void SetAxisVisible(unsigned int _axis, bool _visible);
104 
110  protected: AxisVisual(VisualPrivate &_dataPtr,
111  const std::string &_name, VisualPtr _parent);
112  };
114  }
115 }
116 #endif
The Vector3 class represents the generic vector containing 3 elements.
Definition: Vector3.hh:39
#define GAZEBO_DEPRECATED(version)
Definition: CommonTypes.hh:48
Basic axis visualization.
Definition: AxisVisual.hh:36
A renderable object.
Definition: Visual.hh:59
std::shared_ptr< Visual > VisualPtr
Definition: RenderTypes.hh:112