From 180a50feaf3492e65c04cdc2e154e5a8c1bd5c4e Mon Sep 17 00:00:00 2001
From: Florent Lamiraux <florent@laas.fr>
Date: Fri, 7 Dec 2018 11:48:14 +0100
Subject: [PATCH] [doc] Add some comments in the development note.
---
doc/notes | 22 +++++++++++++++++-----
1 file changed, 17 insertions(+), 5 deletions(-)
diff --git a/doc/notes b/doc/notes
index 3f68113f..4b32d0cb 100644
--- a/doc/notes
+++ b/doc/notes
@@ -6,11 +6,7 @@ In include/hpp/fcl/traversal:
- bool initialize(MeshShapeCollisionTraversalNode<BV, S, NarrowPhaseSolver>& node, ...
- bool initialize(ShapeMeshCollisionTraversalNode<S, BV, NarrowPhaseSolver>& node, ...
- bool initialize(MeshCollisionTraversalNode<BV>& node,...
- - bool initialize(MeshCollisionTraversalNodeOBB& node, ...
- - bool initialize(MeshCollisionTraversalNodeRSS& node, ...
- - bool initialize(MeshCollisionTraversalNodekIOS& node, ...
- - bool initialize(MeshCollisionTraversalNodeOBBRSS& node, ...
-
+
- other do not.
- bool initialize(MeshOcTreeCollisionTraversalNode<BV, NarrowPhaseSolver>& node, ...
@@ -23,3 +19,19 @@ In include/hpp/fcl/traversal:
- bool initialize(ShapeMeshCollisionTraversalNodeRSS<S, NarrowPhaseSolver>& node, ...
- bool initialize(ShapeMeshCollisionTraversalNodekIOS<S, NarrowPhaseSolver>& node, ...
- bool initialize(ShapeMeshCollisionTraversalNodeOBBRSS<S, NarrowPhaseSolver>& node, ...
+ - bool initialize(MeshCollisionTraversalNodeOBB& node, ...
+ - bool initialize(MeshCollisionTraversalNodeRSS& node, ...
+ - bool initialize(MeshCollisionTraversalNodekIOS& node, ...
+ - bool initialize(MeshCollisionTraversalNodeOBBRSS& node, ...
+
+classes
+ - MeshCollisionTraversalNodeRSS,
+ - MeshCollisionTraversalNodekIOS,
+ - MeshCollisionTraversalNodeOBBRSS
+derive from
+ - MeshCollisionTraversalNode <RSS>,
+ - MeshCollisionTraversalNode <kIOS>,
+ - MeshCollisionTraversalNode <OBBRSS>.
+They store the relative position and orientation between two objects to test for
+collision. before calling overlap function, this additional information computes
+the relative positions of the bounding volumes.
--
GitLab