KiCad PCB EDA Suite
Loading...
Searching...
No Matches
NL_SCHEMATIC_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_schematic_plugin_impl.h>

Inheritance diagram for NL_SCHEMATIC_PLUGIN_IMPL:

Public Member Functions

 NL_SCHEMATIC_PLUGIN_IMPL ()
 Initializes a new instance of the NL_SCHEMATIC_PLUGIN_IMPL.
 
virtual ~NL_SCHEMATIC_PLUGIN_IMPL ()
 
void SetCanvas (EDA_DRAW_PANEL_GAL *aViewport)
 Sets the viewport controlled by the SpaceMouse.
 
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

EDA_DRAW_PANEL_GALm_viewport2D
 
KIGFX::SCH_VIEWm_view
 
bool m_isMoving
 
double m_viewportWidth
 
VECTOR2D m_viewPosition
 

Static Private Attributes

static const wxChar * m_logTrace = wxT( "KI_TRACE_NL_SCHEMATIC_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_schematic_plugin_impl.h.

Constructor & Destructor Documentation

◆ NL_SCHEMATIC_PLUGIN_IMPL()

NL_SCHEMATIC_PLUGIN_IMPL::NL_SCHEMATIC_PLUGIN_IMPL ( )

Initializes a new instance of the NL_SCHEMATIC_PLUGIN_IMPL.

Definition at line 56 of file nl_schematic_plugin_impl.cpp.

◆ ~NL_SCHEMATIC_PLUGIN_IMPL()

NL_SCHEMATIC_PLUGIN_IMPL::~NL_SCHEMATIC_PLUGIN_IMPL ( )
virtual

Definition at line 67 of file nl_schematic_plugin_impl.cpp.

Member Function Documentation

◆ exportCommandsAndImages()

void NL_SCHEMATIC_PLUGIN_IMPL::exportCommandsAndImages ( )
private

◆ GetCameraMatrix()

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

◆ GetCoordinateSystem()

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

Definition at line 381 of file nl_schematic_plugin_impl.cpp.

◆ GetFrontView()

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

Definition at line 389 of file nl_schematic_plugin_impl.cpp.

◆ GetHitLookAt()

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

Definition at line 545 of file nl_schematic_plugin_impl.cpp.

◆ GetIsSelectionEmpty()

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

Definition at line 396 of file nl_schematic_plugin_impl.cpp.

References empty().

◆ GetIsViewPerspective()

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

Definition at line 289 of file nl_schematic_plugin_impl.cpp.

◆ GetIsViewRotatable()

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

Definition at line 403 of file nl_schematic_plugin_impl.cpp.

◆ GetModelExtents()

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

◆ GetPivotPosition()

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

Definition at line 515 of file nl_schematic_plugin_impl.cpp.

◆ GetPivotVisible()

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

Definition at line 533 of file nl_schematic_plugin_impl.cpp.

◆ GetPointerPosition()

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

◆ GetSelectionExtents()

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

Definition at line 497 of file nl_schematic_plugin_impl.cpp.

◆ GetSelectionTransform()

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

Definition at line 503 of file nl_schematic_plugin_impl.cpp.

◆ GetViewExtents()

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

◆ GetViewFOV()

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

Definition at line 485 of file nl_schematic_plugin_impl.cpp.

◆ GetViewFrustum()

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

Definition at line 491 of file nl_schematic_plugin_impl.cpp.

◆ IsUserPivot()

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

Definition at line 521 of file nl_schematic_plugin_impl.cpp.

◆ SetActiveCommand()

◆ SetCameraMatrix()

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

◆ SetCameraTarget()

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

Definition at line 575 of file nl_schematic_plugin_impl.cpp.

◆ SetCanvas()

void NL_SCHEMATIC_PLUGIN_IMPL::SetCanvas ( EDA_DRAW_PANEL_GAL aViewport)

Sets the viewport controlled by the SpaceMouse.

Parameters
aViewportis the viewport to be navigated.

Definition at line 73 of file nl_schematic_plugin_impl.cpp.

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

Referenced by NL_SCHEMATIC_PLUGIN::SetCanvas().

◆ SetFocus()

void NL_SCHEMATIC_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 99 of file nl_schematic_plugin_impl.cpp.

References m_logTrace.

Referenced by NL_SCHEMATIC_PLUGIN::SetFocus().

◆ SetHitAperture()

long NL_SCHEMATIC_PLUGIN_IMPL::SetHitAperture ( double  aAperture)
overrideprivate

Definition at line 551 of file nl_schematic_plugin_impl.cpp.

◆ SetHitDirection()

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

Definition at line 557 of file nl_schematic_plugin_impl.cpp.

◆ SetHitLookFrom()

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

Definition at line 563 of file nl_schematic_plugin_impl.cpp.

◆ SetHitSelectionOnly()

long NL_SCHEMATIC_PLUGIN_IMPL::SetHitSelectionOnly ( bool  aSelectionOnly)
overrideprivate

Definition at line 569 of file nl_schematic_plugin_impl.cpp.

◆ SetMotionFlag()

long NL_SCHEMATIC_PLUGIN_IMPL::SetMotionFlag ( bool  aValue)
overrideprivate

Definition at line 468 of file nl_schematic_plugin_impl.cpp.

References m_isMoving.

◆ SetPivotPosition()

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

Definition at line 527 of file nl_schematic_plugin_impl.cpp.

◆ SetPivotVisible()

long NL_SCHEMATIC_PLUGIN_IMPL::SetPivotVisible ( bool  aVisible)
overrideprivate

Definition at line 539 of file nl_schematic_plugin_impl.cpp.

◆ SetSelectionTransform()

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

Definition at line 509 of file nl_schematic_plugin_impl.cpp.

◆ SetSettingsChanged()

long NL_SCHEMATIC_PLUGIN_IMPL::SetSettingsChanged ( long  aChangeNumber)
overrideprivate

Definition at line 462 of file nl_schematic_plugin_impl.cpp.

◆ SetTransaction()

long NL_SCHEMATIC_PLUGIN_IMPL::SetTransaction ( long  aValue)
overrideprivate

◆ SetViewExtents()

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

◆ SetViewFOV()

long NL_SCHEMATIC_PLUGIN_IMPL::SetViewFOV ( double  aFov)
overrideprivate

Definition at line 345 of file nl_schematic_plugin_impl.cpp.

◆ SetViewFrustum()

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

Definition at line 351 of file nl_schematic_plugin_impl.cpp.

Member Data Documentation

◆ m_isMoving

bool NL_SCHEMATIC_PLUGIN_IMPL::m_isMoving
private

Definition at line 134 of file nl_schematic_plugin_impl.h.

Referenced by SetMotionFlag().

◆ m_view

KIGFX::SCH_VIEW* NL_SCHEMATIC_PLUGIN_IMPL::m_view
private

◆ m_viewport2D

EDA_DRAW_PANEL_GAL* NL_SCHEMATIC_PLUGIN_IMPL::m_viewport2D
private

◆ m_viewportWidth

double NL_SCHEMATIC_PLUGIN_IMPL::m_viewportWidth
mutableprivate

Definition at line 135 of file nl_schematic_plugin_impl.h.

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

◆ m_viewPosition

VECTOR2D NL_SCHEMATIC_PLUGIN_IMPL::m_viewPosition
mutableprivate

Definition at line 136 of file nl_schematic_plugin_impl.h.

Referenced by GetCameraMatrix(), and SetCameraMatrix().


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