MRPT  2.0.4
stock_objects.h
Go to the documentation of this file.
1 /* +------------------------------------------------------------------------+
2  | Mobile Robot Programming Toolkit (MRPT) |
3  | https://www.mrpt.org/ |
4  | |
5  | Copyright (c) 2005-2020, Individual contributors, see AUTHORS file |
6  | See: https://www.mrpt.org/Authors - All rights reserved. |
7  | Released under BSD License. See: https://www.mrpt.org/License |
8  +------------------------------------------------------------------------+ */
9 #pragma once
10 
12 
13 namespace mrpt
14 {
15 namespace opengl
16 {
17 /** A collection of pre-built 3D objects for quick insertion in
18  * opengl::COpenGLScene objects.
19  * \ingroup mrpt_opengl_grp
20  */
21 namespace stock_objects
22 {
23 /** Returns a representation of Rhodon.
24  * The generated object must be inserted in a opengl::COpenGLScene or
25  * opengl::CSetOfObjects.
26  * <div align="center">
27  * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
28  * border-style: solid;">
29  * <tr> <td> mrpt::opengl::stock_objects::RobotRhodon() </td> <td> \image
30  * html preview_stock_objects_RobotRhodon.png </td> </tr>
31  * </table>
32  * </div>
33  */
35 
36 /** Returns a representation of RobotGiraff.
37  * The generated object must be inserted in a opengl::COpenGLScene or
38  * opengl::CSetOfObjects.
39  * <div align="center">
40  * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
41  * border-style: solid;">
42  * <tr> <td> mrpt::opengl::stock_objects::RobotGiraff() </td> <td> \image
43  * html preview_stock_objects_RobotGiraff.png </td> </tr>
44  * </table>
45  * </div>
46  */
48 
49 /** Returns a representation of a Pioneer II mobile base.
50  * The generated object must be inserted in a opengl::COpenGLScene or
51  * opengl::CSetOfObjects.
52  * <div align="center">
53  * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
54  * border-style: solid;">
55  * <tr> <td> mrpt::opengl::stock_objects::RobotPioneer() </td> <td> \image
56  * html preview_stock_objects_RobotPioneer.png </td> </tr>
57  * </table>
58  * </div>
59  */
61 
62 /** Returns three arrows representing a X,Y,Z 3D corner.
63  * The generated object must be inserted in a opengl::COpenGLScene or
64  * opengl::CSetOfObjects.
65  * \sa CornerXYZSimple, CornerXYSimple, CornerXYZEye
66  * <div align="center">
67  * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
68  * border-style: solid;">
69  * <tr> <td> mrpt::opengl::stock_objects::CornerXYZ() </td> <td> \image html
70  * preview_stock_objects_CornerXYZ.png </td> </tr>
71  * </table>
72  * </div>
73  */
74 CSetOfObjects::Ptr CornerXYZ(float scale = 1.0);
75 
76 /** Returns three arrows representing a X,Y,Z 3D corner.
77  * Differently from CornerXYZ the arrowhead of Z axis ends where the object is
78  * placed.
79  * This is useful if you want to place this object with the same position and
80  * orientation of a camera.
81  * The generated object must be inserted in a opengl::COpenGLScene or
82  * opengl::CSetOfObjects.
83  * \sa CornerXYZSimple, CornerXYSimple
84  * <div align="center">
85  * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
86  * border-style: solid;">
87  * <tr> <td> mrpt::opengl::stock_objects::CornerXYZ() </td> <td> \image html
88  * preview_stock_objects_CornerXYZ.png </td> </tr>
89  * </table>
90  * </div>
91  */
93 
94 /** Returns three arrows representing a X,Y,Z 3D corner (just thick lines
95  * instead of complex arrows for faster rendering than CornerXYZ).
96  * The generated object must be inserted in a opengl::COpenGLScene or
97  * opengl::CSetOfObjects.
98  * \sa CornerXYZ, CornerXYSimple
99  * <div align="center">
100  * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
101  * border-style: solid;">
102  * <tr> <td> mrpt::opengl::stock_objects::CornerXYZSimple() </td> <td>
103  * \image html preview_stock_objects_CornerXYZSimple.png </td> </tr>
104  * </table>
105  * </div>
106  */
107 CSetOfObjects::Ptr CornerXYZSimple(float scale = 1.0, float lineWidth = 1.0);
108 
109 /** Returns two arrows representing a X,Y 2D corner (just thick lines, fast to
110  * render).
111  * The generated object must be inserted in a opengl::COpenGLScene or
112  * opengl::CSetOfObjects.
113  * \sa CornerXYZSimple, CornerXYZ, CornerXYZEye
114  * <div align="center">
115  * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
116  * border-style: solid;">
117  * <tr> <td> mrpt::opengl::stock_objects::CornerXYSimple() </td> <td> \image
118  * html preview_stock_objects_CornerXYSimple.png </td> </tr>
119  * </table>
120  * </div>
121  */
122 CSetOfObjects::Ptr CornerXYSimple(float scale = 1.0, float lineWidth = 1.0);
123 
124 /** Returns a simple 3D model of a PointGrey Bumblebee stereo camera.
125  * The generated object must be inserted in a opengl::COpenGLScene or
126  * opengl::CSetOfObjects.
127  * <div align="center">
128  * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
129  * border-style: solid;">
130  * <tr> <td> mrpt::opengl::stock_objects::BumblebeeCamera() </td> <td>
131  * \image html preview_stock_objects_BumblebeeCamera.png </td> </tr>
132  * </table>
133  * </div>
134  */
136 
137 /** Returns a simple 3D model of a Hokuyo URG scanner.
138  * The generated object must be inserted in a opengl::COpenGLScene or
139  * opengl::CSetOfObjects.
140  * <div align="center">
141  * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
142  * border-style: solid;">
143  * <tr> <td> mrpt::opengl::stock_objects::Hokuyo_URG() </td> <td> \image
144  * html preview_stock_objects_Hokuyo_URG.png </td> </tr>
145  * </table>
146  * </div>
147  */
149 
150 /** Returns a simple 3D model of a Hokuyo UTM scanner.
151  * The generated object must be inserted in a opengl::COpenGLScene or
152  * opengl::CSetOfObjects.
153  * <div align="center">
154  * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
155  * border-style: solid;">
156  * <tr> <td> mrpt::opengl::stock_objects::Hokuyo_UTM() </td> <td> \image
157  * html preview_stock_objects_Hokuyo_UTM.png </td> </tr>
158  * </table>
159  * </div>
160  */
162 
163 /** Returns a simple 3D model of a househam sprayer.
164  * The generated object must be inserted in a opengl::COpenGLScene or
165  * opengl::CSetOfObjects.
166  * <div align="center">
167  * <table border="0" cellspan="4" cellspacing="4" style="border-width: 1px;
168  * border-style: solid;">
169  * <tr> <td> mrpt::opengl::stock_objects::Househam_Sprayer() </td> <td>
170  * \image html preview_stock_objects_Househam_Sprayer.png </td> </tr>
171  * </table>
172  * </div>
173  */
175 
176 } // end namespace stock_objects
177 } // namespace opengl
178 
179 } // namespace mrpt
CSetOfObjects::Ptr Hokuyo_UTM()
Returns a simple 3D model of a Hokuyo UTM scanner.
CSetOfObjects::Ptr CornerXYSimple(float scale=1.0, float lineWidth=1.0)
Returns two arrows representing a X,Y 2D corner (just thick lines, fast to render).
CSetOfObjects::Ptr RobotGiraff()
Returns a representation of RobotGiraff.
CSetOfObjects::Ptr RobotRhodon()
Returns a representation of Rhodon.
CSetOfObjects::Ptr Househam_Sprayer()
Returns a simple 3D model of a househam sprayer.
CSetOfObjects::Ptr RobotPioneer()
Returns a representation of a Pioneer II mobile base.
This is the global namespace for all Mobile Robot Programming Toolkit (MRPT) libraries.
CSetOfObjects::Ptr CornerXYZ(float scale=1.0)
Returns three arrows representing a X,Y,Z 3D corner.
CSetOfObjects::Ptr CornerXYZSimple(float scale=1.0, float lineWidth=1.0)
Returns three arrows representing a X,Y,Z 3D corner (just thick lines instead of complex arrows for f...
CSetOfObjects::Ptr CornerXYZEye()
Returns three arrows representing a X,Y,Z 3D corner.
CSetOfObjects::Ptr BumblebeeCamera()
Returns a simple 3D model of a PointGrey Bumblebee stereo camera.
CSetOfObjects::Ptr Hokuyo_URG()
Returns a simple 3D model of a Hokuyo URG scanner.



Page generated by Doxygen 1.8.14 for MRPT 2.0.4 Git: 33de1d0ad Sat Jun 20 11:02:42 2020 +0200 at sáb jun 20 17:35:17 CEST 2020