Cortex  10.0.0-a4
LineSegment.h
1 //
3 // Copyright (c) 2008-2011, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IECORE_LINESEGMENT_H
36 #define IECORE_LINESEGMENT_H
37 
38 #include "IECore/VectorTraits.h"
39 
40 #include "OpenEXR/ImathVec.h"
41 #include "OpenEXR/ImathPlane.h"
42 
43 namespace IECore
44 {
45 
50 template<class T>
52 {
53 
54  public :
55 
56  typedef T Point;
57  typedef typename VectorTraits<T>::BaseType BaseType;
58 
60  T p0;
61  T p1;
62 
64  LineSegment();
65  LineSegment( const T &P0, const T &P1 );
66 
68  template<class S>
69  bool operator==( const S &other ) const;
70  template<class S>
71  bool operator!=( const S &other ) const;
72 
75  template<class S>
76  const LineSegment &operator *=( const S &m );
77  template<class S>
78  LineSegment operator *( const S &m ) const;
79 
82  T operator() ( BaseType t ) const;
83 
85  T direction() const;
87  T normalizedDirection() const;
88 
90  BaseType length() const;
92  BaseType length2() const;
93 
95  T closestPointTo( const T &point ) const;
97  T closestPointTo( const T &point, BaseType &t ) const;
101  T closestPoints( const LineSegment &line, T &otherPoint ) const;
102 
103  BaseType distanceTo( const T &point ) const;
105  BaseType distance2To( const T &point ) const;
106  BaseType distanceTo( const LineSegment &line ) const;
108  BaseType distance2To( const LineSegment &line ) const;
109 
110  template<class S>
111  bool intersect( const Imath::Plane3<S> &plane, T &intersection ) const;
112  template<class S>
113  bool intersectT( const Imath::Plane3<S> &plane, BaseType &t ) const;
114 
116  static unsigned int dimensions();
117 
118 };
119 
124 
125 template<class T>
126 std::ostream &operator << ( std::ostream &o, const LineSegment<T> &lineSegment );
127 
128 } // namespace IECore
129 
130 #include "IECore/LineSegment.inl"
131 
132 #endif // IECORE_LINESEGMENT_H
BaseType length() const
Distance between p0 and p1.
bool operator==(const S &other) const
Equality.
BaseType distance2To(const T &point) const
Returns the shortest squared distance to the point.
T closestPoints(const LineSegment &line, T &otherPoint) const
T operator()(BaseType t) const
BaseType length2() const
Distance squared between p0 and p1.
LineSegment()
Uninitialised.
T closestPointTo(const T &point) const
Returns the point on this LineSeqment which is closest to the specified point.
Definition: LineSegment.h:51
T normalizedDirection() const
(p1 - p0).normalized()
T direction() const
p1 - p0
T::BaseType BaseType
The type of the components of the vector.
Definition: VectorTraits.h:51
const LineSegment & operator*=(const S &m)
static unsigned int dimensions()
Simply returns the dimensions of the underlying point type.
T p0
Line endpoints can be accessed directly.
Definition: LineSegment.h:60
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43