lm::builder::Cone Class Reference

A Shape that represents a Cone. More...

#include <Cone.h>

Inheritance diagram for lm::builder::Cone:

Collaboration diagram for lm::builder::Cone:

Public Member Functions
	Cone (point center, si_dist_t radius, si_dist_t height, site_t type, vector normal=vector(1.0, 0.0, 0.0))
	Create a Cone.
virtual	~Cone ()
	Destroy the Sphere.
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	getCenter ()
	Get the center of the cone.
virtual si_dist_t	getRadius ()
	Get the radius of the cone.
virtual si_dist_t	getHeight ()
	Get the height of the cone.
virtual double	getVolume ()
	Get the volume bounded by the cone.
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	center
si_dist_t	radius
si_dist_t	height
vector	normal
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 that represents a Cone.

Constructor & Destructor Documentation

Cone()

lm::builder::Cone::Cone	(	point	center,
		si_dist_t	radius,
		si_dist_t	height,
		site_t	type,
		vector	normal = vector(1.0,0.0,0.0) )

Create a Cone.

Parameters

center	Point center of the circle of the base
radius	Radius of the base
height	Height of the cone
type	The type of the sites within the cone
normal	Normal to the center of the cone base

Here is the call graph for this function:

~Cone()

lm::builder::Cone::~Cone ( )

virtual

Destroy the Sphere.

Member Function Documentation

contains() [1/2]

bool lm::builder::Cone::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::Cone::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:

getCenter()

virtual point lm::builder::Cone::getCenter ( )

inlinevirtual

Get the center of the cone.

Here is the caller graph for this function:

getHeight()

virtual si_dist_t lm::builder::Cone::getHeight ( )

inlinevirtual

Get the height of the cone.

Here is the caller graph for this function:

getRadius()

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

inlinevirtual

Get the radius of the cone.

Here is the caller graph for this function:

getVolume()

double lm::builder::Cone::getVolume ( )

virtual

Get the volume bounded by the cone.

Implements lm::builder::Shape.

intersects()

bool lm::builder::Cone::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

center

point lm::builder::Cone::center

protected

height

si_dist_t lm::builder::Cone::height

protected

normal

vector lm::builder::Cone::normal

protected

radius

si_dist_t lm::builder::Cone::radius

protected

---

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

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