Mapper  0.9.0
API documentation
Public Member Functions | List of all members
OpenOrienteering::CutoutOperation Class Reference

Operation to make map cutouts. More...

#include <cutout_operation.h>

Public Member Functions

 CutoutOperation (Map *map, PathObject *cutout_object, bool cut_away)
 Function object constructor. More...
 
 CutoutOperation (const CutoutOperation &)=delete
 This functor must not be copied. More...
 
 ~CutoutOperation ()
 Destructs the object. More...
 
CutoutOperationoperator= (const CutoutOperation &)=delete
 This functor must not be assigned to. More...
 
void operator() (Object *object)
 Applies the configured cutting operation on the given object. More...
 
void commit ()
 Commits the changes. More...
 

Detailed Description

Operation to make map cutouts.

This functor must not be applied to map parts other than the current one.

See CutoutTool::apply for usage example.

Constructor & Destructor Documentation

◆ CutoutOperation() [1/2]

OpenOrienteering::CutoutOperation::CutoutOperation ( Map map,
PathObject cutout_object,
bool  cut_away 
)

Function object constructor.

Setting cut_away to true inverts the tool's effect, i.e. it will remove the object parts inside the outline of cutout_object instead of the object parts outside.

◆ CutoutOperation() [2/2]

OpenOrienteering::CutoutOperation::CutoutOperation ( const CutoutOperation )
delete

This functor must not be copied.

If it is to be used via std::function, std::ref can be used to explicitly create a copyable reference.

◆ ~CutoutOperation()

OpenOrienteering::CutoutOperation::~CutoutOperation ( )

Destructs the object.

commit() must be called before.

Member Function Documentation

◆ commit()

void OpenOrienteering::CutoutOperation::commit ( )

Commits the changes.

This must always be called before the destructor. No other operations may be called after commit.

◆ operator()()

void OpenOrienteering::CutoutOperation::operator() ( Object object)

Applies the configured cutting operation on the given object.

◆ operator=()

CutoutOperation& OpenOrienteering::CutoutOperation::operator= ( const CutoutOperation )
delete

This functor must not be assigned to.


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