KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
NL_PCBNEW_PLUGIN_IMPL Class Reference

The class that implements the accessors and mutators required for 3D navigation in an PCB_DRAW_PANEL_GAL using a SpaceMouse. More...

#include <nl_pcbnew_plugin_impl.h>

Inheritance diagram for NL_PCBNEW_PLUGIN_IMPL:

Public Member Functions

 NL_PCBNEW_PLUGIN_IMPL (PCB_DRAW_PANEL_GAL *aViewport)
 Initializes a new instance of the NL_PCBNEW_PLUGIN_IMPL.
 
virtual ~NL_PCBNEW_PLUGIN_IMPL ()
 
void SetFocus (bool aFocus)
 Set the connection to the 3Dconnexion driver to the focus state so that 3DMouse data is routed here.
 

Private Member Functions

void exportCommandsAndImages ()
 Export the invocable actions and images to the 3Dconnexion UI.
 
long GetCameraMatrix (navlib::matrix_t &aMatrix) const override
 
long GetPointerPosition (navlib::point_t &aPosition) const override
 
long GetViewExtents (navlib::box_t &aExtents) const override
 
long GetViewFOV (double &aFov) const override
 
long GetViewFrustum (navlib::frustum_t &aFrustum) const override
 
long GetIsViewPerspective (navlib::bool_t &aPerspective) const override
 
long SetCameraMatrix (const navlib::matrix_t &aMatrix) override
 
long SetViewExtents (const navlib::box_t &aExtents) override
 
long SetViewFOV (double aFov) override
 
long SetViewFrustum (const navlib::frustum_t &aFrustum) override
 
long GetModelExtents (navlib::box_t &aExtents) const override
 
long GetSelectionExtents (navlib::box_t &aExtents) const override
 
long GetSelectionTransform (navlib::matrix_t &aTransform) const override
 
long GetIsSelectionEmpty (navlib::bool_t &aEmpty) const override
 
long SetSelectionTransform (const navlib::matrix_t &aMatrix) override
 
long GetPivotPosition (navlib::point_t &aPosition) const override
 
long IsUserPivot (navlib::bool_t &aUserPivot) const override
 
long SetPivotPosition (const navlib::point_t &aPosition) override
 
long GetPivotVisible (navlib::bool_t &aVisible) const override
 
long SetPivotVisible (bool aVisible) override
 
long GetHitLookAt (navlib::point_t &aPosition) const override
 
long SetHitAperture (double aAperture) override
 
long SetHitDirection (const navlib::vector_t &aDirection) override
 
long SetHitLookFrom (const navlib::point_t &aPosition) override
 
long SetHitSelectionOnly (bool aSelectionOnly) override
 
long SetActiveCommand (std::string aCommandId) override
 
long SetSettingsChanged (long aChangeNumber) override
 
long SetMotionFlag (bool aValue) override
 
long SetTransaction (long aValue) override
 
long SetCameraTarget (const navlib::point_t &aPosition) override
 
long GetFrontView (navlib::matrix_t &aMatrix) const override
 
long GetCoordinateSystem (navlib::matrix_t &aMatrix) const override
 
long GetIsViewRotatable (navlib::bool_t &isRotatable) const override
 

Private Attributes

PCB_DRAW_PANEL_GAL * m_viewport2D
 
KIGFX::PCB_VIEW * m_view
 
bool m_isMoving
 
double m_viewportWidth
 
VECTOR2D m_viewPosition
 

Static Private Attributes

static const wxChar * m_logTrace = wxT( "KI_TRACE_NL_PCBNEW_PLUGIN" )
 Trace mask used to enable or disable the trace output of this class.
 

Detailed Description

The class that implements the accessors and mutators required for 3D navigation in an PCB_DRAW_PANEL_GAL using a SpaceMouse.

Definition at line 61 of file nl_pcbnew_plugin_impl.h.

Constructor & Destructor Documentation

◆ NL_PCBNEW_PLUGIN_IMPL()

NL_PCBNEW_PLUGIN_IMPL::NL_PCBNEW_PLUGIN_IMPL ( PCB_DRAW_PANEL_GAL *  aViewport)

Initializes a new instance of the NL_PCBNEW_PLUGIN_IMPL.

Parameters
aViewportis the viewport to be navigated.

Definition at line 57 of file nl_pcbnew_plugin_impl.cpp.

