DART  6.10.1
SupportPolygonVisual.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2021, The DART development contributors
3  * All rights reserved.
4  *
5  * The list of contributors can be found at:
6  * https://github.com/dartsim/dart/blob/master/LICENSE
7  *
8  * This file is provided under the following "BSD-style" License:
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DART_GUI_OSG_SUPPORTPOLYGONVISUAL_HPP_
34 #define DART_GUI_OSG_SUPPORTPOLYGONVISUAL_HPP_
35 
36 #include <osg/Geode>
37 
39 
41 #include "dart/gui/osg/Viewer.hpp"
42 
43 namespace dart {
44 namespace gui {
45 namespace osg {
46 
50 {
51 public:
54  const dart::dynamics::SkeletonPtr& skeleton = nullptr,
55  double elevation = 0.02);
56 
59  const dart::dynamics::SkeletonPtr& skeleton,
60  std::size_t treeIndex,
61  double elevation = 0.02);
62 
64  void setSkeleton(const dart::dynamics::SkeletonPtr& skeleton);
65 
68 
71 
73  void visualizeTree(std::size_t treeIndex);
74 
76  void setDisplayElevation(double elevation);
77 
79  double getDisplayElevation() const;
80 
82  void displayPolygon(bool display);
83 
85  bool isPolygonDisplayed() const;
86 
88  void setPolygonColor(const Eigen::Vector4d& color);
89 
91  Eigen::Vector4d getPolygonColor() const;
92 
94  void displayCentroid(bool display);
95 
97  bool isCentroidDisplayed() const;
98 
100  void setCentroidRadius(double radius);
101 
103  double getCentroidRadius() const;
104 
106  void displayCenterOfMass(bool display);
107 
109  bool isCenterOfMassDisplayed() const;
110 
112  void setCenterOfMassRadius(double radius);
113 
115  double getCenterOfMassRadius() const;
116 
119  void setValidCOMColor(const Eigen::Vector4d& color);
120 
123  const Eigen::Vector4d& getValidCOMColor() const;
124 
127  void setInvalidCOMColor(const Eigen::Vector4d& color);
128 
131  const Eigen::Vector4d& getInvalidCOMColor() const;
132 
134  void refresh() override final;
135 
136 protected:
138  void initialize();
139 
142 
144  std::size_t mTreeIndex;
145 
147  double mElevation;
148 
151 
154 
157 
160 
163 
166 
168  double mComRadius;
169 
171  Eigen::Vector4d mValidColor;
172 
174  Eigen::Vector4d mInvalidColor;
175 
177  ::osg::ref_ptr<::osg::Vec4Array> mPolygonColor;
178 
180  ::osg::ref_ptr<::osg::Geode> mPolygonGeode;
181 
183  ::osg::ref_ptr<::osg::Geometry> mPolygonGeom;
184 
186  ::osg::ref_ptr<::osg::Vec3Array> mVertices;
187 
189  ::osg::ref_ptr<::osg::DrawElementsUShort> mFaces;
190 
192  ::osg::ref_ptr<ShapeFrameNode> mCentroidNode;
193 
195  ::osg::ref_ptr<ShapeFrameNode> mComNode;
196 };
197 
198 } // namespace osg
199 } // namespace gui
200 } // namespace dart
201 
202 #endif // DART_GUI_OSG_SUPPORTPOLYGONVISUAL_HPP_
Definition: ShapeFrameNode.hpp:61
Attach this to a Viewer in order to visualize the support polygon of a Skeleton.
Definition: SupportPolygonVisual.hpp:50
void initialize()
Initialize the memory used by this visual.
Definition: SupportPolygonVisual.cpp:346
dart::dynamics::SimpleFramePtr mCom
SimpleFrame for the center of mass.
Definition: SupportPolygonVisual.hpp:165
::osg::ref_ptr<::osg::Vec4Array > mPolygonColor
Color for the polygon.
Definition: SupportPolygonVisual.hpp:177
double mCentroidRadius
Radius to be used by the centroid.
Definition: SupportPolygonVisual.hpp:159
const Eigen::Vector4d & getInvalidCOMColor() const
Get the color that will be used for the center of mass if its projection is NOT on the support polygo...
Definition: SupportPolygonVisual.cpp:227
::osg::ref_ptr<::osg::Geometry > mPolygonGeom
Geometry to describe the polygon.
Definition: SupportPolygonVisual.hpp:183
::osg::ref_ptr< ShapeFrameNode > mComNode
Node to render the COM.
Definition: SupportPolygonVisual.hpp:195
bool mDisplayCOM
Whether to display the center of mass.
Definition: SupportPolygonVisual.hpp:162
double mComRadius
Radius to be used by the center of mass.
Definition: SupportPolygonVisual.hpp:168
bool mDisplayPolygon
Whether to display the polygon.
Definition: SupportPolygonVisual.hpp:150
void setCentroidRadius(double radius)
Set the radius of the centroid visualization.
Definition: SupportPolygonVisual.cpp:151
dart::dynamics::SimpleFramePtr mCentroid
SimpleFrame for the centroid.
Definition: SupportPolygonVisual.hpp:156
void refresh() override final
Update the support polygon visual.
Definition: SupportPolygonVisual.cpp:233
const Eigen::Vector4d & getValidCOMColor() const
Get the color that will be used for the center of mass if its projection is on the support polygon.
Definition: SupportPolygonVisual.cpp:215
dart::dynamics::SkeletonPtr getSkeleton() const
Get the Skeleton associated with this visual.
Definition: SupportPolygonVisual.cpp:73
void visualizeWholeSkeleton()
Visualize the entire Skeleton.
Definition: SupportPolygonVisual.cpp:79
void displayCentroid(bool display)
Display the centroid.
Definition: SupportPolygonVisual.cpp:131
double getCentroidRadius() const
Get the radius of the centroid visualization.
Definition: SupportPolygonVisual.cpp:164
::osg::ref_ptr<::osg::DrawElementsUShort > mFaces
Faces of the polygon.
Definition: SupportPolygonVisual.hpp:189
void visualizeTree(std::size_t treeIndex)
Visualize a specific tree in the Skeleton.
Definition: SupportPolygonVisual.cpp:85
void setCenterOfMassRadius(double radius)
Set the radius of the center of mass visualization.
Definition: SupportPolygonVisual.cpp:190
std::size_t mTreeIndex
Tree index for this visual.
Definition: SupportPolygonVisual.hpp:144
Eigen::Vector4d mInvalidColor
Color to be used when COM is invalid.
Definition: SupportPolygonVisual.hpp:174
void setPolygonColor(const Eigen::Vector4d &color)
Set the color of the support polygon.
Definition: SupportPolygonVisual.cpp:117
void setSkeleton(const dart::dynamics::SkeletonPtr &skeleton)
Change the Skeleton that is being visualized.
Definition: SupportPolygonVisual.cpp:66
bool mDisplayCentroid
Whether to display the centroid.
Definition: SupportPolygonVisual.hpp:153
bool isCentroidDisplayed() const
Returns true if the centroid is being displayed.
Definition: SupportPolygonVisual.cpp:145
void setDisplayElevation(double elevation)
Change the elevation height at which the polygon is displayed.
Definition: SupportPolygonVisual.cpp:91
void displayCenterOfMass(bool display)
Display the center of mass.
Definition: SupportPolygonVisual.cpp:170
double getDisplayElevation() const
Get the elevation of display for the support polygon.
Definition: SupportPolygonVisual.cpp:97
void setInvalidCOMColor(const Eigen::Vector4d &color)
Set the color that will be used for the center of mass if its projection is NOT on the support polygo...
Definition: SupportPolygonVisual.cpp:221
Eigen::Vector4d getPolygonColor() const
Get the color of the support polygon.
Definition: SupportPolygonVisual.cpp:124
bool isPolygonDisplayed() const
Returns true if the support polygon is being displayed.
double getCenterOfMassRadius() const
Get the radius of the center of mass visualization.
Definition: SupportPolygonVisual.cpp:203
::osg::ref_ptr<::osg::Vec3Array > mVertices
Vertices of the polygon.
Definition: SupportPolygonVisual.hpp:186
dart::dynamics::WeakSkeletonPtr mSkeleton
Skeleton for this visual.
Definition: SupportPolygonVisual.hpp:141
void setValidCOMColor(const Eigen::Vector4d &color)
Set the color that will be used for the center of mass if its projection is on the support polygon.
Definition: SupportPolygonVisual.cpp:209
void displayPolygon(bool display)
Display the support polygon.
Definition: SupportPolygonVisual.cpp:103
Eigen::Vector4d mValidColor
Color to be used when COM is valid.
Definition: SupportPolygonVisual.hpp:171
SupportPolygonVisual(const dart::dynamics::SkeletonPtr &skeleton=nullptr, double elevation=0.02)
Visualize the support polygon of an entire Skeleton.
Definition: SupportPolygonVisual.cpp:46
bool isCenterOfMassDisplayed() const
Returns true if the center of mass is being displayed.
Definition: SupportPolygonVisual.cpp:184
::osg::ref_ptr< ShapeFrameNode > mCentroidNode
Node to render the centroid.
Definition: SupportPolygonVisual.hpp:192
double mElevation
Elevation that this visual should use.
Definition: SupportPolygonVisual.hpp:147
::osg::ref_ptr<::osg::Geode > mPolygonGeode
Geode to hold the polygon.
Definition: SupportPolygonVisual.hpp:180
Definition: Viewer.hpp:77
Definition: Random-impl.hpp:92
std::weak_ptr< Skeleton > WeakSkeletonPtr
Definition: SmartPointer.hpp:60
std::shared_ptr< SimpleFrame > SimpleFramePtr
Definition: SmartPointer.hpp:53
std::shared_ptr< Skeleton > SkeletonPtr
Definition: SmartPointer.hpp:60
Definition: BulletCollisionDetector.cpp:65
Definition: SharedLibraryManager.hpp:46