line.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_GF_LINE_H
#define PXR_BASE_GF_LINE_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/gf/vec3d.h"
 
#include <float.h>
#include <iosfwd>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class GfLine {
 
  public:
 
    GfLine() {
    }
 
    GfLine(const GfVec3d &p0, const GfVec3d &dir ) {
        Set( p0, dir );
    }
 
    double Set(const GfVec3d &p0, const GfVec3d &dir ) {
        _p0 = p0;
        _dir = dir;
        return _dir.Normalize();
    }
 
    GfVec3d GetPoint( double t ) const { return _p0 + _dir * t; }
 
    const GfVec3d &GetDirection() const { return _dir; }
 
    GF_API
    GfVec3d FindClosestPoint(const GfVec3d &point, double *t = NULL) const;
 
    bool                operator ==(const GfLine &l) const {
        return _p0 == l._p0 &&  _dir  == l._dir;
    }
 
    bool                operator !=(const GfLine &r) const {
        return ! (*this == r);
    }
 
  private:
    GF_API
    friend bool GfFindClosestPoints( const GfLine &, const GfLine &,
                                     GfVec3d *, GfVec3d *,
                                     double *, double * );
    // Parametric description:
    //  l(t) = _p0 + t * _length * _dir;
    GfVec3d             _p0;
    GfVec3d             _dir;   
};
 
GF_API
bool GfFindClosestPoints(const GfLine &l1, const GfLine &l2,
                         GfVec3d *p1 = nullptr, GfVec3d *p2 = nullptr,
                         double *t1 = nullptr, double *t2 = nullptr);
 
GF_API std::ostream &operator<<(std::ostream&, const GfLine&);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_GF_LINE_H