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

#include <nl_3d_viewer_plugin_impl.h>

Inheritance diagram for NL_3D_VIEWER_PLUGIN_IMPL:

Public Member Functions
	NL_3D_VIEWER_PLUGIN_IMPL (EDA_3D_CANVAS *aCanvas, const std::string &aProfileHint)
	Initializes a new instance of the NL_3DVIEWER_PLUGIN.

virtual	~NL_3D_VIEWER_PLUGIN_IMPL ()

void	SetFocus (bool aFocus=true)
	Set the connection to the 3Dconnexion driver to the focus state so that 3DMouse data is routed here.

EDA_3D_CANVAS *	GetCanvas () const
	Get the m_canvas pointer.

void	Connect ()
	Connect plugin implementation to the driver.

Private Member Functions
virtual 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_3D_CANVAS *	m_canvas

TRACK_BALL *	m_camera

bool	m_capIsMoving

double	m_newWidth

SFVEC3F	m_rayOrigin

SFVEC3F	m_rayDirection

glm::mat4	m_cameraMatrix

Static Private Attributes
static const wxChar *	m_logTrace = wxT( "KI_TRACE_NL_3D_VIEWER_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 EDA_3D_CANVAS using a SpaceMouse.

Definition at line 57 of file nl_3d_viewer_plugin_impl.h.

Constructor & Destructor Documentation

◆ NL_3D_VIEWER_PLUGIN_IMPL()

NL_3D_VIEWER_PLUGIN_IMPL::NL_3D_VIEWER_PLUGIN_IMPL	(	EDA_3D_CANVAS *	aCanvas,
		const std::string &	aProfileHint
	)

Initializes a new instance of the NL_3DVIEWER_PLUGIN.

Parameters

aCanvas	is the viewport to be navigated.
aProfileHint	tells the 3DConnexion UI which profile to use.

Definition at line 76 of file nl_3d_viewer_plugin_impl.cpp.

References HIDPI_GL_3D_CANVAS::GetCamera(), m_camera, and m_canvas.

◆ ~NL_3D_VIEWER_PLUGIN_IMPL()

NL_3D_VIEWER_PLUGIN_IMPL::~NL_3D_VIEWER_PLUGIN_IMPL ( )

virtual

Definition at line 88 of file nl_3d_viewer_plugin_impl.cpp.

Member Function Documentation

◆ Connect()

void NL_3D_VIEWER_PLUGIN_IMPL::Connect ( )

Connect plugin implementation to the driver.

Definition at line 107 of file nl_3d_viewer_plugin_impl.cpp.

References exportCommandsAndImages().

◆ exportCommandsAndImages()

void NL_3D_VIEWER_PLUGIN_IMPL::exportCommandsAndImages ( )

privatevirtual

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

Reimplemented in NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL.

Definition at line 153 of file nl_3d_viewer_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 Connect().

◆ GetCameraMatrix()

long NL_3D_VIEWER_PLUGIN_IMPL::GetCameraMatrix ( navlib::matrix_t & aMatrix ) const

overrideprivate

Definition at line 246 of file nl_3d_viewer_plugin_impl.cpp.

References CAMERA::GetViewMatrix(), m_camera, and m_cameraMatrix.

◆ GetCanvas()

EDA_3D_CANVAS * NL_3D_VIEWER_PLUGIN_IMPL::GetCanvas ( ) const

Get the m_canvas pointer.

Definition at line 101 of file nl_3d_viewer_plugin_impl.cpp.

References m_canvas.

Referenced by NL_FOOTPRINT_PROPERTIES_PLUGIN_IMPL::GetModelExtents().

◆ GetCoordinateSystem()

long NL_3D_VIEWER_PLUGIN_IMPL::GetCoordinateSystem ( navlib::matrix_t & aMatrix ) const

overrideprivate

Definition at line 658 of file nl_3d_viewer_plugin_impl.cpp.

◆ GetFrontView()

long NL_3D_VIEWER_PLUGIN_IMPL::GetFrontView ( navlib::matrix_t & aMatrix ) const

overrideprivate

Definition at line 651 of file nl_3d_viewer_plugin_impl.cpp.

◆ GetHitLookAt()

long NL_3D_VIEWER_PLUGIN_IMPL::GetHitLookAt ( navlib::point_t & aPosition ) const

overrideprivate

Definition at line 502 of file nl_3d_viewer_plugin_impl.cpp.

References RAY::at(), BOARD_ADAPTER::GetBBox(), EDA_3D_CANVAS::GetBoardAdapter(), RAY::Init(), BBOX_3D::Intersect(), m_canvas, m_rayDirection, and m_rayOrigin.

◆ GetIsSelectionEmpty()

long NL_3D_VIEWER_PLUGIN_IMPL::GetIsSelectionEmpty ( navlib::bool_t & aEmpty ) const

overrideprivate

Definition at line 436 of file nl_3d_viewer_plugin_impl.cpp.

References empty().

◆ GetIsViewPerspective()

long NL_3D_VIEWER_PLUGIN_IMPL::GetIsViewPerspective ( navlib::bool_t & aPerspective ) const

overrideprivate

Definition at line 311 of file nl_3d_viewer_plugin_impl.cpp.

References CAMERA::GetProjection(), and m_camera.

◆ GetIsViewRotatable()

long NL_3D_VIEWER_PLUGIN_IMPL::GetIsViewRotatable ( navlib::bool_t & isRotatable ) const

overrideprivate

Definition at line 666 of file nl_3d_viewer_plugin_impl.cpp.

◆ GetModelExtents()

long NL_3D_VIEWER_PLUGIN_IMPL::GetModelExtents ( navlib::box_t & aExtents ) const

overrideprivate

Definition at line 413 of file nl_3d_viewer_plugin_impl.cpp.

References BOARD_ADAPTER::GetBBox(), EDA_3D_CANVAS::GetBoardAdapter(), m_canvas, BBOX_3D::Max(), and BBOX_3D::Min().

◆ GetPivotPosition()

long NL_3D_VIEWER_PLUGIN_IMPL::GetPivotPosition ( navlib::point_t & aPosition ) const

overrideprivate

Definition at line 450 of file nl_3d_viewer_plugin_impl.cpp.

References CAMERA::GetLookAtPos(), and m_camera.

◆ GetPivotVisible()

long NL_3D_VIEWER_PLUGIN_IMPL::GetPivotVisible ( navlib::bool_t & aVisible ) const

overrideprivate

Definition at line 484 of file nl_3d_viewer_plugin_impl.cpp.

References EDA_3D_CANVAS::GetRender3dmousePivot(), and m_canvas.

◆ GetPointerPosition()

long NL_3D_VIEWER_PLUGIN_IMPL::GetPointerPosition ( navlib::point_t & aPosition ) const

overrideprivate

Definition at line 258 of file nl_3d_viewer_plugin_impl.cpp.

References m_camera, and CAMERA::MakeRayAtCurrentMousePosition().

◆ GetSelectionExtents()

long NL_3D_VIEWER_PLUGIN_IMPL::GetSelectionExtents ( navlib::box_t & aExtents ) const

overrideprivate

Definition at line 424 of file nl_3d_viewer_plugin_impl.cpp.

◆ GetSelectionTransform()

long NL_3D_VIEWER_PLUGIN_IMPL::GetSelectionTransform ( navlib::matrix_t & aTransform ) const

overrideprivate

Definition at line 430 of file nl_3d_viewer_plugin_impl.cpp.

◆ GetViewExtents()

long NL_3D_VIEWER_PLUGIN_IMPL::GetViewExtents ( navlib::box_t & aExtents ) const

overrideprivate

Definition at line 269 of file nl_3d_viewer_plugin_impl.cpp.

References CAMERA_FRUSTUM::farD, CAMERA_FRUSTUM::fh, CAMERA_FRUSTUM::fw, CAMERA::GetFrustum(), CAMERA::GetProjection(), m_camera, and CAMERA_FRUSTUM::nearD.

◆ GetViewFOV()

long NL_3D_VIEWER_PLUGIN_IMPL::GetViewFOV ( double & aFov ) const

overrideprivate

Definition at line 286 of file nl_3d_viewer_plugin_impl.cpp.

References CAMERA_FRUSTUM::angle, CAMERA::GetFrustum(), and m_camera.

◆ GetViewFrustum()

long NL_3D_VIEWER_PLUGIN_IMPL::GetViewFrustum ( navlib::frustum_t & aFrustum ) const

overrideprivate

Definition at line 295 of file nl_3d_viewer_plugin_impl.cpp.

References CAMERA_FRUSTUM::farD, CAMERA::GetFrustum(), CAMERA::GetProjection(), m_camera, CAMERA_FRUSTUM::nearD, CAMERA_FRUSTUM::nh, and CAMERA_FRUSTUM::nw.

◆ IsUserPivot()

long NL_3D_VIEWER_PLUGIN_IMPL::IsUserPivot ( navlib::bool_t & aUserPivot ) const

overrideprivate

Definition at line 460 of file nl_3d_viewer_plugin_impl.cpp.

◆ SetActiveCommand()

long NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand ( std::string aCommandId )

overrideprivate

Definition at line 551 of file nl_3d_viewer_plugin_impl.cpp.

References ACTION_MANAGER::GetActionList(), TOOL_MANAGER::GetActionManager(), ACTION_MANAGER::GetCondition(), TOOLS_HOLDER::GetCurrentSelection(), TOOL_ACTION::GetName(), TOOL_MANAGER::GetToolHolder(), TOOLS_HOLDER::GetToolManager(), m_canvas, EDA_3D_CANVAS::Request_refresh(), and TOOL_MANAGER::RunAction().

◆ SetCameraMatrix()

long NL_3D_VIEWER_PLUGIN_IMPL::SetCameraMatrix ( const navlib::matrix_t & aMatrix )

overrideprivate

Definition at line 319 of file nl_3d_viewer_plugin_impl.cpp.

References equals(), CAMERA::GetLookAtPos(), CAMERA::GetProjection(), CAMERA::GetViewMatrix(), m_camera, m_cameraMatrix, CAMERA::SetViewMatrix(), and CAMERA::Update().

◆ SetCameraTarget()

long NL_3D_VIEWER_PLUGIN_IMPL::SetCameraTarget ( const navlib::point_t & aPosition )

overrideprivate

Definition at line 645 of file nl_3d_viewer_plugin_impl.cpp.

◆ SetFocus()

void NL_3D_VIEWER_PLUGIN_IMPL::SetFocus ( bool aFocus = true )

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

Parameters

aFocus is true to set the connection active.

Definition at line 94 of file nl_3d_viewer_plugin_impl.cpp.

References m_logTrace.

◆ SetHitAperture()

long NL_3D_VIEWER_PLUGIN_IMPL::SetHitAperture ( double aAperture )

overrideprivate

Definition at line 523 of file nl_3d_viewer_plugin_impl.cpp.

◆ SetHitDirection()

long NL_3D_VIEWER_PLUGIN_IMPL::SetHitDirection ( const navlib::vector_t & aDirection )

overrideprivate

Definition at line 529 of file nl_3d_viewer_plugin_impl.cpp.

References m_rayDirection.

◆ SetHitLookFrom()

long NL_3D_VIEWER_PLUGIN_IMPL::SetHitLookFrom ( const navlib::point_t & aPosition )

overrideprivate

Definition at line 537 of file nl_3d_viewer_plugin_impl.cpp.

References m_rayOrigin.

◆ SetHitSelectionOnly()

long NL_3D_VIEWER_PLUGIN_IMPL::SetHitSelectionOnly ( bool aSelectionOnly )

overrideprivate

Definition at line 545 of file nl_3d_viewer_plugin_impl.cpp.

◆ SetMotionFlag()

long NL_3D_VIEWER_PLUGIN_IMPL::SetMotionFlag ( bool aValue )

overrideprivate

Definition at line 622 of file nl_3d_viewer_plugin_impl.cpp.

References m_capIsMoving.

◆ SetPivotPosition()

long NL_3D_VIEWER_PLUGIN_IMPL::SetPivotPosition ( const navlib::point_t & aPosition )

overrideprivate

Definition at line 468 of file nl_3d_viewer_plugin_impl.cpp.

References m_camera, m_canvas, EDA_3D_CANVAS::Request_refresh(), EDA_3D_CANVAS::Set3dmousePivotPos(), and CAMERA::SetLookAtPos_T1().

◆ SetPivotVisible()

long NL_3D_VIEWER_PLUGIN_IMPL::SetPivotVisible ( bool aVisible )

overrideprivate

Definition at line 492 of file nl_3d_viewer_plugin_impl.cpp.

References m_canvas, EDA_3D_CANVAS::Request_refresh(), and EDA_3D_CANVAS::SetRender3dmousePivot().

◆ SetSelectionTransform()

long NL_3D_VIEWER_PLUGIN_IMPL::SetSelectionTransform ( const navlib::matrix_t & aMatrix )

overrideprivate

Definition at line 444 of file nl_3d_viewer_plugin_impl.cpp.

◆ SetSettingsChanged()

long NL_3D_VIEWER_PLUGIN_IMPL::SetSettingsChanged ( long aChangeNumber )

overrideprivate

Definition at line 616 of file nl_3d_viewer_plugin_impl.cpp.

◆ SetTransaction()

long NL_3D_VIEWER_PLUGIN_IMPL::SetTransaction ( long aValue )

overrideprivate

Definition at line 630 of file nl_3d_viewer_plugin_impl.cpp.

References m_canvas, m_logTrace, and EDA_3D_CANVAS::Request_refresh().

◆ SetViewExtents()

long NL_3D_VIEWER_PLUGIN_IMPL::SetViewExtents ( const navlib::box_t & aExtents )

overrideprivate

Definition at line 377 of file nl_3d_viewer_plugin_impl.cpp.

References CAMERA::GetFrustum(), CAMERA::GetViewMatrix(), CAMERA::GetZoom(), m_camera, m_cameraMatrix, CAMERA_FRUSTUM::nw, zoom, and CAMERA::Zoom().

◆ SetViewFOV()

long NL_3D_VIEWER_PLUGIN_IMPL::SetViewFOV ( double aFov )

overrideprivate

Definition at line 401 of file nl_3d_viewer_plugin_impl.cpp.

◆ SetViewFrustum()

long NL_3D_VIEWER_PLUGIN_IMPL::SetViewFrustum ( const navlib::frustum_t & aFrustum )

overrideprivate

Definition at line 407 of file nl_3d_viewer_plugin_impl.cpp.

Member Data Documentation

◆ m_camera

TRACK_BALL* NL_3D_VIEWER_PLUGIN_IMPL::m_camera

private

Definition at line 133 of file nl_3d_viewer_plugin_impl.h.

Referenced by GetCameraMatrix(), GetIsViewPerspective(), GetPivotPosition(), GetPointerPosition(), GetViewExtents(), GetViewFOV(), GetViewFrustum(), NL_3D_VIEWER_PLUGIN_IMPL(), SetCameraMatrix(), SetPivotPosition(), and SetViewExtents().

◆ m_cameraMatrix

glm::mat4 NL_3D_VIEWER_PLUGIN_IMPL::m_cameraMatrix

mutableprivate

Definition at line 141 of file nl_3d_viewer_plugin_impl.h.

Referenced by GetCameraMatrix(), SetCameraMatrix(), and SetViewExtents().

◆ m_canvas

EDA_3D_CANVAS* NL_3D_VIEWER_PLUGIN_IMPL::m_canvas

private

Definition at line 132 of file nl_3d_viewer_plugin_impl.h.

Referenced by GetCanvas(), GetHitLookAt(), GetModelExtents(), GetPivotVisible(), NL_3D_VIEWER_PLUGIN_IMPL(), SetActiveCommand(), SetPivotPosition(), SetPivotVisible(), and SetTransaction().

◆ m_capIsMoving

bool NL_3D_VIEWER_PLUGIN_IMPL::m_capIsMoving

private

Definition at line 134 of file nl_3d_viewer_plugin_impl.h.

Referenced by SetMotionFlag().

◆ m_newWidth

double NL_3D_VIEWER_PLUGIN_IMPL::m_newWidth

private

Definition at line 135 of file nl_3d_viewer_plugin_impl.h.

◆ m_rayDirection

SFVEC3F NL_3D_VIEWER_PLUGIN_IMPL::m_rayDirection

private

Definition at line 137 of file nl_3d_viewer_plugin_impl.h.

Referenced by GetHitLookAt(), and SetHitDirection().

◆ m_rayOrigin

SFVEC3F NL_3D_VIEWER_PLUGIN_IMPL::m_rayOrigin

private

Definition at line 136 of file nl_3d_viewer_plugin_impl.h.

Referenced by GetHitLookAt(), and SetHitLookFrom().

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

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NL_3D_VIEWER_PLUGIN_IMPL()

◆ ~NL_3D_VIEWER_PLUGIN_IMPL()

Member Function Documentation

◆ Connect()

◆ exportCommandsAndImages()

◆ GetCameraMatrix()

◆ GetCanvas()

◆ GetCoordinateSystem()

◆ GetFrontView()

◆ GetHitLookAt()

◆ GetIsSelectionEmpty()

◆ GetIsViewPerspective()

◆ GetIsViewRotatable()

◆ GetModelExtents()

◆ GetPivotPosition()

◆ GetPivotVisible()

◆ GetPointerPosition()

◆ GetSelectionExtents()

◆ GetSelectionTransform()

◆ GetViewExtents()

◆ GetViewFOV()

◆ GetViewFrustum()

◆ IsUserPivot()

◆ SetActiveCommand()

◆ SetCameraMatrix()

◆ SetCameraTarget()

◆ SetFocus()

◆ SetHitAperture()

◆ SetHitDirection()

◆ SetHitLookFrom()

◆ SetHitSelectionOnly()

◆ SetMotionFlag()

◆ SetPivotPosition()

◆ SetPivotVisible()

◆ SetSelectionTransform()

◆ SetSettingsChanged()

◆ SetTransaction()

◆ SetViewExtents()

◆ SetViewFOV()

◆ SetViewFrustum()

Member Data Documentation

◆ m_camera

◆ m_cameraMatrix

◆ m_canvas

◆ m_capIsMoving

◆ m_newWidth

◆ m_rayDirection

◆ m_rayOrigin