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

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

Inheritance diagram for axom::klee::MatrixOperator:

Public Member Functions

virtual numerics::Matrix< double > toMatrix () const =0
 
 GeometryOperator (const TransformableGeometryProperties &startProperties)
 
const TransformableGeometryPropertiesgetStartProperties () const
 
virtual TransformableGeometryProperties getEndProperties () const
 
virtual void accept (GeometryOperatorVisitor &visitor) const =0
 

Detailed Description

A MatrixOperator is a type of GeometryOperator whose operation can be expressed as a 4x4 affine transformation matrix.

Member Function Documentation

◆ toMatrix()

virtual numerics::Matrix<double> axom::klee::MatrixOperator::toMatrix ( ) const
pure virtual

Convert this operator to its matrix representation.

Returns
a 4x4 affine transformation matrix

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

◆ GeometryOperator()

axom::klee::GeometryOperator::GeometryOperator
explicit

Create an operator with the given start properties

Parameters
startPropertiesthe properties before the operator is applied

◆ getStartProperties()

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

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
inlinevirtualinherited

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 virtualinherited

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: