Horizon
Public Member Functions | List of all members
horizon::ToolDrawLine Class Reference
Inheritance diagram for horizon::ToolDrawLine:
horizon::ToolHelperLineWidthSetting horizon::ToolHelperRestrict horizon::ToolBase

Public Member Functions

 ToolDrawLine (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.
 
bool can_begin () override
 
std::set< InToolActionID > get_actions () const override
 
void apply_settings () override
 
 ToolDrawLine (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.
 
bool can_begin () override
 
std::set< InToolActionID > get_actions () const override
 
void apply_settings () override
 
- Public Member Functions inherited from horizon::ToolHelperLineWidthSetting
 ToolHelperLineWidthSetting (IDocument *c, ToolID tid)
 
const ToolSettingsget_settings_const () const override
 
ToolID get_tool_id_for_settings () const override
 
 ToolHelperLineWidthSetting (IDocument *c, ToolID tid)
 
const ToolSettingsget_settings_const () const override
 
ToolID get_tool_id_for_settings () const override
 
- Public Member Functions inherited from horizon::ToolBase
 ToolBase (class IDocument *c, ToolID tid)
 
void set_imp_interface (class ImpInterface *i)
 
void set_transient ()
 
ToolSettingsProxy get_settings_proxy ()
 
virtual bool is_specific ()
 
 ToolBase (class IDocument *c, ToolID tid)
 
void set_imp_interface (class ImpInterface *i)
 
void set_transient ()
 
ToolSettingsProxy get_settings_proxy ()
 
virtual bool is_specific ()
 

Additional Inherited Members

- Public Attributes inherited from horizon::ToolBase
std::set< SelectableRefselection
 
- Protected Types inherited from horizon::ToolHelperRestrict
enum  RestrictMode {
  X, Y, ARB, X,
  Y, ARB
}
 
enum  RestrictMode {
  X, Y, ARB, X,
  Y, ARB
}
 
- Protected Member Functions inherited from horizon::ToolHelperLineWidthSetting
ToolSettingsget_settings () override
 
void ask_line_width ()
 
ToolSettingsget_settings () override
 
void ask_line_width ()
 
- Protected Member Functions inherited from horizon::ToolHelperRestrict
void cycle_restrict_mode ()
 
void cycle_restrict_mode_xy ()
 
std::string restrict_mode_to_string () const
 
Coordi get_coord_restrict (const Coordi &old, const Coordi &cur) const
 
void cycle_restrict_mode ()
 
void cycle_restrict_mode_xy ()
 
std::string restrict_mode_to_string () const
 
Coordi get_coord_restrict (const Coordi &old, const Coordi &cur) const
 
- Protected Attributes inherited from horizon::ToolHelperLineWidthSetting
Settings settings
 
- Protected Attributes inherited from horizon::ToolBase
Documents doc
 
class ImpInterfaceimp = nullptr
 
ToolID tool_id
 
bool is_transient = false
 
- Protected Attributes inherited from horizon::ToolHelperRestrict
RestrictMode restrict_mode = RestrictMode::ARB
 

Member Function Documentation

◆ begin() [1/2]

ToolResponse horizon::ToolDrawLine::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.

◆ begin() [2/2]

ToolResponse horizon::ToolDrawLine::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() [1/2]

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

Reimplemented from horizon::ToolBase.

◆ can_begin() [2/2]

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

Reimplemented from horizon::ToolBase.


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