References exportCommandsAndImages(), KIGFX::VIEW::GetBoundary(), PCB_DRAW_PANEL_GAL::GetView(), BOX2< Vec >::GetWidth(), m_view, m_viewport2D, and m_viewportWidth.

◆ ~NL_PCBNEW_PLUGIN_IMPL()

NL_PCBNEW_PLUGIN_IMPL::~NL_PCBNEW_PLUGIN_IMPL ( )
virtual

Definition at line 76 of file nl_pcbnew_plugin_impl.cpp.

Member Function Documentation

◆ exportCommandsAndImages()

void NL_PCBNEW_PLUGIN_IMPL::exportCommandsAndImages ( )
private

Export the invocable actions and images to the 3Dconnexion UI.

Definition at line 131 of file nl_pcbnew_plugin_impl.cpp.

References add_category(), ACTION_MANAGER::GetActionList(), TOOL_ACTION::GetDescription(), TOOL_ACTION::GetIcon(), TOOL_ACTION::GetMenuLabel(), TOOL_ACTION::GetName(), TOOL_ACTION::GetToolName(), image, KiBitmap(), m_logTrace, and name.

Referenced by NL_PCBNEW_PLUGIN_IMPL().

◆ GetCameraMatrix()

long NL_PCBNEW_PLUGIN_IMPL::GetCameraMatrix ( navlib::matrix_t &  aMatrix) const
overrideprivate

Definition at line 225 of file nl_pcbnew_plugin_impl.cpp.

References KIGFX::VIEW::GetCenter(), KIGFX::VIEW::IsMirroredX(), KIGFX::VIEW::IsMirroredY(), m_view, m_viewPosition, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetCoordinateSystem()

long NL_PCBNEW_PLUGIN_IMPL::GetCoordinateSystem ( navlib::matrix_t &  aMatrix) const
overrideprivate

Definition at line 390 of file nl_pcbnew_plugin_impl.cpp.

◆ GetFrontView()

long NL_PCBNEW_PLUGIN_IMPL::GetFrontView ( navlib::matrix_t &  aMatrix) const
overrideprivate

Definition at line 398 of file nl_pcbnew_plugin_impl.cpp.

◆ GetHitLookAt()

long NL_PCBNEW_PLUGIN_IMPL::GetHitLookAt ( navlib::point_t &  aPosition) const
overrideprivate

Definition at line 560 of file nl_pcbnew_plugin_impl.cpp.

◆ GetIsSelectionEmpty()

long NL_PCBNEW_PLUGIN_IMPL::GetIsSelectionEmpty ( navlib::bool_t &  aEmpty) const
overrideprivate

Definition at line 405 of file nl_pcbnew_plugin_impl.cpp.

References empty().

◆ GetIsViewPerspective()

long NL_PCBNEW_PLUGIN_IMPL::GetIsViewPerspective ( navlib::bool_t &  aPerspective) const
overrideprivate

Definition at line 286 of file nl_pcbnew_plugin_impl.cpp.

◆ GetIsViewRotatable()

long NL_PCBNEW_PLUGIN_IMPL::GetIsViewRotatable ( navlib::bool_t &  isRotatable) const
overrideprivate

Definition at line 412 of file nl_pcbnew_plugin_impl.cpp.

◆ GetModelExtents()

long NL_PCBNEW_PLUGIN_IMPL::GetModelExtents ( navlib::box_t &  aExtents) const
overrideprivate

Definition at line 362 of file nl_pcbnew_plugin_impl.cpp.

