KiCad PCB EDA Suite
No Matches
TOOL_EVT_UTILS Namespace Reference

Namespace TOOL_EVT_UTILS. More...


bool IsRotateToolEvt (const TOOL_EVENT &aEvt)
 Function isRotateToolEvt() More...
EDA_ANGLE GetEventRotationAngle (const PCB_BASE_EDIT_FRAME &aFrame, const TOOL_EVENT &aEvent)
 Function getEventRotationAngle() More...

Detailed Description


Utility functions for dealing with various tool events. These are free functions, so they interface with any classes exclusively via the public interfaces, so they don't need to be subsumed into the "helped" classes.

Function Documentation

◆ GetEventRotationAngle()

EDA_ANGLE TOOL_EVT_UTILS::GetEventRotationAngle ( const PCB_BASE_EDIT_FRAME aFrame,
const TOOL_EVENT aEvent 

Function getEventRotationAngle()

Helper function to get a rotation angle based on a frame's configured angle and the direction indicated by a rotation action event

aFramethe PCB edit frame to use to get the base rotation step value from
aEventthe tool event - should be a rotation action event and should have a rotation multiplier parameter
the clockwise rotation angle

Definition at line 36 of file tool_event_utils.cpp.

References PCB_BASE_EDIT_FRAME::GetRotationAngle(), IsRotateToolEvt(), and TOOL_EVENT::Parameter().

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), and EDIT_TOOL::Rotate().

◆ IsRotateToolEvt()

bool TOOL_EVT_UTILS::IsRotateToolEvt ( const TOOL_EVENT aEvt)

Function isRotateToolEvt()

aEvtevent to check
true if the event is a rotation action tool event

Definition at line 29 of file tool_event_utils.cpp.

References TOOL_EVENT::IsAction(), PCB_ACTIONS::rotateCcw, and PCB_ACTIONS::rotateCw.

Referenced by PCB_TOOL_BASE::doInteractiveItemPlacement(), and GetEventRotationAngle().