axom::klee Namespace Reference

Classes
class	AffineMatrixVisitor
	Implementation of a GeometryOperatorVisitor for processing klee shape operators. More...
struct	TransformableGeometryProperties
	Properties of a geometric object which can be transformed by operators. More...
class	Geometry
	Represents the geometry specified in a Shape. More...
class	GeometryOperator
	A GeometryOperator describes an operation to perform on the Geometry of a Shape. More...
class	MatrixOperator
class	CompositeOperator
	A CompositeOperator contains a list of GeometryOperators that are applied in order. More...
class	Translation
	A Translation is a GeometryOperator which translates points. More...
class	Rotation
	A Rotation is a GeometryOperator which rotates points about a given axis. More...
class	Scale
	A GeometryOperator for scaling shapes. More...
class	UnitConverter
	An operator for converting units. More...
class	SliceOperator
class	GeometryOperatorVisitor
class	KleeError
class	Shape
class	ShapeSet
	A ShapeSet represents a document in the common shape format. More...

Enumerations
enum class	Dimensions : int { Unspecified = 0 , Two = 2 , Three = 3 }
	The dimensions that are supported for specifying operations in Klee. More...
enum class	LengthUnit {   km , m , dm , cm ,   mm , um , nm , angstrom ,   miles , feet , inches , mils ,   unspecified }

Functions
bool	operator== (const TransformableGeometryProperties &lhs, const TransformableGeometryProperties &rhs)
bool	operator!= (const TransformableGeometryProperties &lhs, const TransformableGeometryProperties &rhs)
LengthUnit	parseLengthUnits (const std::string &unitsAsString, const std::string &path)
LengthUnit	parseLengthUnits (const inlet::Proxy &unitsAsProxy)
double	getConversionFactor (LengthUnit sourceUnits, LengthUnit targetUnits)
double	convert (double sourceValue, LengthUnit sourceUnits, LengthUnit targetUnits)
template<typename T >
void	convertAll (T &values, LengthUnit sourceUnits, LengthUnit targetUnits)

Enumeration Type Documentation

Dimensions

enum axom::klee::Dimensions : int

strong

The dimensions that are supported for specifying operations in Klee.

Enumerator
Unspecified
Two
Three

LengthUnit

enum axom::klee::LengthUnit

strong

Units of length in which users can express lengths and in which client codes can request them.

Enumerator
km
m
dm
cm
mm
um
nm
angstrom
miles
feet
inches
mils
unspecified

Function Documentation

operator==()

bool axom::klee::operator==	(	const TransformableGeometryProperties &	lhs,
		const TransformableGeometryProperties &	rhs
	)

Compare transformable properties for equality.

Parameters

lhs	the left-hand-side operand
rhs	the right-hand-side operand

Returns

true if and only if all properties are equal

operator!=()

bool axom::klee::operator!= ( const TransformableGeometryProperties &  lhs, const TransformableGeometryProperties &  rhs  )

inline

Compare transformable properties for inequality.

Parameters

lhs	the left-hand-side operand
rhs	the right-hand-side operand

Returns

false if and only if all properties are equal

parseLengthUnits() [1/2]

LengthUnit axom::klee::parseLengthUnits	(	const std::string &	unitsAsString,
		const std::string &	path
	)

Convert a string to a LengthUnit.

Parameters

unitsAsString	the units as a string
path	the Path where the length units were found in the document. Used for error reporting.

Returns

the parsed units

Exceptions

KleeError

if the string does not represent known units

parseLengthUnits() [2/2]

LengthUnit axom::klee::parseLengthUnits

(

const inlet::Proxy &

unitsAsProxy

)

Convert a proxy to a LengthUnit.

Parameters

unitsAsProxy

the units as a proxy

Returns

the parsed units

Exceptions

KleeError

if the string does not represent known units

getConversionFactor()

double axom::klee::getConversionFactor	(	LengthUnit	sourceUnits,
		LengthUnit	targetUnits
	)

Get the conversion factor to convert from the given source units to the target units.

Parameters

sourceUnits	the original units
targetUnits	the units to convert to

Returns

the value by which to multiply lengths in the original units to get the target units

convert()

double axom::klee::convert	(	double	sourceValue,
		LengthUnit	sourceUnits,
		LengthUnit	targetUnits
	)

Convert a value from one set of units to another.

Parameters

sourceValue	the value of the length in the original units
sourceUnits	the original units
targetUnits	the units to convert to

Returns

the value of the length in the new units

convertAll()

template<typename T >

void axom::klee::convertAll	(	T &	values,
		LengthUnit	sourceUnits,
		LengthUnit	targetUnits
	)

Convert multiple lengths in place.

Template Parameters

T	the type containing the units. Must be iterable.

Parameters

values	the value of the length in the original units
sourceUnits	the original units
targetUnits	the units to convert to

References getConversionFactor().