Add the doc for ray_intersection

This commit is contained in:
Philipp Möller 2015-10-22 16:12:14 +02:00 committed by Sébastien Loriot
parent a7f563092d
commit 90542aa0ab
1 changed files with 6 additions and 0 deletions

View File

@ -392,6 +392,12 @@ public:
#endif
any_intersection(const Query& query) const;
// Return the intersection closest to the source point of the ray
// query. Type `Ray` must be a type for which `do_intersect`
// predicates and intersections are defined.
//
// `AABBTraits` must be a model of `AABBRayIntersectionTraits` to
// call this member function.
template<typename Ray>
boost::optional< typename Intersection_and_primitive_id<Query>::Type >
ray_intersection(const Ray& query) const;