mrs_lib::geometry::Cylinder Class Reference

geometric representation of a cylinder More...

#include <shapes.h>

Public Types
enum	{ BOTTOM = 0 , TOP = 1 }
	cap indexing

Public Member Functions
	Cylinder ()
	constructor without setting the internal variables
	~Cylinder ()
	destructor
	Cylinder (Eigen::Vector3d center, double radius, double height, Eigen::Quaterniond orientation)
	constructor using a given center point, radius, height and orietnation
const Eigen::Vector3d	center () const
	getter for the center point
const Eigen::Quaterniond	orientation () const
	getter for the orientation
double	r () const
	getter for cap radius
double	h () const
	getter for the body height
const Ellipse	getCap (int index) const
	getter for a cap corresponding to a provided index

Detailed Description

geometric representation of a cylinder

Constructor & Destructor Documentation

Cylinder()

mrs_lib::geometry::Cylinder::Cylinder	(	Eigen::Vector3d	center,
		double	radius,
		double	height,
		Eigen::Quaterniond	orientation
	)

constructor using a given center point, radius, height and orietnation

Parameters

center	geometric center in the middle of body height
radius	radius of the cap
height	distance between caps
orientation	quaternion

Member Function Documentation

center()

const Eigen::Vector3d mrs_lib::geometry::Cylinder::center

(

)

const

getter for the center point

Returns

vector3

getCap()

const Ellipse mrs_lib::geometry::Cylinder::getCap

(

int

index

)

const

getter for a cap corresponding to a provided index

Parameters

index

of the cap

Returns

ellipse representing the cap

h()

double mrs_lib::geometry::Cylinder::h

(

)

const

getter for the body height

Returns

body height

orientation()

const Eigen::Quaterniond mrs_lib::geometry::Cylinder::orientation

(

)

const

getter for the orientation

Returns

quaternion

r()

double mrs_lib::geometry::Cylinder::r

(

)

const

getter for cap radius

Returns

radius of the cap

---

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

• include/mrs_lib/geometry/shapes.h
• src/geometry/shapes.cpp