FCL  0.6.0
Flexible Collision Library
cylinder.h
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011-2014, Willow Garage, Inc.
5  * Copyright (c) 2014-2016, Open Source Robotics Foundation
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
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  * * Neither the name of Open Source Robotics Foundation nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
30  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
32  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33  * POSSIBILITY OF SUCH DAMAGE.
34  */
35 
38 #ifndef FCL_SHAPE_CYLINDER_H
39 #define FCL_SHAPE_CYLINDER_H
40 
41 #include "fcl/geometry/shape/shape_base.h"
42 
43 namespace fcl
44 {
45 
47 template <typename S_>
48 class Cylinder : public ShapeBase<S_>
49 {
50 public:
51 
52  using S = S_;
53 
55  Cylinder(S radius, S lz);
56 
58  S radius;
59 
61  S lz;
62 
64  void computeLocalAABB() override;
65 
67  NODE_TYPE getNodeType() const override;
68 
69  // Documentation inherited
70  S computeVolume() const override;
71 
72  // Documentation inherited
73  Matrix3<S> computeMomentofInertia() const override;
74 
77  std::vector<Vector3<S>> getBoundVertices(const Transform3<S>& tf) const;
78 };
79 
82 
83 } // namespace fcl
84 
85 #include "fcl/geometry/shape/cylinder-inl.h"
86 
87 #endif
NODE_TYPE
traversal node type: bounding volume (AABB, OBB, RSS, kIOS, OBBRSS, KDOP16, KDOP18, kDOP24), basic shape (box, sphere, ellipsoid, capsule, cone, cylinder, convex, plane, halfspace, triangle), and octree
Definition: collision_geometry.h:54
Main namespace.
Definition: broadphase_bruteforce-inl.h:45
Base class for all basic geometric shapes.
Definition: shape_base.h:48
Cylinder(S radius, S lz)
Constructor.
Definition: cylinder-inl.h:52
S computeVolume() const override
compute the volume
Definition: cylinder-inl.h:79
S radius
Radius of the cylinder.
Definition: cylinder.h:58
Matrix3< S > computeMomentofInertia() const override
compute the inertia matrix, related to the origin
Definition: cylinder-inl.h:86
void computeLocalAABB() override
Compute AABB.
Definition: cylinder-inl.h:60
S lz
Length along z axis.
Definition: cylinder.h:61
Center at zero cylinder.
Definition: cylinder.h:48
NODE_TYPE getNodeType() const override
Get node type: a cylinder.
Definition: cylinder-inl.h:72
std::vector< Vector3< S > > getBoundVertices(const Transform3< S > &tf) const
get the vertices of some convex shape which can bound this shape in a specific configuration ...
Definition: cylinder-inl.h:97