All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
line.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef GF_LINE_H
25 #define GF_LINE_H
26 
29 
30 #include "pxr/pxr.h"
31 #include "pxr/base/gf/vec3d.h"
32 
33 #include <float.h>
34 #include <iosfwd>
35 
36 PXR_NAMESPACE_OPEN_SCOPE
37 
49 class GfLine {
50 
51  public:
52 
54  GfLine() {
55  }
56 
58  GfLine(const GfVec3d &p0, const GfVec3d &dir ) {
59  Set( p0, dir );
60  }
61 
62  double Set(const GfVec3d &p0, const GfVec3d &dir ) {
63  _p0 = p0;
64  _dir = dir;
65  return _dir.Normalize();
66  }
67 
70  GfVec3d GetPoint( double t ) const { return _p0 + _dir * t; }
71 
73  const GfVec3d &GetDirection() const { return _dir; }
74 
78  GF_API
79  GfVec3d FindClosestPoint(const GfVec3d &point, double *t = NULL) const;
80 
83  bool operator ==(const GfLine &l) const {
84  return _p0 == l._p0 && _dir == l._dir;
85  }
86 
89  bool operator !=(const GfLine &r) const {
90  return ! (*this == r);
91  }
92 
93  private:
94  GF_API
95  friend bool GfFindClosestPoints( const GfLine &, const GfLine &,
96  GfVec3d *, GfVec3d *,
97  double *, double * );
98  // Parametric description:
99  // l(t) = _p0 + t * _length * _dir;
100  GfVec3d _p0;
101  GfVec3d _dir;
102 };
103 
112 GF_API
113 bool GfFindClosestPoints(const GfLine &l1, const GfLine &l2,
114  GfVec3d *p1 = nullptr, GfVec3d *p2 = nullptr,
115  double *t1 = nullptr, double *t2 = nullptr);
116 
119 GF_API std::ostream &operator<<(std::ostream&, const GfLine&);
120 
121 PXR_NAMESPACE_CLOSE_SCOPE
122 
123 #endif // GF_LINE_H
const GfVec3d & GetDirection() const
Return the normalized direction of the line.
Definition: line.h:73
GF_API GfVec3d FindClosestPoint(const GfVec3d &point, double *t=NULL) const
Returns the point on the line that is closest to point.
double Normalize(double eps=GF_MIN_VECTOR_LENGTH)
Normalizes the vector in place to unit length, returning the length before normalization.
Definition: vec3d.h:275
GF_API bool GfFindClosestPoints(const GfLine &l1, const GfLine &l2, GfVec3d *p1=nullptr, GfVec3d *p2=nullptr, double *t1=nullptr, double *t2=nullptr)
Computes the closets points between two lines.
GF_API friend bool GfFindClosestPoints(const GfLine &, const GfLine &, GfVec3d *, GfVec3d *, double *, double *)
Computes the closets points between two lines.
Basic type: 3D line.
Definition: line.h:49
bool operator!=(const GfLine &r) const
Component-wise inequality test.
Definition: line.h:89
GF_API std::ostream & operator<<(std::ostream &, const GfBBox3d &)
Output a GfBBox3d using the format [(range) matrix zeroArea].
Basic type for a vector of 3 double components.
Definition: vec3d.h:63
GfVec3d GetPoint(double t) const
Return the point on the line at ( p0 + t * dir ).
Definition: line.h:70
GfLine(const GfVec3d &p0, const GfVec3d &dir)
Construct a line from a point and a direction.
Definition: line.h:58
GfLine()
The default constructor leaves line parameters undefined.
Definition: line.h:54
bool operator==(const GfLine &l) const
Component-wise equality test.
Definition: line.h:83