Kaim::PositionOnCircleArcSpline Class Reference

Kaim::PositionOnCircleArcSpline Class Reference

#include <positiononcirclearcspline.h>

Class Description

Maintains a position moving along a given CricleArcSpline.

Public Member Functions

KyResult MoveToNextSectionStart ()
 Moves this PositionOnCircleArcSpline to the next CircleArcSplineSection start position. More...
 
KyResult MoveToNextTurnSectionStart ()
 Moves this PositionOnCircleArcSpline to the next upcoming curve CircleArcSplineSection start position. More...
 
KyResult MoveToNextStraigthLineSectionStart ()
 Moves this PositionOnCircleArcSpline to the next upcoming straight CircleArcSplineSection start position. More...
 
bool IsStrictlyBefore (const PositionOnCircleArcSpline &other) const
 Compares the relative position with another PositionOnCircleArcSpline. More...
 
KyResult GetDistanceTo (const PositionOnCircleArcSpline &other, KyFloat32 &distanceToOther) const
 Computes the distance along spline from this position to other one. More...
 

Member Function Documentation

KyResult Kaim::PositionOnCircleArcSpline::GetDistanceTo ( const PositionOnCircleArcSpline other,
KyFloat32 distanceToOther 
) const

Computes the distance along spline from this position to other one.

Negative distance are allowed, they naturally express that other is before this position on spline.

Returns
KY_ERROR when positions are not on the same spline.
bool Kaim::PositionOnCircleArcSpline::IsStrictlyBefore ( const PositionOnCircleArcSpline other) const

Compares the relative position with another PositionOnCircleArcSpline.

KyResult Kaim::PositionOnCircleArcSpline::MoveToNextSectionStart ( )

Moves this PositionOnCircleArcSpline to the next CircleArcSplineSection start position.

When the position is on the last spline CircleArcSplineSection, it moves the position to this last CirckeArc end position.

KyResult Kaim::PositionOnCircleArcSpline::MoveToNextStraigthLineSectionStart ( )

Moves this PositionOnCircleArcSpline to the next upcoming straight CircleArcSplineSection start position.

KyResult Kaim::PositionOnCircleArcSpline::MoveToNextTurnSectionStart ( )

Moves this PositionOnCircleArcSpline to the next upcoming curve CircleArcSplineSection start position.


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