aikido
Public Member Functions | Friends | List of all members
aikido::statespace::SO2::State Class Referencefinal
Inheritance diagram for aikido::statespace::SO2::State:
aikido::statespace::StateSpace::State

Public Member Functions

 State (double angle=0.0)
 Constructs a state from a rotation angle. More...
 
double toAngle () const
 Returns state as a rotation angle in (-pi, pi].
 
void fromAngle (double angle)
 Sets state from a rotation angle. More...
 
Eigen::Rotation2Dd toRotation () const
 Returns state as an Eigen rotation.
 
void fromRotation (const Eigen::Rotation2Dd &rotation)
 Sets state from an Eigen rotation. More...
 

Friends

class SO2
 

Additional Inherited Members

- Protected Member Functions inherited from aikido::statespace::StateSpace::State
 State ()=default
 This is a base class that should only only be used in derived classes.
 
 ~State ()=default
 It is unsafe to call this, since it is a non-virtual destructor. More...
 

Constructor & Destructor Documentation

§ State()

aikido::statespace::SO2::State::State ( double  angle = 0.0)
explicit

Constructs a state from a rotation angle.

Parameters
[in]angleRotation angle in (-inf, inf).

Member Function Documentation

§ fromAngle()

void aikido::statespace::SO2::State::fromAngle ( double  angle)

Sets state from a rotation angle.

Parameters
[in]angleRotation angle in (-inf, inf).

§ fromRotation()

void aikido::statespace::SO2::State::fromRotation ( const Eigen::Rotation2Dd &  rotation)

Sets state from an Eigen rotation.

Parameters
[in]rotationEigen rotation.

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