mrs_lib
Various reusable classes, functions and utilities for use in MRS projects
mrs_lib::geometry::Ellipse Class Reference

geometric representation of an ellipse More...

#include <shapes.h>

Public Member Functions

 Ellipse ()
 constructor for initialization without setting internal variables
 
 ~Ellipse ()
 destructor
 
 Ellipse (Eigen::Vector3d center, Eigen::Quaterniond orientation, double a, double b)
 constructor using a provided center point, orientation, major semi-axis length and minor semi-axis length More...
 
double a () const
 getter for major semi-axis More...
 
double b () const
 getter for minor semi-axis More...
 
const Eigen::Vector3d center () const
 getter for the center point More...
 
const Eigen::Quaterniond orientation () const
 getter for the orientation More...
 

Detailed Description

geometric representation of an ellipse

Constructor & Destructor Documentation

◆ Ellipse()

mrs_lib::geometry::Ellipse::Ellipse ( Eigen::Vector3d  center,
Eigen::Quaterniond  orientation,
double  a,
double  b 
)

constructor using a provided center point, orientation, major semi-axis length and minor semi-axis length

Parameters
centervector3
orientationquaternion
amajor semi-axis length
bminor semi-axis length

Member Function Documentation

◆ a()

double mrs_lib::geometry::Ellipse::a ( ) const

getter for major semi-axis

Returns
length of major semi-axis

◆ b()

double mrs_lib::geometry::Ellipse::b ( ) const

getter for minor semi-axis

Returns
length of minor semi-axis

◆ center()

const Eigen::Vector3d mrs_lib::geometry::Ellipse::center ( ) const

getter for the center point

Returns
vector3

◆ orientation()

const Eigen::Quaterniond mrs_lib::geometry::Ellipse::orientation ( ) const

getter for the orientation

Returns
quaternion

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