DART  6.10.1
CollisionResult.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_COLLISION_COLLISIONRESULT_HPP_
34 #define DART_COLLISION_COLLISIONRESULT_HPP_
35 
36 #include <unordered_set>
37 #include <vector>
39 
40 namespace dart {
41 
42 namespace dynamics {
43 
44 class BodyNode;
45 class ShapeFrame;
46 
47 } // namespace dynamics
48 
49 namespace collision {
50 
52 {
53 public:
55  void addContact(const Contact& contact);
56 
58  std::size_t getNumContacts() const;
59 
61  Contact& getContact(std::size_t index);
62 
64  const Contact& getContact(std::size_t index) const;
65 
67  const std::vector<Contact>& getContacts() const;
68 
70  const std::unordered_set<const dynamics::BodyNode*>& getCollidingBodyNodes()
71  const;
72 
74  const std::unordered_set<const dynamics::ShapeFrame*>&
76 
78  bool inCollision(const dynamics::BodyNode* bn) const;
79 
81  bool inCollision(const dynamics::ShapeFrame* frame) const;
82 
84  bool isCollision() const;
85 
87  operator bool() const;
88 
90  void clear();
91 
92 protected:
93  void addObject(CollisionObject* object);
94 
96  std::vector<Contact> mContacts;
97 
99  std::unordered_set<const dynamics::BodyNode*> mCollidingBodyNodes;
100 
102  std::unordered_set<const dynamics::ShapeFrame*> mCollidingShapeFrames;
103 };
104 
105 } // namespace collision
106 } // namespace dart
107 
108 #endif // DART_COLLISION_COLLISIONRESULT_HPP_
std::size_t index
Definition: SkelParser.cpp:1672
Definition: CollisionObject.hpp:45
Definition: CollisionResult.hpp:52
std::size_t getNumContacts() const
Return number of contacts.
Definition: CollisionResult.cpp:52
void addObject(CollisionObject *object)
Definition: CollisionResult.cpp:126
void clear()
Clear all the contacts.
Definition: CollisionResult.cpp:118
std::unordered_set< const dynamics::ShapeFrame * > mCollidingShapeFrames
Set of ShapeFrames that are colliding.
Definition: CollisionResult.hpp:102
const std::unordered_set< const dynamics::ShapeFrame * > & getCollidingShapeFrames() const
Return the set of ShapeFrames that are in collision.
Definition: CollisionResult.cpp:88
const std::unordered_set< const dynamics::BodyNode * > & getCollidingBodyNodes() const
Return the set of BodyNodes that are in collision.
Definition: CollisionResult.cpp:81
bool isCollision() const
Return binary collision result.
Definition: CollisionResult.cpp:106
bool inCollision(const dynamics::BodyNode *bn) const
Returns true if the given BodyNode is in collision.
Definition: CollisionResult.cpp:94
void addContact(const Contact &contact)
Add one contact.
Definition: CollisionResult.cpp:44
std::vector< Contact > mContacts
List of contact information for each contact.
Definition: CollisionResult.hpp:96
Contact & getContact(std::size_t index)
Return the index-th contact.
Definition: CollisionResult.cpp:58
std::unordered_set< const dynamics::BodyNode * > mCollidingBodyNodes
Set of BodyNodes that are colliding.
Definition: CollisionResult.hpp:99
const std::vector< Contact > & getContacts() const
Return contacts.
Definition: CollisionResult.cpp:74
BodyNode class represents a single node of the skeleton.
Definition: BodyNode.hpp:79
Definition: ShapeFrame.hpp:192
Definition: BulletCollisionDetector.cpp:65
Contact information.
Definition: Contact.hpp:45