mslockbo/OpenShaderDesigner
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
OpenShaderDesigner/Documentation/html/_editor_window_8h_source.html

201 lines
22 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenShaderDesigner: Include/Editor/EditorWindow.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">OpenShaderDesigner<span id="projectnumber">&#160;0.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_856524284ebe840938865dc061f982fb.html">Include</a></li><li class="navelem"><a class="el" href="dir_bd45b750fe5d9d69196d2087bb9244ca.html">Editor</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">EditorWindow.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// =====================================================================================================================</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Copyright 2024 Medusa Slockbower</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">//</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">//</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">// limitations under the License.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">// =====================================================================================================================</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#ifndef EDITORWINDOW_H</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#define EDITORWINDOW_H</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include &lt;imgui-docking/imgui.h&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">namespace </span>OpenShaderDesigner</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span>{</div>
<div class="foldopen" id="foldopen00027" data-start="{" data-end="};">
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_open_shader_designer_1_1_editor_window.html"> 27</a></span> <span class="keyword">class </span><a class="code hl_class" href="class_open_shader_designer_1_1_editor_window.html">EditorWindow</a></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_open_shader_designer_1_1_editor_window.html#a858a412f2f8c652773885d217410d332">Open</a>();</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_open_shader_designer_1_1_editor_window.html#a501528be936bdf479359021308fb0d31">Draw</a>();</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_open_shader_designer_1_1_editor_window.html#a5df4621355612a487578521525029aa6">Close</a>();</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="class_open_shader_designer_1_1_editor_window.html#af3ea05326684e2f58d54805ce10570a6"> 49</a></span> [[nodiscard]] <span class="keywordtype">bool</span> <a class="code hl_function" href="class_open_shader_designer_1_1_editor_window.html#af3ea05326684e2f58d54805ce10570a6">IsOpen</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> bOpen; }</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="class_open_shader_designer_1_1_editor_window.html#a2e557a422d0e4e003f85fb9905b66980"> 51</a></span> <span class="keyword">const</span> std::string <a class="code hl_variable" href="class_open_shader_designer_1_1_editor_window.html#a2e557a422d0e4e003f85fb9905b66980">Title</a>; </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">void</span> SetFlags(ImGuiWindowFlags flags) { Flags |= flags; }</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">void</span> ClearFlags(ImGuiWindowFlags flags) { Flags &amp;= ~flags; }</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">void</span> ToggleFlags(ImGuiWindowFlags flags) { Flags ^= flags; }</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> [[nodiscard]] <span class="keywordtype">bool</span> CheckFlag(ImGuiWindowFlags flag)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> Flags &amp; flag; }</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> [[nodiscard]] <span class="keywordtype">bool</span> HasMenuBar()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> CheckFlag(ImGuiWindowFlags_MenuBar); }</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">protected</span>:</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> ~EditorWindow() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> EditorWindow(<span class="keyword">const</span> std::string&amp; title</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> , ImGuiWindowFlags flags);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="foldopen" id="foldopen00068" data-start="{" data-end="}">
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="class_open_shader_designer_1_1_editor_window.html#a2e68f7186c2ceb3ea3dd5618045c6ab7"> 68</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_open_shader_designer_1_1_editor_window.html#a2e68f7186c2ceb3ea3dd5618045c6ab7">OnOpen</a>()</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> {</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> };</div>
</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="foldopen" id="foldopen00075" data-start="{" data-end="}">
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"><a class="line" href="class_open_shader_designer_1_1_editor_window.html#a058742ce762d782440f595497e5bfbff"> 75</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_open_shader_designer_1_1_editor_window.html#a058742ce762d782440f595497e5bfbff">DrawWindow</a>()</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> {</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> };</div>
</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="foldopen" id="foldopen00082" data-start="{" data-end="}">
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="class_open_shader_designer_1_1_editor_window.html#a6c229ca70221f672315f9a4f0c7be0c0"> 82</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_open_shader_designer_1_1_editor_window.html#a6c229ca70221f672315f9a4f0c7be0c0">DrawMenu</a>()</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> {</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> };</div>
</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="foldopen" id="foldopen00089" data-start="{" data-end="}">
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="class_open_shader_designer_1_1_editor_window.html#a6dc0b192488187ddbde44d7f0b5fc0f7"> 89</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_open_shader_designer_1_1_editor_window.html#a6dc0b192488187ddbde44d7f0b5fc0f7">OnClose</a>()</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> {</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> };</div>
</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <a class="code hl_class" href="class_open_shader_designer_1_1_editor_window.html">EditorWindow</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_open_shader_designer_1_1_editor_window.html">EditorWindow</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <a class="code hl_class" href="class_open_shader_designer_1_1_editor_window.html">EditorWindow</a>(<a class="code hl_class" href="class_open_shader_designer_1_1_editor_window.html">EditorWindow</a>&amp;&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keywordtype">int</span> Flags;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">bool</span> bOpen;</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_open_shader_designer_1_1_editor_system.html">EditorSystem</a>;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> };</div>
</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>}</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="preprocessor">#endif </span><span class="comment">//EDITORWINDOW_H</span></div>
<div class="ttc" id="aclass_open_shader_designer_1_1_editor_system_html"><div class="ttname"><a href="class_open_shader_designer_1_1_editor_system.html">OpenShaderDesigner::EditorSystem</a></div><div class="ttdef"><b>Definition</b> EditorSystem.h:30</div></div>
<div class="ttc" id="aclass_open_shader_designer_1_1_editor_window_html"><div class="ttname"><a href="class_open_shader_designer_1_1_editor_window.html">OpenShaderDesigner::EditorWindow</a></div><div class="ttdoc">EditorWindow class for wrapping ImGui window functionality.</div><div class="ttdef"><b>Definition</b> EditorWindow.h:28</div></div>
<div class="ttc" id="aclass_open_shader_designer_1_1_editor_window_html_a058742ce762d782440f595497e5bfbff"><div class="ttname"><a href="class_open_shader_designer_1_1_editor_window.html#a058742ce762d782440f595497e5bfbff">OpenShaderDesigner::EditorWindow::DrawWindow</a></div><div class="ttdeci">virtual void DrawWindow()</div><div class="ttdoc">DrawWindow function for when the EditorWindow is being drawn.</div><div class="ttdef"><b>Definition</b> EditorWindow.h:75</div></div>
<div class="ttc" id="aclass_open_shader_designer_1_1_editor_window_html_a2e557a422d0e4e003f85fb9905b66980"><div class="ttname"><a href="class_open_shader_designer_1_1_editor_window.html#a2e557a422d0e4e003f85fb9905b66980">OpenShaderDesigner::EditorWindow::Title</a></div><div class="ttdeci">const std::string Title</div><div class="ttdoc">Title for the EditorWindow.</div><div class="ttdef"><b>Definition</b> EditorWindow.h:51</div></div>
<div class="ttc" id="aclass_open_shader_designer_1_1_editor_window_html_a2e68f7186c2ceb3ea3dd5618045c6ab7"><div class="ttname"><a href="class_open_shader_designer_1_1_editor_window.html#a2e68f7186c2ceb3ea3dd5618045c6ab7">OpenShaderDesigner::EditorWindow::OnOpen</a></div><div class="ttdeci">virtual void OnOpen()</div><div class="ttdoc">OnOpen callback for when the EditorWindow is opened.</div><div class="ttdef"><b>Definition</b> EditorWindow.h:68</div></div>
<div class="ttc" id="aclass_open_shader_designer_1_1_editor_window_html_a501528be936bdf479359021308fb0d31"><div class="ttname"><a href="class_open_shader_designer_1_1_editor_window.html#a501528be936bdf479359021308fb0d31">OpenShaderDesigner::EditorWindow::Draw</a></div><div class="ttdeci">void Draw()</div><div class="ttdoc">Draw the EditorWindow.</div><div class="ttdef"><b>Definition</b> EditorWindow.cpp:27</div></div>
<div class="ttc" id="aclass_open_shader_designer_1_1_editor_window_html_a5df4621355612a487578521525029aa6"><div class="ttname"><a href="class_open_shader_designer_1_1_editor_window.html#a5df4621355612a487578521525029aa6">OpenShaderDesigner::EditorWindow::Close</a></div><div class="ttdeci">void Close()</div><div class="ttdoc">Close the EditorWindow.</div><div class="ttdef"><b>Definition</b> EditorWindow.cpp:52</div></div>
<div class="ttc" id="aclass_open_shader_designer_1_1_editor_window_html_a6c229ca70221f672315f9a4f0c7be0c0"><div class="ttname"><a href="class_open_shader_designer_1_1_editor_window.html#a6c229ca70221f672315f9a4f0c7be0c0">OpenShaderDesigner::EditorWindow::DrawMenu</a></div><div class="ttdeci">virtual void DrawMenu()</div><div class="ttdoc">DrawMenu function for when the EditorWindow Menu is being drawn.</div><div class="ttdef"><b>Definition</b> EditorWindow.h:82</div></div>
<div class="ttc" id="aclass_open_shader_designer_1_1_editor_window_html_a6dc0b192488187ddbde44d7f0b5fc0f7"><div class="ttname"><a href="class_open_shader_designer_1_1_editor_window.html#a6dc0b192488187ddbde44d7f0b5fc0f7">OpenShaderDesigner::EditorWindow::OnClose</a></div><div class="ttdeci">virtual void OnClose()</div><div class="ttdoc">OnClose callback for when the EditorWindow is closed.</div><div class="ttdef"><b>Definition</b> EditorWindow.h:89</div></div>
<div class="ttc" id="aclass_open_shader_designer_1_1_editor_window_html_a858a412f2f8c652773885d217410d332"><div class="ttname"><a href="class_open_shader_designer_1_1_editor_window.html#a858a412f2f8c652773885d217410d332">OpenShaderDesigner::EditorWindow::Open</a></div><div class="ttdeci">void Open()</div><div class="ttdoc">Open the EditorWindow.</div><div class="ttdef"><b>Definition</b> EditorWindow.cpp:20</div></div>
<div class="ttc" id="aclass_open_shader_designer_1_1_editor_window_html_af3ea05326684e2f58d54805ce10570a6"><div class="ttname"><a href="class_open_shader_designer_1_1_editor_window.html#af3ea05326684e2f58d54805ce10570a6">OpenShaderDesigner::EditorWindow::IsOpen</a></div><div class="ttdeci">bool IsOpen() const</div><div class="ttdoc">Check if the EditorWindow is open.</div><div class="ttdef"><b>Definition</b> EditorWindow.h:49</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink