horizon::ToolPlaceJunctionBase Class Reference

Inheritance diagram for horizon::ToolPlaceJunctionBase:

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. More...
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 void	apply_settings ()
virtual std::map< ToolID, ToolSettings * >	get_all_settings ()
virtual std::set< InToolActionID >	get_actions () const
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. More...
virtual bool	can_begin ()
virtual bool	is_specific ()

Protected Member Functions
virtual class Junction *	get_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 ToolSettings *	get_settings ()

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

Additional Inherited Members
Public Attributes inherited from horizon::ToolBase
std::set< SelectableRef >	selection

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.

Reimplemented in horizon::ToolPlacePowerSymbol.

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::ToolPlaceNetLabel, horizon::ToolPlacePowerSymbol, and horizon::ToolPlaceVia.

get_actions()

std::set< InToolActionID > horizon::ToolPlaceJunctionBase::get_actions ( ) const

inlineoverridevirtual

Reimplemented from horizon::ToolBase.

update()

ToolResponse horizon::ToolPlaceJunctionBase::update ( const ToolArgs &  args )

overridevirtual

Gets called whenever the user generated some sort of input.

Implements horizon::ToolBase.

---

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

• src/core/tools/tool_place_junction.hpp
• src/core/tools/tool_place_junction.cpp