Skip to content

Commit

Permalink
fix concept doc
Browse files Browse the repository at this point in the history
  • Loading branch information
sloriot committed Mar 4, 2024
1 parent c4a1197 commit 32e68f8
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ define the Intersection_distance functor.
class AABBRayIntersectionGeomTraits_3 {
public:
/*!
Type of a ray.
Type of a 3D ray.
*/
typedef unspecified_type Ray;
typedef unspecified_type Ray_3;

/*!
Type of a vector.
Type of a 3D vector.
*/
typedef unspecified_type Vector;
typedef unspecified_type Vector_3;

/*!
A functor object to construct the source point of a ray. Provides the operator:
Expand Down
10 changes: 5 additions & 5 deletions AABB_tree/doc/AABB_tree/Concepts/AABBRayIntersectionTraits.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ class AABBRayIntersectionTraits {
public:

/*!
Type of a 3D ray.
Type of a ray.
*/
typedef unspecified_type Ray_3;
typedef unspecified_type Ray;


/*!
Expand All @@ -34,9 +34,9 @@ class AABBRayIntersectionTraits {
respectively.
Provides the operators:
`std::optional<FT> operator()(const Ray_3& r, const Bounding_box& bbox)`.
`std::optional<std::pair<FT, Intersection_and_primitive_id<Ray_3>::%Type > >
operator()(const Ray_3& r, const Primitive& primitive)`.
`std::optional<FT> operator()(const Ray& r, const Bounding_box& bbox)`.
`std::optional<std::pair<FT, Intersection_and_primitive_id<Ray>::%Type > >
operator()(const Ray& r, const Primitive& primitive)`.
A common algorithm to compute the intersection between a bounding box and a ray is <A
HREF="https://education.siggraph.org/static/HyperGraph/raytrace/rtinter3.htm">the
Expand Down
2 changes: 1 addition & 1 deletion AABB_tree/include/CGAL/AABB_traits_3.h
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ class AABB_tree;
/// member function `bbox()` that returns the bounding box of the primitive.
///
/// If the argument `GeomTraits` is a model of the concept \ref
/// AABBRayIntersectionGeomTraits, this class is also a model of \ref
/// AABBRayIntersectionGeomTraits_3, this class is also a model of \ref
/// AABBRayIntersectionTraits.
///
/// \sa `AABBTraits`
Expand Down

0 comments on commit 32e68f8

Please sign in to comment.