Horizon
Public Member Functions | Protected Attributes | List of all members
horizon::ToolBase Class Referenceabstract

Common interface for all Tools. More...

#include <core.hpp>

Inheritance diagram for horizon::ToolBase:
horizon::ToolAddVertex horizon::ToolAssignPart horizon::ToolBendLineNet horizon::ToolDelete horizon::ToolDisconnect horizon::ToolDragKeepSlope horizon::ToolDrawArc horizon::ToolDrawDimension horizon::ToolDrawLine horizon::ToolDrawLineRectangle horizon::ToolDrawPolygon horizon::ToolDrawPolygonRectangle horizon::ToolDrawTrack horizon::ToolEditBoardHole horizon::ToolEditLineRectangle horizon::ToolEditPadParameterSet horizon::ToolEditParameterProgram horizon::ToolEditPlane horizon::ToolEditShape horizon::ToolEditSymbolPinNames horizon::ToolEditVia horizon::ToolEnterDatum horizon::ToolGenerateCourtyard horizon::ToolHelperMapSymbol horizon::ToolHelperMerge horizon::ToolHelperMove horizon::ToolImportDXF horizon::ToolLock horizon::ToolManageBuses horizon::ToolMapPackage horizon::ToolMapPin horizon::ToolMoveNetSegment horizon::ToolPlaceBoardHole horizon::ToolPlaceHole horizon::ToolPlaceJunction horizon::ToolPlacePad horizon::ToolPlaceShape horizon::ToolPlaceText horizon::ToolRotateArbitrary horizon::ToolRouteTrack horizon::ToolRouteTrackInteractive horizon::ToolSelectMore horizon::ToolSetDiffpair horizon::ToolSetViaNet horizon::ToolSmash horizon::ToolUpdateAllPlanes

Public Member Functions

 ToolBase (class Core *c, ToolID tid)
 
void set_imp_interface (class ImpInterface *i)
 
void set_transient ()
 
virtual ToolResponse begin (const ToolArgs &args)=0
 Gets called right after the constructor has finished. More...
 
virtual ToolResponse update (const ToolArgs &args)=0
 Gets called whenever the user generated some sort of input.
 
virtual bool can_begin ()
 
virtual bool is_specific ()
 
virtual bool handles_esc ()
 

Protected Attributes

Cores core
 
class ImpInterfaceimp = nullptr
 
ToolID tool_id = ToolID::NONE
 
bool is_transient = false
 

Detailed Description

Common interface for all Tools.

Member Function Documentation

◆ begin()

virtual ToolResponse horizon::ToolBase::begin ( const ToolArgs args)
pure virtual

◆ can_begin()

virtual bool horizon::ToolBase::can_begin ( )
inlinevirtual

◆ handles_esc()

virtual bool horizon::ToolBase::handles_esc ( )
inlinevirtual
Returns
true if this Tool can handle esc by itself

Reimplemented in horizon::ToolRouteTrackInteractive, horizon::ToolDrawLineNet, and horizon::ToolDrawLine.

◆ is_specific()

virtual bool horizon::ToolBase::is_specific ( )
inlinevirtual

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