Cylinder Class Reference

#include <Objects.h>

Inheritance diagram for Cylinder:

Public Member Functions
	Cylinder (double centerBase[3], double radius, double height)
void	readXML (XMLfileUnits &xmlconfig)
	Read in XML configuration for Cylinder and all its included objects. More...
std::string	getName ()
bool	isInside (double r[3])
bool	isInsideNoBorder (double r[3])
void	getBboxMin (double rmin[3])
void	getBboxMax (double rmax[3])
Public Member Functions inherited from Object
virtual std::string	getPluginName () final

Static Public Member Functions
static Object *	createInstance ()

Detailed Description

Class implementing a cyliner

Constructor & Destructor Documentation

Cylinder()

Cylinder::Cylinder	(	double	centerBase[3],
		double	radius,
		double	height
	)

Constructor

Parameters

[in]	centerBase	Center of the circle of the lower base of the cylinder.
[in]	radius	Raius of the cylinder (x-y-axis)
[in]	height	Height of the cylinder (z-axis)

Member Function Documentation

getBboxMax()

void Cylinder::getBboxMax ( double  rmax[3] )

virtual

Get upper corner of a bounding box around the object

Implements Object.

getBboxMin()

void Cylinder::getBboxMin ( double  rmin[3] )

virtual

Get lower corner of a bounding box around the object

Implements Object.

getName()

std::string Cylinder::getName ( )

inlinevirtual

Get name of object

Implements Object.

isInside()

bool Cylinder::isInside ( double  r[3] )

virtual

Determines if the given point is inside the object

Implements Object.

isInsideNoBorder()

bool Cylinder::isInsideNoBorder ( double  r[3] )

virtual

Determines if the given point is inside the object excluding it's border

Implements Object.

readXML()

void Cylinder::readXML ( XMLfileUnits &  xmlconfig )

virtual

Read in XML configuration for Cylinder and all its included objects.

The following xml object structure is handled by this method:

<object>
  <centerBase> <x>DOUBLE</x> <y>DOUBLE</y> <z>DOUBLE</z> </centerBase>
  <radius>DOUBLE</radius> <!-- x-y plane -->
  <height>DOUBLE</height> <!-- z-direction -->
</object>

Reimplemented from Object.

---

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

• src/utils/generator/Objects.h
• src/utils/generator/Objects.cpp