AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::klee::GeometryOperator Class Referenceabstract

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

Inheritance diagram for axom::klee::GeometryOperator:

Public Member Functions

 GeometryOperator (const TransformableGeometryProperties &startProperties)
 
virtual ~GeometryOperator ()=default
 
const TransformableGeometryPropertiesgetStartProperties () const
 
virtual TransformableGeometryProperties getEndProperties () const
 
virtual void accept (GeometryOperatorVisitor &visitor) const =0
 

Detailed Description

A GeometryOperator describes an operation to perform on the Geometry of a Shape.

There is a subclass of GeometryOperator for each operator defined in the format specification. You can figure out which one you're working with via the accept() method. This follows the standard visitor pattern.

Constructor & Destructor Documentation

◆ GeometryOperator()

axom::klee::GeometryOperator::GeometryOperator ( const TransformableGeometryProperties startProperties)
explicit

Create an operator with the given start properties

Parameters
startPropertiesthe properties before the operator is applied

◆ ~GeometryOperator()

virtual axom::klee::GeometryOperator::~GeometryOperator ( )
virtualdefault

Member Function Documentation

◆ getStartProperties()

const TransformableGeometryProperties& axom::klee::GeometryOperator::getStartProperties ( ) const
inline

Get the properties that the operator expects to start in

Returns
the properties which must be true before this operator is applied

◆ getEndProperties()

virtual TransformableGeometryProperties axom::klee::GeometryOperator::getEndProperties ( ) const
inlinevirtual

Get the properties after this operator is applied

Returns
the properties which are true after this operator is applied

Reimplemented in axom::klee::SliceOperator, axom::klee::UnitConverter, and axom::klee::CompositeOperator.

◆ accept()

virtual void axom::klee::GeometryOperator::accept ( GeometryOperatorVisitor visitor) const
pure virtual

Accept the given visitor. The appropriate visit() method will be called on the visitor based on the run-time type of this operator.

Parameters
visitorthe visitor to accept.

Implemented in axom::klee::SliceOperator, axom::klee::UnitConverter, axom::klee::Scale, axom::klee::Rotation, axom::klee::Translation, and axom::klee::CompositeOperator.


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