This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
lineSeg.h File Reference
+ Include dependency graph for lineSeg.h:

Go to the source code of this file.

Classes

class  GfLineSeg
 Basic type: 3D line segment. More...
 

Functions

GF_API bool GfFindClosestPoints (const GfLine &line, const GfLineSeg &seg, GfVec3d *p1=nullptr, GfVec3d *p2=nullptr, double *t1=nullptr, double *t2=nullptr)
 Computes the closets points on line and seg.
 
GF_API bool GfFindClosestPoints (const GfLineSeg &seg1, const GfLineSeg &seg2, GfVec3d *p1=nullptr, GfVec3d *p2=nullptr, double *t1=nullptr, double *t2=nullptr)
 Computes the closets points on two line segments, seg1 and seg2.
 
GF_API std::ostream & operator<< (std::ostream &, const GfLineSeg &)
 Output a GfLineSeg.
 

Function Documentation

◆ GfFindClosestPoints() [1/2]

GF_API bool GfFindClosestPoints ( const GfLine line,
const GfLineSeg seg,
GfVec3d p1 = nullptr,
GfVec3d p2 = nullptr,
double *  t1 = nullptr,
double *  t2 = nullptr 
)

Computes the closets points on line and seg.

The two points are returned in p1 and p2. The parametric distances of p1 and p2 along the line and segment are returned in t1 and t2.

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.

◆ GfFindClosestPoints() [2/2]

GF_API bool GfFindClosestPoints ( const GfLineSeg seg1,
const GfLineSeg seg2,
GfVec3d p1 = nullptr,
GfVec3d p2 = nullptr,
double *  t1 = nullptr,
double *  t2 = nullptr 
)

Computes the closets points on two line segments, seg1 and seg2.

The two points are returned in p1 and p2. The parametric distances of p1 and p2 along the segments are returned in t1 and t2.

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.