lm::builder::Capsule Class Reference

A Shape representing a cylinder with hemispherical ends. More...

#include <Capsule.h>

Inheritance diagram for lm::builder::Capsule:

Collaboration diagram for lm::builder::Capsule:

Public Member Functions
	Capsule (point p1, point p2, si_dist_t radius, site_t type)
	Create a Capsule.
virtual	~Capsule ()
	Destroy the Capsule.
virtual bool	intersects (Shape *query)
	Check if two shapes intersect.
virtual bool	contains (point query)
	Determine if the shape contains the specified point.
virtual bool	contains (Shape *query)
	Determine if the shape contains the specified shape.
virtual point	getP1 ()
	Get point of first end of cylinder.
virtual point	getP2 ()
	Get point of second end of cylinder.
virtual si_dist_t	getRadius ()
	Get the radius of the cylinder/hemisphere ends.
virtual double	getVolume ()
	Get the total internal volume of the Capsule.
Public Member Functions inherited from lm::builder::Shape
	Shape (ShapeType shapeType, bounding_box boundingBox, site_t type, vector at=vector(0.0, 0.0, 1.0), vector up=vector(0.0, 1.0, 0.0))
	Create a Shape.
virtual	~Shape ()
	Destroy the Shape.
virtual bool	boundingBoxesIntersect (Shape *query)
	Checks if another shape's bounding box interstects with this shape's bounding box.
virtual bounding_box	getBoundingBox ()
	Get the bounding box.
virtual site_t	getType ()
	Get the site type associated with the shape.
virtual ShapeType	getShapeType ()
	Get the shape type.
virtual void	discretizeTo (lm::rdme::Lattice *lattice)
	Discretize the object to the specified lattice.

Protected Attributes
point	p1
point	p2
si_dist_t	radius
si_dist_t	length
Protected Attributes inherited from lm::builder::Shape
ShapeType	shapeType
bounding_box	boundingBox
site_t	type
vector	at
vector	up
matrix	rotation

Additional Inherited Members
Public Types inherited from lm::builder::Shape
enum	ShapeType {   SPHERE = 1 , HEMISPHERE = 2 , CYLINDER = 3 , CAPSULE = 4 ,   CUBOID = 5 , CAPSULE_SHELL = 6 , UNION = 7 , DIFFERENCE = 8 ,   INTERSECTION = 9 , MESH = 10 , TORUS = 11 , ELLIPSE = 12 ,   CONE = 13 , UNIONSET = 14 }
	Possible shape types that can be used in Lattice Microbes. More...
Protected Member Functions inherited from lm::builder::Shape
double	integrateToPercentThreshold (double percent)
double	integrateToCount (int count)
virtual point	minBounds (point p1, point p2) const
virtual point	maxBounds (point p1, point p2) const

Detailed Description

A Shape representing a cylinder with hemispherical ends.

Constructor & Destructor Documentation

Capsule()

lm::builder::Capsule::Capsule	(	point	p1,
		point	p2,
		si_dist_t	radius,
		site_t	type )

Create a Capsule.

Parameters

p1	Point of first end of cylinder
p2	Point of second end of cylinder
radius	Radius of the capsule cylinder/hemispheres ends
type	Site type of the capsule

Here is the call graph for this function:

Here is the caller graph for this function:

~Capsule()

lm::builder::Capsule::~Capsule ( )

virtual

Destroy the Capsule.

Member Function Documentation

contains() [1/2]

bool lm::builder::Capsule::contains ( point query )

virtual

Determine if the shape contains the specified point.

Parameters

query

Point to test

Returns

true/false

Implements lm::builder::Shape.

Here is the call graph for this function:

contains() [2/2]

bool lm::builder::Capsule::contains ( Shape * query )

virtual

Determine if the shape contains the specified shape.

Parameters

query

Shape to test

Returns

true/false

Implements lm::builder::Shape.

Here is the call graph for this function:

getP1()

virtual point lm::builder::Capsule::getP1 ( )

inlinevirtual

Get point of first end of cylinder.

Here is the caller graph for this function:

getP2()

virtual point lm::builder::Capsule::getP2 ( )

inlinevirtual

Get point of second end of cylinder.

Here is the caller graph for this function:

getRadius()

virtual si_dist_t lm::builder::Capsule::getRadius ( )

inlinevirtual

Get the radius of the cylinder/hemisphere ends.

Here is the caller graph for this function:

getVolume()

double lm::builder::Capsule::getVolume ( )

virtual

Get the total internal volume of the Capsule.

Implements lm::builder::Shape.

intersects()

bool lm::builder::Capsule::intersects ( Shape * query )

virtual

Check if two shapes intersect.

Parameters

query

The other shape to check

Returns

true/false

Implements lm::builder::Shape.

Here is the call graph for this function:

Member Data Documentation

length

si_dist_t lm::builder::Capsule::length

protected

p1

point lm::builder::Capsule::p1

protected

p2

point lm::builder::Capsule::p2

protected

radius

si_dist_t lm::builder::Capsule::radius

protected

---

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

• /data2/LM_zls_github/Lattice-Microbes/src/builder/Capsule.h
• /data2/LM_zls_github/Lattice-Microbes/src/builder/Capsule.cpp