lineSeg.h File Reference

#include "pxr/pxr.h"
#include "pxr/base/gf/line.h"
#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/api.h"
#include <float.h>
#include <iosfwd>

Include dependency graph for lineSeg.h:

Go to the source code of this file.

Classes
class	GfLineSeg

Functions
GF_API bool	GfFindClosestPoints (const GfLine &line, const GfLineSeg &seg, GfVec3d *p1=nullptr, GfVec3d *p2=nullptr, double *t1=nullptr, double *t2=nullptr)
GF_API bool	GfFindClosestPoints (const GfLineSeg &seg1, const GfLineSeg &seg2, GfVec3d *p1=nullptr, GfVec3d *p2=nullptr, double *t1=nullptr, double *t2=nullptr)
GF_API std::ostream &	operator<< (std::ostream &, const GfLineSeg &)

Function Documentation

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.

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.

GF_API std::ostream& operator<<	(	std::ostream &	,
		const GfLineSeg &
	)

Output a GfLineSeg.