References BOX2< Vec >::GetEnd(), EDA_DRAW_PANEL_GAL::GetGAL(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetWidth(), KIGFX::GAL::GetWorldScale(), m_view, m_viewport2D, BOX2< Vec >::Normalize(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetPivotPosition()

long NL_PCBNEW_PLUGIN_IMPL::GetPivotPosition ( navlib::point_t &  aPosition) const
overrideprivate

Definition at line 530 of file nl_pcbnew_plugin_impl.cpp.

◆ GetPivotVisible()

long NL_PCBNEW_PLUGIN_IMPL::GetPivotVisible ( navlib::bool_t &  aVisible) const
overrideprivate

Definition at line 548 of file nl_pcbnew_plugin_impl.cpp.

◆ GetPointerPosition()

long NL_PCBNEW_PLUGIN_IMPL::GetPointerPosition ( navlib::point_t &  aPosition) const
overrideprivate

Definition at line 247 of file nl_pcbnew_plugin_impl.cpp.

References KIGFX::VIEW_CONTROLS::GetMousePosition(), EDA_DRAW_PANEL_GAL::GetViewControls(), m_view, m_viewport2D, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetSelectionExtents()

long NL_PCBNEW_PLUGIN_IMPL::GetSelectionExtents ( navlib::box_t &  aExtents) const
overrideprivate

Definition at line 512 of file nl_pcbnew_plugin_impl.cpp.

◆ GetSelectionTransform()

long NL_PCBNEW_PLUGIN_IMPL::GetSelectionTransform ( navlib::matrix_t &  aTransform) const
overrideprivate

Definition at line 518 of file nl_pcbnew_plugin_impl.cpp.

◆ GetViewExtents()

long NL_PCBNEW_PLUGIN_IMPL::GetViewExtents ( navlib::box_t &  aExtents) const
overrideprivate

Definition at line 264 of file nl_pcbnew_plugin_impl.cpp.

References EDA_DRAW_PANEL_GAL::GetGAL(), BOX2< Vec >::GetHeight(), KIGFX::GAL::GetMaxDepth(), KIGFX::GAL::GetMinDepth(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), KIGFX::GAL::GetWorldScale(), m_view, m_viewport2D, m_viewportWidth, and scale.

◆ GetViewFOV()

long NL_PCBNEW_PLUGIN_IMPL::GetViewFOV ( double &  aFov) const
overrideprivate

Definition at line 500 of file nl_pcbnew_plugin_impl.cpp.

◆ GetViewFrustum()

long NL_PCBNEW_PLUGIN_IMPL::GetViewFrustum ( navlib::frustum_t &  aFrustum) const
overrideprivate

Definition at line 506 of file nl_pcbnew_plugin_impl.cpp.

◆ IsUserPivot()

long NL_PCBNEW_PLUGIN_IMPL::IsUserPivot ( navlib::bool_t &  aUserPivot) const
overrideprivate

Definition at line 536 of file nl_pcbnew_plugin_impl.cpp.

◆ SetActiveCommand()

long NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand ( std::string  aCommandId)
overrideprivate

Definition at line 419 of file nl_pcbnew_plugin_impl.cpp.

References ACTION_MANAGER::GetActionList(), TOOL_MANAGER::GetActionManager(), ACTION_MANAGER::GetCondition(), TOOLS_HOLDER::GetCurrentSelection(), TOOL_ACTION::GetName(), TOOL_MANAGER::GetToolHolder(), m_viewport2D, and TOOL_MANAGER::RunAction().

◆ SetCameraMatrix()

long NL_PCBNEW_PLUGIN_IMPL::SetCameraMatrix ( const navlib::matrix_t &  aMatrix)
overrideprivate

Definition at line 294 of file nl_pcbnew_plugin_impl.cpp.

References equals(), KIGFX::VIEW::GetCenter(), m_view, m_viewPosition, and KIGFX::VIEW::SetCenter().

◆ SetCameraTarget()

long NL_PCBNEW_PLUGIN_IMPL::SetCameraTarget ( const navlib::point_t &  aPosition)
overrideprivate

Definition at line 590 of file nl_pcbnew_plugin_impl.cpp.

◆ SetFocus()

void NL_PCBNEW_PLUGIN_IMPL::SetFocus ( bool  aFocus)

Set the connection to the 3Dconnexion driver to the focus state so that 3DMouse data is routed here.

Parameters
aFocusis true to set the connection active.

Definition at line 82 of file nl_pcbnew_plugin_impl.cpp.

References m_logTrace.

Referenced by NL_PCBNEW_PLUGIN::SetFocus().

◆ SetHitAperture()

long NL_PCBNEW_PLUGIN_IMPL::SetHitAperture ( double  aAperture)
overrideprivate

Definition at line 566 of file nl_pcbnew_plugin_impl.cpp.

◆ SetHitDirection()

long NL_PCBNEW_PLUGIN_IMPL::SetHitDirection ( const navlib::vector_t &  aDirection)
overrideprivate

Definition at line 572 of file nl_pcbnew_plugin_impl.cpp.

◆ SetHitLookFrom()

long NL_PCBNEW_PLUGIN_IMPL::SetHitLookFrom ( const navlib::point_t &  aPosition)
overrideprivate

Definition at line 578 of file nl_pcbnew_plugin_impl.cpp.

◆ SetHitSelectionOnly()

long NL_PCBNEW_PLUGIN_IMPL::SetHitSelectionOnly ( bool  aSelectionOnly)
overrideprivate

Definition at line 584 of file nl_pcbnew_plugin_impl.cpp.

◆ SetMotionFlag()

long NL_PCBNEW_PLUGIN_IMPL::SetMotionFlag ( bool  aValue)
overrideprivate

Definition at line 481 of file nl_pcbnew_plugin_impl.cpp.

References m_isMoving.

◆ SetPivotPosition()

long NL_PCBNEW_PLUGIN_IMPL::SetPivotPosition ( const navlib::point_t &  aPosition)
overrideprivate

Definition at line 542 of file nl_pcbnew_plugin_impl.cpp.

◆ SetPivotVisible()

long NL_PCBNEW_PLUGIN_IMPL::SetPivotVisible ( bool  aVisible)
overrideprivate

Definition at line 554 of file nl_pcbnew_plugin_impl.cpp.

◆ SetSelectionTransform()

long NL_PCBNEW_PLUGIN_IMPL::SetSelectionTransform ( const navlib::matrix_t &  aMatrix)
overrideprivate

Definition at line 524 of file nl_pcbnew_plugin_impl.cpp.

◆ SetSettingsChanged()

long NL_PCBNEW_PLUGIN_IMPL::SetSettingsChanged ( long  aChangeNumber)
overrideprivate

Definition at line 475 of file nl_pcbnew_plugin_impl.cpp.

◆ SetTransaction()

long NL_PCBNEW_PLUGIN_IMPL::SetTransaction ( long  aValue)
overrideprivate

Definition at line 489 of file nl_pcbnew_plugin_impl.cpp.

References EDA_DRAW_PANEL_GAL::ForceRefresh(), and m_viewport2D.

◆ SetViewExtents()

long NL_PCBNEW_PLUGIN_IMPL::SetViewExtents ( const navlib::box_t &  aExtents)
overrideprivate

Definition at line 321 of file nl_pcbnew_plugin_impl.cpp.

References equals(), KIGFX::VIEW::GetCenter(), KIGFX::VIEW::GetScale(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), m_view, m_viewportWidth, scale, and KIGFX::VIEW::SetScale().

◆ SetViewFOV()

long NL_PCBNEW_PLUGIN_IMPL::SetViewFOV ( double  aFov)
overrideprivate

Definition at line 350 of file nl_pcbnew_plugin_impl.cpp.

◆ SetViewFrustum()

long NL_PCBNEW_PLUGIN_IMPL::SetViewFrustum ( const navlib::frustum_t &  aFrustum)
overrideprivate

Definition at line 356 of file nl_pcbnew_plugin_impl.cpp.

Member Data Documentation

◆ m_isMoving

bool NL_PCBNEW_PLUGIN_IMPL::m_isMoving
private

Definition at line 126 of file nl_pcbnew_plugin_impl.h.

Referenced by SetMotionFlag().

◆ m_view

KIGFX::PCB_VIEW* NL_PCBNEW_PLUGIN_IMPL::m_view
private

Definition at line 125 of file nl_pcbnew_plugin_impl.h.

Referenced by GetCameraMatrix(), GetModelExtents(), GetPointerPosition(), GetViewExtents(), NL_PCBNEW_PLUGIN_IMPL(), SetCameraMatrix(), and SetViewExtents().

◆ m_viewport2D

PCB_DRAW_PANEL_GAL* NL_PCBNEW_PLUGIN_IMPL::m_viewport2D
private

Definition at line 124 of file nl_pcbnew_plugin_impl.h.

Referenced by GetModelExtents(), GetPointerPosition(), GetViewExtents(), NL_PCBNEW_PLUGIN_IMPL(), SetActiveCommand(), and SetTransaction().

◆ m_viewportWidth

double NL_PCBNEW_PLUGIN_IMPL::m_viewportWidth
mutableprivate

Definition at line 127 of file nl_pcbnew_plugin_impl.h.

Referenced by GetViewExtents(), NL_PCBNEW_PLUGIN_IMPL(), and SetViewExtents().

◆ m_viewPosition

VECTOR2D NL_PCBNEW_PLUGIN_IMPL::m_viewPosition
mutableprivate

Definition at line 128 of file nl_pcbnew_plugin_impl.h.

Referenced by GetCameraMatrix(), and SetCameraMatrix().

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