Open3D (C++ API)  0.12.0
Menu.h
Go to the documentation of this file.
1 // ----------------------------------------------------------------------------
2 // - Open3D: www.open3d.org -
3 // ----------------------------------------------------------------------------
4 // The MIT License (MIT)
5 //
6 // Copyright (c) 2018 www.open3d.org
7 //
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to deal
10 // in the Software without restriction, including without limitation the rights
11 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 // copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
14 //
15 // The above copyright notice and this permission notice shall be included in
16 // all copies or substantial portions of the Software.
17 //
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 // IN THE SOFTWARE.
25 // ----------------------------------------------------------------------------
26 
27 #pragma once
28 
29 #include <memory>
30 
32 
33 #define GUI_USE_NATIVE_MENUS 1
34 
35 namespace open3d {
36 namespace visualization {
37 namespace gui {
38 
39 struct DrawContext;
40 struct Theme;
41 
47 class Menu {
48  friend class Application;
49 
50 public:
51  using ItemId = int;
52  static constexpr ItemId NO_ITEM = -1;
53 
54  Menu();
55  virtual ~Menu();
56 
57  void AddItem(const char* name,
58  ItemId item_id = NO_ITEM,
59  KeyName key = KEY_NONE);
60  void AddMenu(const char* name, std::shared_ptr<Menu> submenu);
61  void AddSeparator();
62 
63  void InsertItem(int index,
64  const char* name,
65  ItemId item_id = NO_ITEM,
66  KeyName key = KEY_NONE);
67  void InsertMenu(int index, const char* name, std::shared_ptr<Menu> submenu);
68  void InsertSeparator(int index);
69 
70  int GetNumberOfItems() const;
71 
74  bool IsEnabled(ItemId item_id) const;
77  void SetEnabled(ItemId item_id, bool enabled);
78 
79  bool IsChecked(ItemId item_id) const;
80  void SetChecked(ItemId item_id, bool checked);
81 
82  int CalcHeight(const Theme& theme) const;
83 
85  bool CheckVisibilityChange() const;
86 
87  ItemId DrawMenuBar(const DrawContext& context, bool is_enabled);
88  ItemId Draw(const DrawContext& context, const char* name, bool is_enabled);
89 
90 protected:
91  void* GetNativePointer(); // nullptr if not using native menus
92 
93 private:
94  struct Impl;
95  std::unique_ptr<Impl> impl_;
96 };
97 
98 } // namespace gui
99 } // namespace visualization
100 } // namespace open3d
Definition: Theme.h:39
void InsertItem(int index, const char *name, ItemId item_id=NO_ITEM, KeyName key=KEY_NONE)
Definition: Menu.cpp:120
Definition: Application.h:55
bool CheckVisibilityChange() const
Returns true if submenu visibility changed on last call to DrawMenuBar.
Definition: Menu.cpp:196
void AddItem(const char *name, ItemId item_id=NO_ITEM, KeyName key=KEY_NONE)
Definition: Menu.cpp:108
void AddSeparator()
Definition: Menu.cpp:118
virtual ~Menu()
Definition: Menu.cpp:104
ItemId DrawMenuBar(const DrawContext &context, bool is_enabled)
Definition: Menu.cpp:200
void InsertMenu(int index, const char *name, std::shared_ptr< Menu > submenu)
Definition: Menu.cpp:134
int CalcHeight(const Theme &theme) const
Definition: Menu.cpp:190
void AddMenu(const char *name, std::shared_ptr< Menu > submenu)
Definition: Menu.cpp:114
void * GetNativePointer()
Definition: Menu.cpp:106
void SetEnabled(ItemId item_id, bool enabled)
Definition: Menu.cpp:168
ItemId Draw(const DrawContext &context, const char *name, bool is_enabled)
Definition: Menu.cpp:242
const char const char value recording_handle imu_sample recording_handle uint8_t size_t data_size k4a_record_configuration_t config target_format k4a_capture_t capture_handle k4a_imu_sample_t imu_sample playback_handle k4a_logging_message_cb_t void min_level device_handle k4a_imu_sample_t timeout_in_ms capture_handle capture_handle capture_handle image_handle temperature_c int
Definition: K4aPlugin.cpp:479
int ItemId
Definition: Menu.h:51
void InsertSeparator(int index)
Definition: Menu.cpp:147
bool IsChecked(ItemId item_id) const
Definition: Menu.cpp:175
Definition: PinholeCameraIntrinsic.cpp:35
std::string name
Definition: FilePCD.cpp:58
bool IsEnabled(ItemId item_id) const
Definition: Menu.cpp:160
Menu()
Definition: Menu.cpp:102
KeyName
Definition: Events.h:77
void SetChecked(ItemId item_id, bool checked)
Definition: Menu.cpp:183
static constexpr ItemId NO_ITEM
Definition: Menu.h:52
int GetNumberOfItems() const
Definition: Menu.cpp:158