Loading...
Searching...
No Matches
ompl::base::SE3StateSpace::StateType Class Reference

A state in SE(3): position = (x, y, z), quaternion = (x, y, z, w) More...

#include <ompl/base/spaces/SE3StateSpace.h>

Inheritance diagram for ompl::base::SE3StateSpace::StateType:

Public Member Functions

double getX () const
 Get the X component of the state. More...
 
double getY () const
 Get the Y component of the state. More...
 
double getZ () const
 Get the Z component of the state. More...
 
const SO3StateSpace::StateTyperotation () const
 Get the rotation component of the state. More...
 
SO3StateSpace::StateTyperotation ()
 Get the rotation component of the state and allow changing it as well. More...
 
void setX (double x)
 Set the X component of the state. More...
 
void setY (double y)
 Set the Y component of the state. More...
 
void setZ (double z)
 Set the Z component of the state. More...
 
void setXYZ (double x, double y, double z)
 Set the X, Y and Z components of the state. More...
 
- Public Member Functions inherited from ompl::base::CompoundState
template<class T >
const T * as (unsigned int index) const
 Cast a component of this instance to a desired type. More...
 
template<class T >
T * as (const unsigned int index)
 Cast a component of this instance to a desired type. More...
 
const Stateoperator[] (unsigned int i) const
 Access const element ith component. This does not check whether the index is within bounds. More...
 
Stateoperator[] (unsigned int i)
 Access element ith component. This does not check whether the index is within bounds. More...
 
- Public Member Functions inherited from ompl::base::State
template<class T >
const T * as () const
 Cast this instance to a desired type. More...
 
template<class T >
T * as ()
 Cast this instance to a desired type. More...
 

Additional Inherited Members

- Public Attributes inherited from ompl::base::CompoundState
State ** components {nullptr}
 The components that make up a compound state. More...
 

Detailed Description

A state in SE(3): position = (x, y, z), quaternion = (x, y, z, w)

Definition at line 53 of file SE3StateSpace.h.

Member Function Documentation

◆ getX()

double ompl::base::SE3StateSpace::StateType::getX ( ) const
inline

Get the X component of the state.

Definition at line 59 of file SE3StateSpace.h.

◆ getY()

double ompl::base::SE3StateSpace::StateType::getY ( ) const
inline

Get the Y component of the state.

Definition at line 65 of file SE3StateSpace.h.

◆ getZ()

double ompl::base::SE3StateSpace::StateType::getZ ( ) const
inline

Get the Z component of the state.

Definition at line 71 of file SE3StateSpace.h.

◆ rotation() [1/2]

SO3StateSpace::StateType & ompl::base::SE3StateSpace::StateType::rotation ( )
inline

Get the rotation component of the state and allow changing it as well.

Definition at line 83 of file SE3StateSpace.h.

◆ rotation() [2/2]

const SO3StateSpace::StateType & ompl::base::SE3StateSpace::StateType::rotation ( ) const
inline

Get the rotation component of the state.

Definition at line 77 of file SE3StateSpace.h.

◆ setX()

void ompl::base::SE3StateSpace::StateType::setX ( double  x)
inline

Set the X component of the state.

Definition at line 89 of file SE3StateSpace.h.

◆ setXYZ()

void ompl::base::SE3StateSpace::StateType::setXYZ ( double  x,
double  y,
double  z 
)
inline

Set the X, Y and Z components of the state.

Definition at line 107 of file SE3StateSpace.h.

◆ setY()

void ompl::base::SE3StateSpace::StateType::setY ( double  y)
inline

Set the Y component of the state.

Definition at line 95 of file SE3StateSpace.h.

◆ setZ()

void ompl::base::SE3StateSpace::StateType::setZ ( double  z)
inline

Set the Z component of the state.

Definition at line 101 of file SE3StateSpace.h.


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