KiCad PCB EDA Suite
eda_3d_conditions.h
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) 2020 Ian McInerney <ian.s.mcinerney at ieee.org>
5  * Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef _3D_CONDITIONS_H_
26 #define _3D_CONDITIONS_H_
27 
28 #include <3d_enums.h>
29 #include <tool/selection.h>
31 
32 
33 class BOARD_ADAPTER;
34 
36 {
37 public:
44  m_adapter( aAdapter )
45  {}
46 
55 
64 
73 
74 private:
76  static bool materialModeFunction( const SELECTION& aSelection, BOARD_ADAPTER* aAdapter,
77  MATERIAL_MODE aMaterial );
78 
80  static bool flagFunction( const SELECTION& aSelection, BOARD_ADAPTER* aAdapter,
81  DISPLAY3D_FLG aFlag );
82 
84  static bool gridSizeFunction( const SELECTION& aSelection, BOARD_ADAPTER* aAdapter,
85  GRID3D_TYPE aGridSize );
86 
89 };
90 
91 #endif /* _3D_CONDITIONS_H_ */
SELECTION_CONDITION MaterialMode(MATERIAL_MODE aMaterial)
Creates a functor that tests if a specific material mode is active.
Class that groups generic conditions for selected items.
SELECTION_CONDITION GridSize(GRID3D_TYPE aGridSize)
Creates a functor that tests the current grid size.
SELECTION_CONDITION Flag(DISPLAY3D_FLG aFlag)
Creates a functor that tests if the board adapter has a flag set currently.
declared enumerations and flags
static bool flagFunction(const SELECTION &aSelection, BOARD_ADAPTER *aAdapter, DISPLAY3D_FLG aFlag)
Helper function used by GridDize()
static bool materialModeFunction(const SELECTION &aSelection, BOARD_ADAPTER *aAdapter, MATERIAL_MODE aMaterial)
< Helper function used by MaterialMode()
EDA_3D_CONDITIONS(BOARD_ADAPTER *aAdapter)
Define conditions for a 3D viewer frame.
BOARD_ADAPTER * m_adapter
std::function< bool(const SELECTION &)> SELECTION_CONDITION
< Functor type that checks a specific condition for selected items.
MATERIAL_MODE
Render 3d model shape materials mode.
Definition: 3d_enums.h:118
static bool gridSizeFunction(const SELECTION &aSelection, BOARD_ADAPTER *aAdapter, GRID3D_TYPE aGridSize)
The board adapter to read the 3D viewer state from.
GRID3D_TYPE
Grid types.
Definition: 3d_enums.h:99
DISPLAY3D_FLG
Flags used in rendering options.
Definition: 3d_enums.h:34
Helper class to handle information needed to display 3D board.
Definition: board_adapter.h:68