KiCad PCB EDA Suite
Loading...
Searching...
No Matches
nl_schematic_plugin_impl.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) 2022 3Dconnexion
5 * Copyright (C) 2022 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
22
23// KiCAD includes
25#include <sch_base_frame.h>
26#include <bitmaps.h>
28#include <view/view.h>
30#include <tool/action_manager.h>
31#include <tool/tool_action.h>
32#include <tool/tool_manager.h>
33
34// stdlib
35#include <list>
36#include <map>
37#include <memory>
38#include <utility>
39#include <vector>
40#include <cfloat>
41
42#include <wx/log.h>
43#include <wx/mstream.h>
44
45
53const wxChar* NL_SCHEMATIC_PLUGIN_IMPL::m_logTrace = wxT( "KI_TRACE_NL_SCHEMATIC_PLUGIN" );
54
55
57 CNavigation3D( false, false ),
58 m_viewport2D( nullptr ),
59 m_view( nullptr ),
60 m_isMoving( false ),
61 m_viewportWidth( 0.0 )
62{
63 PutProfileHint( "KiCAD Eeschema" );
64}
65
66
68{
69 EnableNavigation( false );
70}
71
72
74{
75 bool init = m_viewport2D == nullptr;
76
77 m_viewport2D = aViewport;
78
79 if( m_viewport2D != nullptr )
80 {
81 m_view = static_cast<KIGFX::SCH_VIEW*>( m_viewport2D->GetView() );
83
84 if( init )
85 {
86 // Use the default settings for the connexion to the 3DMouse navigation
87 // They are use a single-threaded threading model and row vectors.
88 EnableNavigation( true );
89
90 // Use the SpaceMouse internal timing source for the frame rate.
91 PutFrameTimingSource( TimingSource::SpaceMouse );
92
94 }
95 }
96}
97
98
100{
101 wxLogTrace( m_logTrace, wxT( "NL_SCHEMATIC_PLUGIN_IMPL::SetFocus %d" ), aFocus );
102 NAV_3D::Write( navlib::focus_k, aFocus );
103}
104
105// temporary store for the command categories
106typedef std::map<std::string, TDx::CCommandTreeNode*> CATEGORY_STORE;
107
108
117static void add_category( const std::string& aCategoryPath, CATEGORY_STORE& aCategoryStore )
118{
119 using TDx::SpaceMouse::CCategory;
120
121 CATEGORY_STORE::iterator parent_iter = aCategoryStore.begin();
122 std::string::size_type pos = aCategoryPath.find_last_of( '.' );
123
124 if( pos != std::string::npos )
125 {
126 std::string parentPath = aCategoryPath.substr( 0, pos );
127 parent_iter = aCategoryStore.find( parentPath );
128
129 if( parent_iter == aCategoryStore.end() )
130 {
131 add_category( parentPath, aCategoryStore );
132 parent_iter = aCategoryStore.find( parentPath );
133 }
134 }
135
136 std::string name = aCategoryPath.substr( pos + 1 );
137 auto categoryNode = std::make_unique<CCategory>( aCategoryPath.c_str(), name.c_str() );
138
139 aCategoryStore.insert( aCategoryStore.end(), { aCategoryPath, categoryNode.get() } );
140
141 parent_iter->second->push_back( std::move( categoryNode ) );
142}
143
144
146{
147 wxLogTrace( m_logTrace, wxT( "NL_SCHEMATIC_PLUGIN_IMPL::exportCommandsAndImages" ) );
148
149 std::list<TOOL_ACTION*> actions = ACTION_MANAGER::GetActionList();
150
151 if( actions.size() == 0 )
152 return;
153
154 using TDx::SpaceMouse::CCommand;
155 using TDx::SpaceMouse::CCommandSet;
156
157 // The root action set node
158 CCommandSet commandSet( "SCHEMATIC_EDITOR", "Schematic Editor" );
159
160 // Activate the command set
161 NAV_3D::PutActiveCommands( commandSet.GetId() );
162
163 // temporary store for the categories
164 CATEGORY_STORE categoryStore;
165
166 std::vector<TDx::CImage> vImages;
167
168 // add the action set to the category_store
169 categoryStore.insert( categoryStore.end(), CATEGORY_STORE::value_type( ".", &commandSet ) );
170
171 std::list<TOOL_ACTION*>::const_iterator it;
172
173 for( it = actions.begin(); it != actions.end(); ++it )
174 {
175 const TOOL_ACTION* action = *it;
176 std::string label = action->GetMenuLabel().ToStdString();
177
178 if( label.empty() )
179 continue;
180
181 std::string name = action->GetName();
182
183 // Do no export commands for the 3DViewer app.
184
185 if( name.rfind( "3DViewer.", 0 ) == 0 )
186 continue;
187
188 std::string strCategory = action->GetToolName();
189 CATEGORY_STORE::iterator iter = categoryStore.find( strCategory );
190
191 if( iter == categoryStore.end() )
192 {
193 add_category( strCategory, categoryStore );
194 iter = categoryStore.find( strCategory );
195 }
196
197 std::string description = action->GetDescription().ToStdString();
198
199 // Arbitrary 8-bit data stream
200 wxMemoryOutputStream imageStream;
201
202 if( action->GetIcon() != BITMAPS::INVALID_BITMAP )
203 {
204 wxImage image = KiBitmap( action->GetIcon() ).ConvertToImage();
205 image.SaveFile( imageStream, wxBitmapType::wxBITMAP_TYPE_PNG );
206 image.Destroy();
207
208 if( imageStream.GetSize() )
209 {
210 wxStreamBuffer* streamBuffer = imageStream.GetOutputStreamBuffer();
211 TDx::CImage tdxImage = TDx::CImage::FromData( "", 0, name.c_str() );
212 tdxImage.AssignImage( std::string( reinterpret_cast<const char*>(
213 streamBuffer->GetBufferStart() ),
214 streamBuffer->GetBufferSize() ),
215 0 );
216
217 wxLogTrace( m_logTrace, wxT( "Adding image for : %s" ), name );
218 vImages.push_back( std::move( tdxImage ) );
219 }
220 }
221
222 wxLogTrace( m_logTrace, wxT( "Inserting command: %s, description: %s, in category: %s" ),
223 name, description, iter->first );
224
225 iter->second->push_back(
226 CCommand( std::move( name ), std::move( label ), std::move( description ) ) );
227 }
228
229 NAV_3D::AddCommandSet( commandSet );
230 NAV_3D::AddImages( vImages );
231}
232
233
234long NL_SCHEMATIC_PLUGIN_IMPL::GetCameraMatrix( navlib::matrix_t& matrix ) const
235{
236 if( m_view == nullptr )
237 return navlib::make_result_code( navlib::navlib_errc::no_data_available );
238
240
241 double x = m_view->IsMirroredX() ? -1 : 1;
242 double y = m_view->IsMirroredY() ? 1 : -1;
243
244 // x * y * z = 1 for a right-handed coordinate system.
245 double z = x * y;
246
247 // Note: the connexion has been configured as row vectors, the coordinate system is defined in
248 // NL_SCHEMATIC_PLUGIN_IMPL::GetCoordinateSystem and the front view in NL_SCHEMATIC_PLUGIN_IMPL::GetFrontView.
249 matrix = { { { x, 0, 0, 0, 0, y, 0, 0, 0, 0, z, 0, m_viewPosition.x, m_viewPosition.y, 0, 1 } } };
250 return 0;
251}
252
253
254long NL_SCHEMATIC_PLUGIN_IMPL::GetPointerPosition( navlib::point_t& position ) const
255{
256 if( m_view == nullptr )
257 return navlib::make_result_code( navlib::navlib_errc::no_data_available );
258
260
261 position.x = mouse_pointer.x;
262 position.y = mouse_pointer.y;
263 position.z = 0;
264
265 return 0;
266}
267
268
269long NL_SCHEMATIC_PLUGIN_IMPL::GetViewExtents( navlib::box_t& extents ) const
270{
271 if( m_view == nullptr )
272 return navlib::make_result_code( navlib::navlib_errc::no_data_available );
273
274 double scale = m_viewport2D->GetGAL()->GetWorldScale();
275 BOX2D box = m_view->GetViewport();
276
278
279 extents.min_x = -box.GetWidth() / 2.0;
280 extents.min_y = -box.GetHeight() / 2.0;
281 extents.min_z = m_viewport2D->GetGAL()->GetMinDepth() / scale;
282 extents.max_x = box.GetWidth() / 2.0;
283 extents.max_y = box.GetHeight() / 2.0;
284 extents.max_z = m_viewport2D->GetGAL()->GetMaxDepth() / scale;
285 return 0;
286}
287
288
289long NL_SCHEMATIC_PLUGIN_IMPL::GetIsViewPerspective( navlib::bool_t& perspective ) const
290{
291 perspective = false;
292
293 return 0;
294}
295
296
297long NL_SCHEMATIC_PLUGIN_IMPL::SetCameraMatrix( const navlib::matrix_t& matrix )
298{
299 if( m_view == nullptr )
300 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
301
302 long result = 0;
303 VECTOR2D viewPos( matrix.m4x4[3][0], matrix.m4x4[3][1] );
304
306 static_cast<VECTOR2D::coord_type>( FLT_EPSILON ) ) )
307 {
309 result = navlib::make_result_code( navlib::navlib_errc::error );
310 }
311 else
312 {
313 m_view->SetCenter( viewPos );
314 }
315
316 m_viewPosition = viewPos;
317
318 return result;
319}
320
321
322long NL_SCHEMATIC_PLUGIN_IMPL::SetViewExtents( const navlib::box_t& extents )
323{
324 if( m_view == nullptr )
325 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
326
327 long result = 0;
328
330 result = navlib::make_result_code( navlib::navlib_errc::error );
331
332 double width = m_viewportWidth;
333 m_viewportWidth = extents.max_x - extents.min_x;
334
335 double scale = width / m_viewportWidth * m_view->GetScale();
337
338 if( !equals( m_view->GetScale(), scale, static_cast<double>( FLT_EPSILON ) ) )
339 result = navlib::make_result_code( navlib::navlib_errc::error );
340
341 return result;
342}
343
344
346{
347 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
348}
349
350
351long NL_SCHEMATIC_PLUGIN_IMPL::SetViewFrustum( const navlib::frustum_t& frustum )
352{
353 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
354}
355
356
357long NL_SCHEMATIC_PLUGIN_IMPL::GetModelExtents( navlib::box_t& extents ) const
358{
359 if( m_view == nullptr )
360 return navlib::make_result_code( navlib::navlib_errc::no_data_available );
361
362 BOX2I box = static_cast<SCH_BASE_FRAME*>( m_viewport2D->GetParent() )->GetDocumentExtents();
363 box.Normalize();
364
365 double half_depth = 0.1 / m_viewport2D->GetGAL()->GetWorldScale();
366
367 if( box.GetWidth() == 0 && box.GetHeight() == 0 )
368 half_depth = 0;
369
370 extents.min_x = static_cast<double>( box.GetOrigin().x );
371 extents.min_y = static_cast<double>( box.GetOrigin().y );
372 extents.min_z = -half_depth;
373 extents.max_x = static_cast<double>( box.GetEnd().x );
374 extents.max_y = static_cast<double>( box.GetEnd().y );
375 extents.max_z = half_depth;
376
377 return 0;
378}
379
380
381long NL_SCHEMATIC_PLUGIN_IMPL::GetCoordinateSystem( navlib::matrix_t& matrix ) const
382{
383 // The coordinate system is defined as x to the right, y down and z into the screen.
384 matrix = { { { 1, 0, 0, 0, 0, -1, 0, 0, 0, 0, -1, 0, 0, 0, 0, 1 } } };
385 return 0;
386}
387
388
389long NL_SCHEMATIC_PLUGIN_IMPL::GetFrontView( navlib::matrix_t& matrix ) const
390{
391 matrix = { { { 1, 0, 0, 0, 0, -1, 0, 0, 0, 0, -1, 0, 0, 0, 0, 1 } } };
392 return 0;
393}
394
395
397{
398 empty = true;
399 return 0;
400}
401
402
403long NL_SCHEMATIC_PLUGIN_IMPL::GetIsViewRotatable( navlib::bool_t& isRotatable ) const
404{
405 isRotatable = false;
406 return 0;
407}
408
409
411{
412 if( commandId.empty() )
413 return 0;
414
415 std::list<TOOL_ACTION*> actions = ACTION_MANAGER::GetActionList();
416 TOOL_ACTION* context = nullptr;
417
418 for( std::list<TOOL_ACTION*>::const_iterator it = actions.begin(); it != actions.end(); it++ )
419 {
420 TOOL_ACTION* action = *it;
421 std::string nm = action->GetName();
422
423 if( commandId == nm )
424 context = action;
425 }
426
427 if( context != nullptr )
428 {
429 wxWindow* parent = m_viewport2D->GetParent();
430
431 // Only allow command execution if the window is enabled. i.e. there is not a modal dialog
432 // currently active.
433
434 if( parent->IsEnabled() )
435 {
436 TOOL_MANAGER* tool_manager = static_cast<SCH_BASE_FRAME*>( parent )->GetToolManager();
437
438 // Get the selection to use to test if the action is enabled
439 SELECTION& sel = tool_manager->GetToolHolder()->GetCurrentSelection();
440
441 bool runAction = true;
442
443 if( const ACTION_CONDITIONS* aCond =
444 tool_manager->GetActionManager()->GetCondition( *context ) )
445 {
446 runAction = aCond->enableCondition( sel );
447 }
448
449 if( runAction )
450 tool_manager->RunAction( *context );
451 }
452 else
453 {
454 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
455 }
456 }
457
458 return 0;
459}
460
461
463{
464 return 0;
465}
466
467
469{
470 m_isMoving = value;
471
472 return 0;
473}
474
475
477{
478 if( value == 0L )
480
481 return 0;
482}
483
484
486{
487 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
488}
489
490
491long NL_SCHEMATIC_PLUGIN_IMPL::GetViewFrustum( navlib::frustum_t& frustum ) const
492{
493 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
494}
495
496
497long NL_SCHEMATIC_PLUGIN_IMPL::GetSelectionExtents( navlib::box_t& extents ) const
498{
499 return navlib::make_result_code( navlib::navlib_errc::no_data_available );
500}
501
502
503long NL_SCHEMATIC_PLUGIN_IMPL::GetSelectionTransform( navlib::matrix_t& transform ) const
504{
505 return navlib::make_result_code( navlib::navlib_errc::no_data_available );
506}
507
508
509long NL_SCHEMATIC_PLUGIN_IMPL::SetSelectionTransform( const navlib::matrix_t& matrix )
510{
511 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
512}
513
514
515long NL_SCHEMATIC_PLUGIN_IMPL::GetPivotPosition( navlib::point_t& position ) const
516{
517 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
518}
519
520
521long NL_SCHEMATIC_PLUGIN_IMPL::IsUserPivot( navlib::bool_t& userPivot ) const
522{
523 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
524}
525
526
527long NL_SCHEMATIC_PLUGIN_IMPL::SetPivotPosition( const navlib::point_t& position )
528{
529 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
530}
531
532
533long NL_SCHEMATIC_PLUGIN_IMPL::GetPivotVisible( navlib::bool_t& visible ) const
534{
535 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
536}
537
538
540{
541 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
542}
543
544
545long NL_SCHEMATIC_PLUGIN_IMPL::GetHitLookAt( navlib::point_t& position ) const
546{
547 return navlib::make_result_code( navlib::navlib_errc::no_data_available );
548}
549
550
552{
553 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
554}
555
556
557long NL_SCHEMATIC_PLUGIN_IMPL::SetHitDirection( const navlib::vector_t& direction )
558{
559 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
560}
561
562
563long NL_SCHEMATIC_PLUGIN_IMPL::SetHitLookFrom( const navlib::point_t& eye )
564{
565 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
566}
567
568
570{
571 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
572}
573
574
575long NL_SCHEMATIC_PLUGIN_IMPL::SetCameraTarget( const navlib::point_t& position )
576{
577 return navlib::make_result_code( navlib::navlib_errc::invalid_operation );
578}
const char * name
Definition: DXF_plotter.cpp:57
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:104
const ACTION_CONDITIONS * GetCondition(const TOOL_ACTION &aAction) const
Get the conditions to use for a specific tool action.
static std::list< TOOL_ACTION * > & GetActionList()
Return list of TOOL_ACTIONs.
constexpr const Vec GetEnd() const
Definition: box2.h:212
constexpr BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
Definition: box2.h:146
constexpr size_type GetWidth() const
Definition: box2.h:214
constexpr size_type GetHeight() const
Definition: box2.h:215
constexpr const Vec & GetOrigin() const
Definition: box2.h:210
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
void ForceRefresh()
Force a redraw.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
double GetMaxDepth() const
double GetMinDepth() const
double GetWorldScale() const
Get the world scale.
void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 }) override
Set the scaling factor, zooming around a given anchor point.
Definition: sch_view.cpp:75
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Return the current mouse pointer position.
double GetScale() const
Definition: view.h:277
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition: view.cpp:547
const VECTOR2D & GetCenter() const
Return the center point of this VIEW (in world space coordinates).
Definition: view.h:347
bool IsMirroredX() const
Return true if view is flipped across the X axis.
Definition: view.h:251
bool IsMirroredY() const
Return true if view is flipped across the Y axis.
Definition: view.h:259
const BOX2D & GetBoundary() const
Definition: view.h:306
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:613
long GetHitLookAt(navlib::point_t &aPosition) const override
long GetSelectionExtents(navlib::box_t &aExtents) const override
long GetCoordinateSystem(navlib::matrix_t &aMatrix) const override
long SetViewFOV(double aFov) override
long GetSelectionTransform(navlib::matrix_t &aTransform) const override
long GetPivotPosition(navlib::point_t &aPosition) const override
long SetPivotPosition(const navlib::point_t &aPosition) override
long SetViewFrustum(const navlib::frustum_t &aFrustum) override
long GetFrontView(navlib::matrix_t &aMatrix) const override
long GetViewFOV(double &aFov) const override
long SetHitAperture(double aAperture) override
long SetSelectionTransform(const navlib::matrix_t &aMatrix) override
void SetFocus(bool aFocus)
Set the connection to the 3Dconnexion driver to the focus state so that 3DMouse data is routed here.
long SetViewExtents(const navlib::box_t &aExtents) override
void SetCanvas(EDA_DRAW_PANEL_GAL *aViewport)
Sets the viewport controlled by the SpaceMouse.
long GetCameraMatrix(navlib::matrix_t &aMatrix) const override
long GetPointerPosition(navlib::point_t &aPosition) const override
long GetPivotVisible(navlib::bool_t &aVisible) const override
void exportCommandsAndImages()
Export the invocable actions and images to the 3Dconnexion UI.
long SetTransaction(long aValue) override
long GetIsViewPerspective(navlib::bool_t &aPerspective) const override
long SetHitSelectionOnly(bool aSelectionOnly) override
NL_SCHEMATIC_PLUGIN_IMPL()
Initializes a new instance of the NL_SCHEMATIC_PLUGIN_IMPL.
long SetHitLookFrom(const navlib::point_t &aPosition) override
long SetActiveCommand(std::string aCommandId) override
long GetViewExtents(navlib::box_t &aExtents) const override
long SetCameraTarget(const navlib::point_t &aPosition) override
long GetIsSelectionEmpty(navlib::bool_t &aEmpty) const override
long SetCameraMatrix(const navlib::matrix_t &aMatrix) override
long GetIsViewRotatable(navlib::bool_t &isRotatable) const override
long SetMotionFlag(bool aValue) override
long SetHitDirection(const navlib::vector_t &aDirection) override
long GetModelExtents(navlib::box_t &aExtents) const override
long IsUserPivot(navlib::bool_t &aUserPivot) const override
long SetSettingsChanged(long aChangeNumber) override
long GetViewFrustum(navlib::frustum_t &aFrustum) const override
long SetPivotVisible(bool aVisible) override
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:98
Represent a single user action.
Definition: tool_action.h:269
wxString GetMenuLabel() const
Return the translated label for the action.
BITMAPS GetIcon() const
Return an icon associated with the action.
Definition: tool_action.h:422
std::string GetToolName() const
Return name of the tool associated with the action.
const std::string & GetName() const
Return name of the action.
Definition: tool_action.h:302
wxString GetDescription() const
Master controller class:
Definition: tool_manager.h:62
bool RunAction(const std::string &aActionName, T aParam)
Run the specified action immediately, pausing the current action to run the new one.
Definition: tool_manager.h:150
TOOLS_HOLDER * GetToolHolder() const
Definition: tool_manager.h:402
ACTION_MANAGER * GetActionManager() const
Definition: tool_manager.h:302
double coord_type
Definition: vector2d.h:74
static bool empty(const wxTextEntryBase *aCtrl)
static const wxChar * m_logTrace
Trace mask used to enable or disable the trace output of this class.
bool equals(glm::mat< L, C, T, Q > const &aFirst, glm::mat< L, C, T, Q > const &aSecond, T aEpsilon=static_cast< T >(FLT_EPSILON *10))
Template to compare two glm::mat<T> values for equality within a required epsilon.
CATEGORY_STORE::iterator add_category(std::string aCategoryPath, CATEGORY_STORE &aCategoryStore)
Add a category to the store.
std::map< std::string, TDx::CCommandTreeNode * > CATEGORY_STORE
std::map< std::string, TDx::CCommandTreeNode * > CATEGORY_STORE
static void add_category(const std::string &aCategoryPath, CATEGORY_STORE &aCategoryStore)
Add a category to the store.
Declaration of the NL_SCHEMATIC_PLUGIN_IMPL class.
const int scale
Functors that can be used to figure out how the action controls should be displayed in the UI and if ...
WX_VIEW_CONTROLS class definition.