classhueplusplus_1_1_create_scene.html
15.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>hueplusplus: hueplusplus::CreateScene Class Reference</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>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">hueplusplus
 <span id="projectnumber">1.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacehueplusplus.html">hueplusplus</a></li><li class="navelem"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classhueplusplus_1_1_create_scene-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">hueplusplus::CreateScene Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Parameters for creating a new <a class="el" href="classhueplusplus_1_1_scene.html" title="Scene stored in the bridge. ">Scene</a>.
<a href="classhueplusplus_1_1_create_scene.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_scene_8h_source.html">hueplusplus/Scene.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a385999e7d9b655de3bb937391386b18a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_scene.html#a385999e7d9b655de3bb937391386b18a">setName</a> (const std::string &name)</td></tr>
<tr class="memdesc:a385999e7d9b655de3bb937391386b18a"><td class="mdescLeft"> </td><td class="mdescRight">Set name. <a href="#a385999e7d9b655de3bb937391386b18a">More...</a><br /></td></tr>
<tr class="separator:a385999e7d9b655de3bb937391386b18a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa85aa705484f782e63868191ad311a09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_scene.html#aa85aa705484f782e63868191ad311a09">setGroupId</a> (int id)</td></tr>
<tr class="memdesc:aa85aa705484f782e63868191ad311a09"><td class="mdescLeft"> </td><td class="mdescRight">Set group id, making the scene a GroupScene. <a href="#aa85aa705484f782e63868191ad311a09">More...</a><br /></td></tr>
<tr class="separator:aa85aa705484f782e63868191ad311a09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4704dbef66bf9393f5f994fe1922b7b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_scene.html#a4704dbef66bf9393f5f994fe1922b7b6">setLightIds</a> (const std::vector< int > &ids)</td></tr>
<tr class="memdesc:a4704dbef66bf9393f5f994fe1922b7b6"><td class="mdescLeft"> </td><td class="mdescRight">Set light ids, making the scene a LightScene. <a href="#a4704dbef66bf9393f5f994fe1922b7b6">More...</a><br /></td></tr>
<tr class="separator:a4704dbef66bf9393f5f994fe1922b7b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1b62a6f4b7cb48ca5b0ee0971e8f69b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_scene.html#ac1b62a6f4b7cb48ca5b0ee0971e8f69b">setRecycle</a> (bool recycle)</td></tr>
<tr class="memdesc:ac1b62a6f4b7cb48ca5b0ee0971e8f69b"><td class="mdescLeft"> </td><td class="mdescRight">Set whether the scene can be automatically deleted. <a href="#ac1b62a6f4b7cb48ca5b0ee0971e8f69b">More...</a><br /></td></tr>
<tr class="separator:ac1b62a6f4b7cb48ca5b0ee0971e8f69b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef1f158ecc2f087e4051325bb879d70a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_scene.html#aef1f158ecc2f087e4051325bb879d70a">setAppdata</a> (const std::string &data, int version)</td></tr>
<tr class="memdesc:aef1f158ecc2f087e4051325bb879d70a"><td class="mdescLeft"> </td><td class="mdescRight">Set app specific data. <a href="#aef1f158ecc2f087e4051325bb879d70a">More...</a><br /></td></tr>
<tr class="separator:aef1f158ecc2f087e4051325bb879d70a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17fe3dabf9ddeb6103f9feb3ca23629f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_scene.html#a17fe3dabf9ddeb6103f9feb3ca23629f">setLightStates</a> (const std::map< int, <a class="el" href="classhueplusplus_1_1_light_state.html">LightState</a> > &states)</td></tr>
<tr class="memdesc:a17fe3dabf9ddeb6103f9feb3ca23629f"><td class="mdescLeft"> </td><td class="mdescRight">Set light states of the scene. <a href="#a17fe3dabf9ddeb6103f9feb3ca23629f">More...</a><br /></td></tr>
<tr class="separator:a17fe3dabf9ddeb6103f9feb3ca23629f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf8c666df758a94bccec523216261c91"><td class="memItemLeft" align="right" valign="top">nlohmann::json </td><td class="memItemRight" valign="bottom"><a class="el" href="classhueplusplus_1_1_create_scene.html#aaf8c666df758a94bccec523216261c91">getRequest</a> () const</td></tr>
<tr class="memdesc:aaf8c666df758a94bccec523216261c91"><td class="mdescLeft"> </td><td class="mdescRight">Get request to create the scene. <a href="#aaf8c666df758a94bccec523216261c91">More...</a><br /></td></tr>
<tr class="separator:aaf8c666df758a94bccec523216261c91"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parameters for creating a new <a class="el" href="classhueplusplus_1_1_scene.html" title="Scene stored in the bridge. ">Scene</a>. </p>
<p>Can be used like a builder object with chained calls. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aaf8c666df758a94bccec523216261c91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf8c666df758a94bccec523216261c91">◆ </a></span>getRequest()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">nlohmann::json hueplusplus::CreateScene::getRequest </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get request to create the scene. </p>
<dl class="section return"><dt>Returns</dt><dd>JSON request for a POST to create the new scene </dd></dl>
</div>
</div>
<a id="aef1f158ecc2f087e4051325bb879d70a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef1f158ecc2f087e4051325bb879d70a">◆ </a></span>setAppdata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & hueplusplus::CreateScene::setAppdata </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>version</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set app specific data. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhueplusplus_1_1_scene.html#a5553b042d66895d8250d5f5784589f21" title="Set app specific data. ">Scene::setAppdata</a> </dd></dl>
</div>
</div>
<a id="aa85aa705484f782e63868191ad311a09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa85aa705484f782e63868191ad311a09">◆ </a></span>setGroupId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & hueplusplus::CreateScene::setGroupId </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set group id, making the scene a GroupScene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td><a class="el" href="classhueplusplus_1_1_group.html" title="Class for Groups of lights. ">Group</a> id for the scene, not 0</td></tr>
</table>
</dd>
</dl>
<p>The group id cannot be changed after the scene was created. </p><dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when used after setLightIds </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4704dbef66bf9393f5f994fe1922b7b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4704dbef66bf9393f5f994fe1922b7b6">◆ </a></span>setLightIds()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & hueplusplus::CreateScene::setLightIds </td>
<td>(</td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"><em>ids</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set light ids, making the scene a LightScene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ids</td><td>Ids of lights in the scene </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classhueplusplus_1_1_hue_exception.html" title="Exception class with file information. Base class of all custom exception classes. ">HueException</a></td><td>when used after setGroupId </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a17fe3dabf9ddeb6103f9feb3ca23629f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17fe3dabf9ddeb6103f9feb3ca23629f">◆ </a></span>setLightStates()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & hueplusplus::CreateScene::setLightStates </td>
<td>(</td>
<td class="paramtype">const std::map< int, <a class="el" href="classhueplusplus_1_1_light_state.html">LightState</a> > & </td>
<td class="paramname"><em>states</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set light states of the scene. </p>
<p>When omitted, the current light states are stored. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classhueplusplus_1_1_scene.html#a128b333fba58f0bdc6f36d40b21aa173" title="Set light states. ">Scene::setLightStates</a> </dd></dl>
</div>
</div>
<a id="a385999e7d9b655de3bb937391386b18a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a385999e7d9b655de3bb937391386b18a">◆ </a></span>setName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & hueplusplus::CreateScene::setName </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set name. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhueplusplus_1_1_scene.html#a4be93f8ec12df795828bcdc86505db61" title="Set scene name. ">Scene::setName</a> </dd></dl>
</div>
</div>
<a id="ac1b62a6f4b7cb48ca5b0ee0971e8f69b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1b62a6f4b7cb48ca5b0ee0971e8f69b">◆ </a></span>setRecycle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhueplusplus_1_1_create_scene.html">CreateScene</a> & hueplusplus::CreateScene::setRecycle </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>recycle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set whether the scene can be automatically deleted. </p>
<p>Cannot be changed after the scene was created. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/hueplusplus/<a class="el" href="_scene_8h_source.html">Scene.h</a></li>
<li>src/<a class="el" href="_scene_8cpp.html">Scene.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>