mrs_lib
Various reusable classes, functions and utilities for use in MRS projects
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 More...
 
const Eigen::Vector3d center () const
 getter for the center point More...
 
const Eigen::Quaterniond orientation () const
 getter for the orientation More...
 
double r () const
 getter for cap radius More...
 
double h () const
 getter for the body height More...
 
const Ellipse getCap (int index) const
 getter for a cap corresponding to a provided index More...
 

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
centergeometric center in the middle of body height
radiusradius of the cap
heightdistance between caps
orientationquaternion

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
indexof 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: