From cbc2668c5c62a528883bf7a92ec300e02598f9b8 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Wed, 15 Mar 2006 12:26:48 +0000 Subject: [PATCH] Added comment on the meaning of the matrix paramter in the computeIntersections methods. --- include/osgSim/SphereSegment | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/include/osgSim/SphereSegment b/include/osgSim/SphereSegment index d5ada6eb8..6731c6d66 100644 --- a/include/osgSim/SphereSegment +++ b/include/osgSim/SphereSegment @@ -231,16 +231,24 @@ public: /** A list of vertex arrays representing a list of lines.*/ typedef std::vector< osg::ref_ptr > LineList; - /** Compute the interesection lines between subgraph and this sphere segment.*/ + /** Compute the interesection lines between subgraph and this sphere segment. + * The matrix is the transform that takes the subgraph into the same coordiante frame as the sphere segment. + * The resulting intersections are in the coordinate frame of the sphere segment. */ LineList computeIntersection(const osg::Matrixd& matrix, osg::Node* subgraph); - /** Compute the interesection lines between specified drawable and this sphere segment.*/ + /** Compute the interesection lines between specified drawable and this sphere segment. + * The matrix is the transform that takes the subgraph into the same coordiante frame as the sphere segment. + * The resulting intersections are in the coordinate frame of the sphere segment. */ LineList computeIntersection(const osg::Matrixd& matrix, osg::Drawable* drawable); - /** Compute the interesection lines between subgraph and this sphere segment.*/ + /** Compute the interesection lines between subgraph and this sphere segment. + * The matrix is the transform that takes the subgraph into the same coordiante frame as the sphere segment. + * The resulting intersections are in the coordinate frame of the sphere segment. */ osg::Node* computeIntersectionSubgraph(const osg::Matrixd& matrix, osg::Node* subgraph); - /** Compute the interesection lines between specified drawable and this sphere segment.*/ + /** Compute the interesection lines between specified drawable and this sphere segment. + * The matrix is the transform that takes the subgraph into the same coordiante frame as the sphere segment. + * The resulting intersections are in the coordinate frame of the sphere segment. */ osg::Node* computeIntersectionSubgraph(const osg::Matrixd& matrix, osg::Drawable* drawable);