axom::klee::Geometry Class Reference

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/klee/Geometry.hpp>

Public Member Functions
	Geometry (const TransformableGeometryProperties &startProperties, std::string format, std::string path, std::shared_ptr< GeometryOperator const > operator_)
const std::string &	getFormat () const
const std::string &	getPath () const
bool	hasGeometry () const
	Predicate that returns true when the shape has an associated geometry. More...
std::shared_ptr< GeometryOperator const > const &	getGeometryOperator () const
const TransformableGeometryProperties &	getStartProperties () const
TransformableGeometryProperties	getEndProperties () const

Detailed Description

Represents the geometry specified in a Shape.

Constructor & Destructor Documentation

Geometry()

axom::klee::Geometry::Geometry	(	const TransformableGeometryProperties &	startProperties,
		std::string	format,
		std::string	path,
		std::shared_ptr< GeometryOperator const >	operator_
	)

Create a new Geometry object.

Parameters

startProperties	the transformable properties before any operators are applied
format	the format of the file
path	the path of the file
operator_	a possibly null operator to apply to the geometry.

Member Function Documentation

getFormat()

const std::string& axom::klee::Geometry::getFormat ( ) const

inline

Get the format in which the geometry is specified.

Returns

the format of the shape

getPath()

const std::string& axom::klee::Geometry::getPath ( ) const

inline

Get the path at which to find the specification of the geometry

Returns

the path to the geometry file

hasGeometry()

bool axom::klee::Geometry::hasGeometry ( ) const

inline

Predicate that returns true when the shape has an associated geometry.

getGeometryOperator()

std::shared_ptr<GeometryOperator const> const& axom::klee::Geometry::getGeometryOperator ( ) const

inline

Get a GeometryOperator to apply to this geometry. Can be null.

Returns

a potentially null operator to apply to the geometry

getStartProperties()

const TransformableGeometryProperties& axom::klee::Geometry::getStartProperties ( ) const

inline

Get the initial transformable properties of this geometry

Returns

the initial transformable properties of this geometry

getEndProperties()

TransformableGeometryProperties axom::klee::Geometry::getEndProperties

(

)

const

Get the final transformable properties of this geometry after operators are applied

Returns

the initial transformable properties of this geometry

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/klee/Geometry.hpp