All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ray.h File Reference
+ Include dependency graph for ray.h:

Go to the source code of this file.

Classes

class  GfRay
 Basic type: Ray used for intersection testing. More...
 

Functions

GF_API bool GfFindClosestPoints (const GfRay &ray, const GfLine &line, GfVec3d *rayPoint=nullptr, GfVec3d *linePoint=nullptr, double *rayDistance=nullptr, double *lineDistance=nullptr)
 Computes the closest points between a ray and a line. More...
 
GF_API bool GfFindClosestPoints (const GfRay &ray, const GfLineSeg &seg, GfVec3d *rayPoint=nullptr, GfVec3d *segPoint=nullptr, double *rayDistance=nullptr, double *segDistance=nullptr)
 Computes the closest points between a ray and a line segment. More...
 
GF_API std::ostream & operator<< (std::ostream &, const GfRay &)
 Output a GfRay using the format [(x y z) >> (x y z)]. More...
 

Function Documentation

GF_API bool GfFindClosestPoints ( const GfRay ray,
const GfLine line,
GfVec3d rayPoint = nullptr,
GfVec3d linePoint = nullptr,
double *  rayDistance = nullptr,
double *  lineDistance = nullptr 
)

Computes the closest points between a ray and a line.

The two points are returned in rayPoint and linePoint. The parametric distance of each point on the lines is returned in rayDistance and lineDistance.

This returns false if the lines were close enough to parallel that no points could be computed; in this case, the other return values are undefined.

GF_API bool GfFindClosestPoints ( const GfRay ray,
const GfLineSeg seg,
GfVec3d rayPoint = nullptr,
GfVec3d segPoint = nullptr,
double *  rayDistance = nullptr,
double *  segDistance = nullptr 
)

Computes the closest points between a ray and a line segment.

The two points are returned in rayPoint and segPoint. The parametric distance of each point is returned in rayDistance and segDistance.

This returns false if the lines were close enough to parallel that no points could be computed; in this case, the other return values are undefined.