KiCad PCB EDA Suite
tool_event_utils.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3 
4  * Copyright (C) 2017 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #include <tools/tool_event_utils.h>
25 
26 #include <tools/pcb_actions.h>
27 
28 #include <pcb_base_edit_frame.h>
29 
31 {
32  return aEvt.IsAction( &ACTIONS::cancelInteractive )
33  || aEvt.IsActivate()
34  || aEvt.IsCancel();
35 }
36 
38 {
39  return aEvt.IsAction( &PCB_ACTIONS::rotateCw )
40  || aEvt.IsAction( &PCB_ACTIONS::rotateCcw );
41 }
42 
43 
45  const TOOL_EVENT& aEvt )
46 {
47  wxASSERT_MSG( IsRotateToolEvt( aEvt ), "Expected rotation event" );
48 
49  const int rotAngle = aFrame.GetRotationAngle();
50  const int angleMultiplier = aEvt.Parameter<intptr_t>();
51 
52  return rotAngle * angleMultiplier;
53 }
static TOOL_ACTION cancelInteractive
Definition: actions.h:45
bool IsAction(const TOOL_ACTION *aAction) const
Function IsAction() Tests if the event contains an action issued upon activation of the given TOOL_AC...
Definition: tool_event.cpp:54
bool IsRotateToolEvt(const TOOL_EVENT &aEvt)
Function isRotateToolEvt()
static TOOL_ACTION rotateCw
Rotation of selected objects clockwise.
Definition: pcb_actions.h:90
Class TOOL_EVENT.
Definition: tool_event.h:162
bool IsActivate() const
Definition: tool_event.h:300
bool IsCancel() const
Definition: tool_event.h:295
int GetRotationAngle() const
Function GetRotationAngle() Returns the angle used for rotate operations.
bool IsCancelInteractive(const TOOL_EVENT &aEvt)
Function IsCancelInteractive()
static TOOL_ACTION rotateCcw
Rotation of selected objects counter-clockwise.
Definition: pcb_actions.h:93
T Parameter() const
Function Parameter() Returns a non-standard parameter assigned to the event.
Definition: tool_event.h:373
Common, abstract interface for edit frames.
int GetEventRotationAngle(const PCB_BASE_EDIT_FRAME &aFrame, const TOOL_EVENT &aEvt)
Function getEventRotationAngle()