horizon::ToolAddPart Class Reference

Inheritance diagram for horizon::ToolAddPart:

Classes
class	ToolDataAddPart

Public Member Functions
	ToolAddPart (IDocument *c, ToolID tid)
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
Public Member Functions inherited from horizon::ToolHelperMapSymbol
std::map< ToolID, ToolSettings * >	get_all_settings () 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 ()
Public Member Functions inherited from horizon::ToolHelperMove
	ToolBase (class IDocument *c, ToolID tid)

Additional Inherited Members
Static Public Member Functions inherited from horizon::ToolHelperMove
static Orientation	transform_orientation (Orientation orientation, bool rotate, bool reverse=false)
Public Attributes inherited from horizon::ToolBase
std::set< SelectableRef >	selection
Protected Types inherited from horizon::ToolHelperRestrict
enum class	RestrictMode { X , Y , ARB , DEG45 }
Protected Member Functions inherited from horizon::ToolHelperMapSymbol
class SchematicSymbol *	map_symbol (class Component *c, const class Gate *g, const UUID &sym_default=UUID())
const class Symbol *	get_symbol_for_unit (const UUID &unit_uu, bool *auto_selected=nullptr, const UUID &sym_default=UUID())
void	change_symbol (class SchematicSymbol *schsym)
Protected Member Functions inherited from horizon::ToolBase
virtual ToolSettings *	get_settings ()
Protected Member Functions inherited from horizon::ToolHelperMove
void	move_init (const Coordi &c)
void	move_do (const Coordi &delta)
Coordi	move_do_cursor (const Coordi &c)
void	move_mirror_or_rotate (const Coordi &center, bool rotate)
Coordi	get_delta () const
Protected Member Functions inherited from horizon::ToolHelperRestrict
void	cycle_restrict_mode ()
void	cycle_restrict_mode_xy ()
void	toogle_45_degrees_mode ()
std::string	restrict_mode_to_string () const
Coordi	get_coord_restrict (const Coordi &old, const Coordi &cur) const
Protected Attributes inherited from horizon::ToolBase
Documents	doc
class ImpInterface *	imp = nullptr
const ToolID	tool_id
bool	is_transient = false
Protected Attributes inherited from horizon::ToolHelperRestrict
RestrictMode	restrict_mode = RestrictMode::ARB

Member Function Documentation

begin()

ToolResponse horizon::ToolAddPart::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::ToolAddPart::can_begin ( )

overridevirtual

Returns

true if this Tool can begin in sensible way

Reimplemented from horizon::ToolBase.

get_actions()

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

inlineoverridevirtual

Reimplemented from horizon::ToolBase.

update()

ToolResponse horizon::ToolAddPart::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_add_part.hpp
• src/core/tools/tool_add_part.cpp