Trax3 3.1.0
trax track library
Loading...
Searching...
No Matches
RailRunner's End Helpers

Helper functions to get the front and back ends of an oriented element. More...

End Helpers

RailRunner::EndType trax::Front (Orientation orientation) noexcept
 Get the front end of an oriented element.
RailRunner::EndType trax::Back (Orientation orientation) noexcept
 Get the back end of an oriented element.
RailRunner::EndType trax::Front (const TrainComponent &trainComponent) noexcept
 Get the front end of a TrainComponent according to its orientation in its Train.
RailRunner::EndType trax::Back (const TrainComponent &trainComponent) noexcept
 Get the back end of a TrainComponent according to its orientation in its Train.

Detailed Description

Helper functions to get the front and back ends of an oriented element.

Function Documentation

◆ Back() [1/2]

RailRunner::EndType trax::Back ( const TrainComponent & trainComponent)
inlinenoexcept

Get the back end of a TrainComponent according to its orientation in its Train.

Parameters
trainComponentThe TrainComponent to get the end for according to its orientation in its Train.
Returns
The end type corresponding to the given orientation.

◆ Back() [2/2]

RailRunner::EndType trax::Back ( Orientation orientation)
inlinenoexcept

Get the back end of an oriented element.

Parameters
orientationThe orientation of the element.
Returns
The end type corresponding to the given orientation.

◆ Front() [1/2]

RailRunner::EndType trax::Front ( const TrainComponent & trainComponent)
inlinenoexcept

Get the front end of a TrainComponent according to its orientation in its Train.

Parameters
trainComponentThe TrainComponent to get the end for according to its orientation in its Train.
Returns
The end type corresponding to the given orientation.

◆ Front() [2/2]

RailRunner::EndType trax::Front ( Orientation orientation)
inlinenoexcept

Get the front end of an oriented element.

Parameters
orientationThe orientation of the element.
Returns
The end type corresponding to the given orientation.