ObjectSubtractor Class Reference

#include <Objects.h>

Inheritance diagram for ObjectSubtractor:

Public Member Functions
	ObjectSubtractor (std::shared_ptr< Object > original_ob, std::shared_ptr< Object > subtract_ob)
void	readXML (XMLfileUnits &xmlconfig)
	Read in XML configuration for ObjectSubtractor 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

Abstract class to subtract one object from another

Note

Boundaries of the subtrahend object lying within the minuend object are included in the resulting object.

Constructor & Destructor Documentation

ObjectSubtractor()

ObjectSubtractor::ObjectSubtractor ( std::shared_ptr< Object >  original_ob, std::shared_ptr< Object >  subtract_ob  )

inline

Constructor

Parameters

[in]	original_ob	The original object.
[in]	subtract_ob	The object which shall be subtract from the original object.

Member Function Documentation

getBboxMax()

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

inlinevirtual

Get upper corner of a bounding box around the object

Implements Object.

getBboxMin()

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

inlinevirtual

Get lower corner of a bounding box around the object

Implements Object.

getName()

std::string ObjectSubtractor::getName ( )

inlinevirtual

Get name of object

Implements Object.

isInside()

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

inlinevirtual

Determines if the given point is inside the object

Implements Object.

isInsideNoBorder()

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

inlinevirtual

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

Implements Object.

readXML()

void ObjectSubtractor::readXML ( XMLfileUnits &  xmlconfig )

virtual

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

The following xml object structure is handled by this method:

<object>
  <object1 type="..."> <!-- (minuend) ... --> </object1>
  <object2 type="..."> <!-- (subtrahend) ... --> </object2>
</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