ClanLib  2.3.7
Public Member Functions | Public Attributes | List of all members
CL_LineSegment3f Class Reference

3D line segment - Float More...

#include <line_segment.h>

Inheritance diagram for CL_LineSegment3f:
Inheritance graph
[legend]

Public Member Functions

 CL_LineSegment3f ()
 
 CL_LineSegment3f (const CL_LineSegment3x< float > &copy)
 
 CL_LineSegment3f (const CL_Vec3< float > &point_p, const CL_Vec3< float > &point_q)
 
Attributes
CL_Vec3< float > get_midpoint () const
 Get the midpoint of this line. More...
 
float point_distance (const CL_Vec3< float > &point, CL_Vec3< float > &dest_intercept) const
 Calculate the distance from a line segment to a point. More...
 
Operators
bool operator== (const CL_LineSegment3x< float > &line) const
 == operator. More...
 
bool operator!= (const CL_LineSegment3x< float > &line) const
 != operator. More...
 

Public Attributes

CL_Vec3< float > p
 Start point on the line. More...
 
CL_Vec3< float > q
 

Detailed Description

3D line segment - Float

A line segment has a start point and an end point

Constructor & Destructor Documentation

CL_LineSegment3f::CL_LineSegment3f ( )
inline
CL_LineSegment3f::CL_LineSegment3f ( const CL_LineSegment3x< float > &  copy)
inline
CL_LineSegment3f::CL_LineSegment3f ( const CL_Vec3< float > &  point_p,
const CL_Vec3< float > &  point_q 
)
inline

Member Function Documentation

CL_Vec3<float > CL_LineSegment3x< float >::get_midpoint ( ) const
inlineinherited

Get the midpoint of this line.

Returns
The midpoint
bool CL_LineSegment3x< float >::operator!= ( const CL_LineSegment3x< float > &  line) const
inlineinherited

!= operator.

bool CL_LineSegment3x< float >::operator== ( const CL_LineSegment3x< float > &  line) const
inlineinherited

== operator.

float CL_LineSegment3x< float >::point_distance ( const CL_Vec3< float > &  point,
CL_Vec3< float > &  dest_intercept 
) const
inherited

Calculate the distance from a line segment to a point.

Parameters
point= The point
dest_intercept= On Return: The point on the line closest to the point
Returns
The Distance

Member Data Documentation

CL_Vec3<float > CL_LineSegment3x< float >::p
inherited

Start point on the line.

CL_Vec3<float > CL_LineSegment3x< float >::q
inherited

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