karto::Pose2 Class Reference

#include <Karto.h>

List of all members.

Public Member Functions
kt_double	GetHeading () const
const Vector2< kt_double > &	GetPosition () const
kt_double	GetX () const
kt_double	GetY () const
kt_bool	operator!= (const Pose2 &rOther) const
Pose2	operator+ (const Pose2 &rOther) const
void	operator+= (const Pose2 &rOther)
Pose2	operator- (const Pose2 &rOther) const
Pose2 &	operator= (const Pose2 &rOther)
kt_bool	operator== (const Pose2 &rOther) const
	Pose2 (const Pose2 &rOther)
	Pose2 (const Pose3 &rPose)
	Pose2 (kt_double x, kt_double y, kt_double heading)
	Pose2 (const Vector2< kt_double > &rPosition, kt_double heading)
	Pose2 ()
void	SetHeading (kt_double heading)
void	SetPosition (const Vector2< kt_double > &rPosition)
void	SetX (kt_double x)
void	SetY (kt_double y)
kt_double	SquaredDistance (const Pose2 &rOther) const
Private Attributes
kt_double	m_Heading
Vector2< kt_double >	m_Position
Friends
std::ostream &	operator<< (std::ostream &rStream, const Pose2 &rPose)
std::istream &	operator>> (std::istream &rStream, const Pose2 &)

---

Detailed Description

Defines a position (x, y) in 2-dimensional space and heading.

Definition at line 1849 of file Karto.h.

---

Constructor & Destructor Documentation

karto::Pose2::Pose2

(

)

[inline]

Default Constructor

Definition at line 1855 of file Karto.h.

karto::Pose2::Pose2	(	const Vector2< kt_double > &	rPosition,
		kt_double	heading
	)			[inline]

Constructor initializing pose parameters

Parameters:

	rPosition	position
	heading	heading

Definition at line 1865 of file Karto.h.

karto::Pose2::Pose2	(	kt_double	x,
		kt_double	y,
		kt_double	heading
	)			[inline]

Constructor initializing pose parameters

Parameters:

	x	x-coordinate
	y	y-coordinate
	heading	heading

Definition at line 1877 of file Karto.h.

karto::Pose2::Pose2

(

const Pose3 &

rPose

)

[inline]

Constructs a Pose2 object from a Pose3.

Definition at line 6134 of file Karto.h.

karto::Pose2::Pose2

(

const Pose2 &

rOther

)

[inline]

Copy constructor

Definition at line 1891 of file Karto.h.

---

Member Function Documentation

kt_double karto::Pose2::GetHeading

(

)

const [inline]

Returns the heading of the pose (in radians)

Returns:

the heading of the pose

Definition at line 1956 of file Karto.h.

const Vector2<kt_double>& karto::Pose2::GetPosition

(

)

const [inline]

Returns the position

Returns:

the position of the pose

Definition at line 1938 of file Karto.h.

kt_double karto::Pose2::GetX

(

)

const [inline]

Returns the x-coordinate

Returns:

the x-coordinate of the pose

Definition at line 1902 of file Karto.h.

kt_double karto::Pose2::GetY

(

)

const [inline]

Returns the y-coordinate

Returns:

the y-coordinate of the pose

Definition at line 1920 of file Karto.h.

kt_bool karto::Pose2::operator!=

(

const Pose2 &

rOther

)

const [inline]

Inequality operator

Definition at line 1998 of file Karto.h.

Pose2 karto::Pose2::operator+

(

const Pose2 &

rOther

)

const [inline]

Binary Pose2 add

Parameters:

rOther

Returns:

Pose2 sum

Definition at line 2017 of file Karto.h.

void karto::Pose2::operator+=

(

const Pose2 &

rOther

)

[inline]

In place Pose2 add.

Definition at line 2006 of file Karto.h.

Pose2 karto::Pose2::operator-

(

const Pose2 &

rOther

)

const [inline]

Binary Pose2 subtract

Parameters:

rOther

Returns:

Pose2 difference

Definition at line 2027 of file Karto.h.

Pose2& karto::Pose2::operator=

(

const Pose2 &

rOther

)

[inline]

Assignment operator

Definition at line 1979 of file Karto.h.

kt_bool karto::Pose2::operator==

(

const Pose2 &

rOther

)

const [inline]

Equality operator

Definition at line 1990 of file Karto.h.

void karto::Pose2::SetHeading

(

kt_double

heading

)

[inline]

Sets the heading

Parameters:

the

heading of the pose

Definition at line 1965 of file Karto.h.

void karto::Pose2::SetPosition

(

const Vector2< kt_double > &

rPosition

)

[inline]

Sets the position

Parameters:

rPosition

of the pose

Definition at line 1947 of file Karto.h.

void karto::Pose2::SetX

(

kt_double

x

)

[inline]

Sets the x-coordinate

Parameters:

x

the x-coordinate of the pose

Definition at line 1911 of file Karto.h.

void karto::Pose2::SetY

(

kt_double

y

)

[inline]

Sets the y-coordinate

Parameters:

y

the y-coordinate of the pose

Definition at line 1929 of file Karto.h.

kt_double karto::Pose2::SquaredDistance

(

const Pose2 &

rOther

)

const [inline]

Definition at line 1970 of file Karto.h.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	rStream,
		const Pose2 &	rPose
	)			[friend]

Write this pose onto output stream

Parameters:

	rStream	output stream
	rPose	to read

Definition at line 2048 of file Karto.h.

std::istream& operator>>	(	std::istream &	rStream,
		const Pose2 &
	)			[friend]

Read pose from input stream

Parameters:

	rStream	input stream
	rPose	to write

Definition at line 2037 of file Karto.h.

---

Member Data Documentation

kt_double karto::Pose2::m_Heading [private]

Definition at line 2057 of file Karto.h.

Vector2<kt_double> karto::Pose2::m_Position [private]

Definition at line 2055 of file Karto.h.

---

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

• Karto.h