Horizon
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
horizon::ToolPlaceJunctionBase Class Referenceabstract
Inheritance diagram for horizon::ToolPlaceJunctionBase:
horizon::ToolBase horizon::ToolPlaceJunctionT< SchematicJunction > horizon::ToolPlaceJunctionT< class BoardJunction > horizon::ToolPlaceJunctionT< Junction > horizon::ToolPlaceJunctionT< T > horizon::ToolPlaceJunctionSchematic horizon::ToolPlaceVia horizon::ToolPlaceJunction horizon::ToolPlaceBusLabel horizon::ToolPlaceBusRipper horizon::ToolPlaceNetLabel horizon::ToolPlacePowerSymbol

Public Member Functions

ToolResponse begin (const ToolArgs &args) override
 Gets called right after the constructor has finished. More...
 
ToolResponse update (const ToolArgs &args) override
 Gets called whenever the user generated some sort of input.
 
bool can_begin () override
 
std::set< InToolActionID > get_actions () const override
 
 ToolBase (class IDocument *c, ToolID tid)
 
- Public Member Functions inherited from horizon::ToolBase
 ToolBase (class IDocument *c, ToolID tid)
 
void set_imp_interface (class ImpInterface *i)
 
void set_transient ()
 
virtual ToolID get_tool_id_for_settings () const
 
virtual const ToolSettingsget_settings_const () const
 
ToolSettingsProxy get_settings_proxy ()
 
virtual void apply_settings ()
 
virtual bool is_specific ()
 

Protected Member Functions

virtual class Junctionget_junction ()=0
 
virtual void insert_junction ()=0
 
virtual bool junction_placed ()
 
void create_junction (const Coordi &c)
 
virtual void create_attached ()
 
virtual void delete_attached ()
 
virtual bool update_attached (const ToolArgs &args)
 
virtual bool begin_attached ()
 
virtual void finish ()
 
- Protected Member Functions inherited from horizon::ToolBase
virtual ToolSettingsget_settings ()
 

Protected Attributes

std::forward_list< Junction * > junctions_placed
 
- Protected Attributes inherited from horizon::ToolBase
Documents doc
 
class ImpInterfaceimp = nullptr
 
ToolID tool_id
 
bool is_transient = false
 

Additional Inherited Members

- Public Attributes inherited from horizon::ToolBase
std::set< SelectableRefselection
 

Member Function Documentation

◆ begin()

ToolResponse horizon::ToolPlaceJunctionBase::begin ( const ToolArgs args)
overridevirtual

Gets called right after the constructor has finished.

Used to get the initial placement right and set things up. For non-interactive Tools (e.g. DELETE), this one may return ToolResponse::end()

Implements horizon::ToolBase.

◆ can_begin()

bool horizon::ToolPlaceJunctionBase::can_begin ( )
overridevirtual
Returns
true if this Tool can begin in sensible way

Reimplemented from horizon::ToolBase.

Reimplemented in horizon::ToolPlaceVia, horizon::ToolPlacePowerSymbol, and horizon::ToolPlaceNetLabel.


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