AxisVisual.hh
Go to the documentation of this file.
1/*
2 * Copyright (C) 2012 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
24#include "gazebo/util/system.hh"
25
26namespace gazebo
27{
28 namespace rendering
29 {
32
35 class GZ_RENDERING_VISIBLE AxisVisual : public Visual
36 {
40 public: AxisVisual(const std::string &_name, VisualPtr _parent);
41
43 public: virtual ~AxisVisual();
44
46 public: virtual void Load();
47
51 public: void ShowAxisRotation(unsigned int _axis, bool _show);
52
56 public: void ShowAxisShaft(unsigned int _axis, bool _show);
57
61 public: void ShowAxisHead(unsigned int _axis, bool _show);
62
65 public: void ScaleXAxis(const ignition::math::Vector3d &_scale);
66
69 public: void ScaleYAxis(const ignition::math::Vector3d &_scale);
70
73 public: void ScaleZAxis(const ignition::math::Vector3d &_scale);
74
78 public: void SetAxisMaterial(unsigned int _axis,
79 const std::string &_material);
80
84 public: void SetAxisVisible(unsigned int _axis, bool _visible);
85
91 protected: AxisVisual(VisualPrivate &_dataPtr,
92 const std::string &_name, VisualPtr _parent);
93 };
95 }
96}
97#endif
rendering
Definition RenderEngine.hh:31
Basic axis visualization.
Definition AxisVisual.hh:36
AxisVisual(VisualPrivate &_dataPtr, const std::string &_name, VisualPtr _parent)
void ScaleZAxis(const ignition::math::Vector3d &_scale)
Scale the Z axis.
void ShowAxisShaft(unsigned int _axis, bool _show)
Show the axis arrow shaft.
void ScaleXAxis(const ignition::math::Vector3d &_scale)
Scale the X axis.
void ScaleYAxis(const ignition::math::Vector3d &_scale)
Scale the Y axis.
AxisVisual(const std::string &_name, VisualPtr _parent)
Constructor.
void ShowAxisRotation(unsigned int _axis, bool _show)
Show the rotation tube.
virtual void Load()
Load the axis visual.
void SetAxisMaterial(unsigned int _axis, const std::string &_material)
Set the material used to render and axis.
void ShowAxisHead(unsigned int _axis, bool _show)
Show the axis arrow head.
void SetAxisVisible(unsigned int _axis, bool _visible)
Set whether the axis will be visible.
virtual ~AxisVisual()
Destructor.
A renderable object.
Definition Visual.hh:61
std::shared_ptr< Visual > VisualPtr
Definition RenderTypes.hh:114
Forward declarations for the common classes.
Definition Animation.hh:27