Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Public Attributes | List of all members
Mezzanine::LineSegment3D Class Reference

A geometry math class for expressing a line connecting 2 points in 3D space. More...

#include <linesegment.h>

+ Collaboration diagram for Mezzanine::LineSegment3D:

Public Member Functions

 LineSegment3D ()
 Blank constructor.
 
 LineSegment3D (const Vector3 &A, const Vector3 &B)
 Descriptive constructor. More...
 
 LineSegment3D (const LineSegment3D &Other)
 Copy constructor. More...
 
Boole EpsilonEquivalent (const LineSegment3D &Other) const
 Equality comparison with some slack. More...
 
LineSegment3D GetOrderedCopy () const
 Gets a copy of this line segment with it's members ordered by length. More...
 

Public Attributes

Vector3 PointA
 The first point defining the segment.
 
Vector3 PointB
 The second point defining the segment.
 

Detailed Description

A geometry math class for expressing a line connecting 2 points in 3D space.

Definition at line 94 of file linesegment.h.

Constructor & Destructor Documentation

Mezzanine::LineSegment3D::LineSegment3D ( const Vector3 A,
const Vector3 B 
)

Descriptive constructor.

Parameters
AThe first point defining the segment.
BThe second point defining the segment.

Definition at line 82 of file linesegment.cpp.

Mezzanine::LineSegment3D::LineSegment3D ( const LineSegment3D Other)

Copy constructor.

Parameters
OtherThe other line segment to copy from.

Definition at line 87 of file linesegment.cpp.

Member Function Documentation

Boole Mezzanine::LineSegment3D::EpsilonEquivalent ( const LineSegment3D Other) const

Equality comparison with some slack.

Parameters
OtherThe other LineSegment3D to compare with.
Returns
Returns true if the two line segments are equal within the epsilon.

Definition at line 95 of file linesegment.cpp.

LineSegment3D Mezzanine::LineSegment3D::GetOrderedCopy ( ) const

Gets a copy of this line segment with it's members ordered by length.

Returns
Returns a LineSegment3D with the same values as this, but with PointA guarenteed to be the vector with the shorter length.

Definition at line 101 of file linesegment.cpp.


The documentation for this class was generated from the following files: