PLaSK library
Loading...
Searching...
No Matches
plask::GeometryObject::Changer Struct Referenceabstract

Base class for geometry changers. More...

#include <plask/geometry/object.hpp>

Inheritance diagram for plask::GeometryObject::Changer:
[legend]

Public Member Functions

virtual ~Changer ()
 Virtual destructor. Do nothing.
 
virtual bool apply (shared_ptr< GeometryObject > &to_change, Vec< 3, double > *translation=0) const =0
 Try to apply changes.
 

Detailed Description

Base class for geometry changers.

Geometry changer can change GeometryObject to another one.

Definition at line 325 of file object.hpp.

Constructor & Destructor Documentation

◆ ~Changer()

virtual plask::GeometryObject::Changer::~Changer ( )
inlinevirtual

Virtual destructor. Do nothing.

Definition at line 327 of file object.hpp.

Member Function Documentation

◆ apply()

virtual bool plask::GeometryObject::Changer::apply ( shared_ptr< GeometryObject > &  to_change,
Vec< 3, double > *  translation = 0 
) const
pure virtual

Try to apply changes.

Parameters
[in,out]to_changepointer to object which eventually will be changed (in such case pointer after call can point to another geometry object)
[out]translationoptional, extra translation for object after change (in case of 2d object caller reads only tran and up components of this vector)
Returns
true only if something was changed, false if nothing was changed (in such case changer doesn't change arguments)

Implemented in plask::GeometryObject::CompositeChanger, plask::GeometryObject::ReplaceChanger, and plask::GeometryObject::DeleteChanger.


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