Kaim::PositionOnCircleArcSplineSection Class Reference

Kaim::PositionOnCircleArcSplineSection Class Reference

#include <positiononcirclearcspline.h>

Class Description

Maintains a position moving along a given CricleArc.

Public Member Functions

KyFloat32 MoveForward (KyFloat32 distance)
 Moves the position forward for the provided distance (in meter), taken along the circle if the CircleArcSplineSection is not a line segment. More...
 
KyFloat32 MoveBackward (KyFloat32 distance)
 Moves the position backward for the provided distance (in meter), taken along the circle if the CircleArcSplineSection is not a line segment. More...
 

Member Function Documentation

KyFloat32 Kaim::PositionOnCircleArcSplineSection::MoveBackward ( KyFloat32  distance)

Moves the position backward for the provided distance (in meter), taken along the circle if the CircleArcSplineSection is not a line segment.

Returns
the remaining distance to move when reached the CircleArcSplineSection start position, 0.0f otherwise (when distance was less than the distance from CircleArcSplineSection start).
KyFloat32 Kaim::PositionOnCircleArcSplineSection::MoveForward ( KyFloat32  distance)

Moves the position forward for the provided distance (in meter), taken along the circle if the CircleArcSplineSection is not a line segment.

Returns
the remaining distance to move when reached the CircleArcSplineSection end position, 0.0f otherwise (when distance was less than the distance to CircleArcSplineSection end).

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