1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50 <title>nw::gfx::SceneEnvironment</title> 51 </head> 52 <body> 53 <h1>nw::gfx::SceneEnvironment Class</h1> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class SceneEnvironment</pre> 57 </div> 58 <h2>Description</h2> 59 <div class="section"> 60 <p>The class indicating the scene environment.</p><p>The <CODE>RenderEnvironment </CODE>class has been eliminated and replaced by <CODE>SceneEnvironment</CODE>.</p></div> 61 <a name="struct" id="struct"> 62 <h2>Structures</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <th> 67 <a href="../../../nw/gfx/SceneEnvironment/Description/Overview.html">nw::gfx::SceneEnvironment::Description</a> 68 </th> 69 <td>Scene environment settings.</td> 70 </tr> </table> 71 </div> 72 </a> <a name="function" id="function"> 73 <h2>Member Functions</h2> 74 <div class="section"> 75 <table class="members"> 76 <tr> 77 <th class="category" colspan="3">Scene Environment Settings-Related</th> 78 </tr> 79 <tr> 80 <td width="100"> </td> 81 <th> 82 <a href="../../../nw/gfx/SceneEnvironment/ApplyFrom.html">ApplyFrom</a> 83 </th> 84 <td>Applies a scene environment from the scene environment settings.</td> 85 </tr> 86 <tr> 87 <td width="100"> </td> 88 <th> 89 <a href="../../../nw/gfx/SceneEnvironment/ClearSettings.html">ClearSettings</a> 90 </th> 91 <td>Clears the scene environment.</td> 92 </tr> 93 <tr> 94 <td width="100"> </td> 95 <th> 96 <a href="../../../nw/gfx/SceneEnvironment/SetFog.html">SetFog</a> 97 </th> 98 <td>Sets a fog in the fog array.</td> 99 </tr> 100 <tr> 101 <td width="100"> </td> 102 <th> 103 <a href="../../../nw/gfx/SceneEnvironment/GetFog.html">GetFog</a> 104 </th> 105 <td>Obtains a fog from the fog array.</td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110 <a href="../../../nw/gfx/SceneEnvironment/SetCamera.html">SetCamera</a> 111 </th> 112 <td>Sets a camera in the camera array.</td> 113 </tr> 114 <tr> 115 <td width="100"> </td> 116 <th> 117 <a href="../../../nw/gfx/SceneEnvironment/GetCamera.html"><CODE>GetCamera</CODE></a> 118 </th> 119 <td>Obtains a camera from the camera array.</td> 120 </tr> 121 <tr> 122 <td width="100"> </td> 123 <th> 124 <a href="../../../nw/gfx/SceneEnvironment/SetLightSet.html">SetLightSet</a> 125 </th> 126 <td>Sets a light set in the light set array.</td> 127 </tr> 128 <tr> 129 <td width="100"> </td> 130 <th> 131 <a href="../../../nw/gfx/SceneEnvironment/GetLightSet.html">GetLightSet</a> 132 </th> 133 <td>Obtains a light set from the light set array.</td> 134 </tr> 135 <tr> 136 <th class="category" colspan="3">Light-Related</th> 137 </tr> 138 <tr> 139 <td width="100"> </td> 140 <th> 141 <a href="../../../nw/gfx/SceneEnvironment/SetFragmentLight.html"><CODE>SetFragmentLight</CODE></a> 142 </th> 143 <td>Sets a fragment light.</td> 144 </tr> 145 <tr> 146 <td width="100"> </td> 147 <th> 148 <a href="../../../nw/gfx/SceneEnvironment/GetFragmentLightCount.html"><CODE>GetFragmentLightCount</CODE></a> 149 </th> 150 <td>Gets the number of fragment lights.</td> 151 </tr> 152 <tr> 153 <td width="100"> </td> 154 <th> 155 <a href="../../../nw/gfx/SceneEnvironment/GetFragmentLight.html"><CODE>GetFragmentLight</CODE></a> 156 </th> 157 <td>Gets the fragment light that has been set.</td> 158 </tr> 159 <tr> 160 <td width="100"> </td> 161 <th> 162 <a href="../../../nw/gfx/SceneEnvironment/SetVertexLight.html"><CODE>SetVertexLight</CODE></a> 163 </th> 164 <td>Sets a vertex light.</td> 165 </tr> 166 <tr> 167 <td width="100"> </td> 168 <th> 169 <a href="../../../nw/gfx/SceneEnvironment/GetVertexLight.html"><CODE>GetVertexLight</CODE></a> 170 </th> 171 <td>Gets the vertex light that has been set.</td> 172 </tr> 173 <tr> 174 <td width="100"> </td> 175 <th> 176 <a href="../../../nw/gfx/SceneEnvironment/GetVertexLightCount.html"><CODE>GetVertexLightCount</CODE></a> 177 </th> 178 <td>Gets the number of vertex lights.</td> 179 </tr> 180 <tr> 181 <td width="100"> </td> 182 <th> 183 <a href="../../../nw/gfx/SceneEnvironment/SetAmbientLight.html"><CODE>SetAmbientLight</CODE></a> 184 </th> 185 <td>Sets an ambient light.</td> 186 </tr> 187 <tr> 188 <td width="100"> </td> 189 <th> 190 <a href="../../../nw/gfx/SceneEnvironment/GetAmbientLight.html"><CODE>GetAmbientLight</CODE></a> 191 </th> 192 <td>Gets the ambient light that has been set.</td> 193 </tr> 194 <tr> 195 <td width="100"> </td> 196 <th> 197 <a href="../../../nw/gfx/SceneEnvironment/SetHemiSphereLight.html"><CODE>SetHemiSphereLight</CODE></a> 198 </th> 199 <td>Sets a hemispherical light.</td> 200 </tr> 201 <tr> 202 <td width="100"> </td> 203 <th> 204 <a href="../../../nw/gfx/SceneEnvironment/GetHemiSphereLight.html"><CODE>GetHemiSphereLight</CODE></a> 205 </th> 206 <td>Gets a hemispherical light.</td> 207 </tr> 208 <tr> 209 <td width="100"> </td> 210 <th> 211 <a href="../../../nw/gfx/SceneEnvironment/SetActiveLightSet.html">SetActiveLightSet</a> 212 </th> 213 <td>Sets the active light set.</td> 214 </tr> 215 <tr> 216 <th class="category" colspan="3">Fog-Related</th> 217 </tr> 218 <tr> 219 <td width="100"> </td> 220 <th> 221 <a href="../../../nw/gfx/SceneEnvironment/SetActiveFog.html">SetActiveFog</a> 222 </th> 223 <td>Activates the fog with the specified index.</td> 224 </tr> 225 <tr> 226 <td width="100"> </td> 227 <th> 228 <a href="../../../nw/gfx/SceneEnvironment/GetActiveFog.html">GetActiveFog</a> 229 </th> 230 <td>Obtains active fogs.</td> 231 </tr> 232 <tr> 233 <th class="category" colspan="3">Camera-Related</th> 234 </tr> 235 <tr> 236 <td width="100"> </td> 237 <th> 238 <a href="../../../nw/gfx/SceneEnvironment/NW_DEPRECATED_FUNCTION.html">NW_DEPRECATED_FUNCTION</a> 239 </th> 240 <td>Activates the camera with the specified index. This function is scheduled to be removed in version 1.2.0. Be sure to call <a href="../../../nw/gfx/RenderContext/SetActiveCamera.html">RenderContext::SetActiveCamera</a>.</td> 241 </tr> 242 <tr> 243 <th class="category" colspan="3">Flag-Related</th> 244 </tr> 245 <tr> 246 <td width="100"> </td> 247 <th> 248 <a href="../../../nw/gfx/SceneEnvironment/IsFragmentLightsDirty.html"><CODE>IsFragmentLightsDirty</CODE></a> 249 </th> 250 <td>Gets the flag that indicates whether to reconfigure fragment lights. This feature is provisional.</td> 251 </tr> 252 <tr> 253 <td width="100"> </td> 254 <th> 255 <a href="../../../nw/gfx/SceneEnvironment/SetFragmentLightsDirty.html"><CODE>SetFragmentLightsDirty</CODE></a> 256 </th> 257 <td>Sets the flag that indicates whether to reconfigure fragment lights. This feature is provisional.</td> 258 </tr> 259 <tr> 260 <td width="100"> </td> 261 <th> 262 <a href="../../../nw/gfx/SceneEnvironment/IsAmbientLightDirty.html">IsAmbientLightDirty</a> 263 </th> 264 <td>Gets the flag that indicates whether to reconfigure ambient light. This feature is provisional.</td> 265 </tr> 266 <tr> 267 <td width="100"> </td> 268 <th> 269 <a href="../../../nw/gfx/SceneEnvironment/SetAmbientLightDirty.html">SetAmbientLightDirty</a> 270 </th> 271 <td>Sets the flag that indicates whether to reconfigure ambient light. This feature is provisional.</td> 272 </tr> 273 <tr> 274 <td width="100"> </td> 275 <th> 276 <a href="../../../nw/gfx/SceneEnvironment/IsVertexLightsDirty.html"><CODE>IsVertexLightsDirty</CODE></a> 277 </th> 278 <td>Gets the flag that indicates whether to reconfigure vertex lights. This feature is provisional.</td> 279 </tr> 280 <tr> 281 <td width="100"> </td> 282 <th> 283 <a href="../../../nw/gfx/SceneEnvironment/SetVertexLightsDirty.html"><CODE>SetVertexLightsDirty</CODE></a> 284 </th> 285 <td>Sets the flag that indicates whether to reconfigure vertex lights. This feature is provisional.</td> 286 </tr> 287 <tr> 288 <td width="100"> </td> 289 <th> 290 <a href="../../../nw/gfx/SceneEnvironment/IsHemiSphereLightDirty.html"><CODE>IsHemiSphereLightDirty</CODE></a> 291 </th> 292 <td>Gets the flag that indicates whether to reconfigure hemispherical lights. This feature is provisional.</td> 293 </tr> 294 <tr> 295 <td width="100"> </td> 296 <th> 297 <a href="../../../nw/gfx/SceneEnvironment/SetHemiSphereLightDirty.html"><CODE>SetHemiSphereLightDirty</CODE></a> 298 </th> 299 <td>Sets the flag that indicates whether to reconfigure hemispherical lights. This feature is provisional.</td> 300 </tr> 301 <tr> 302 <td width="100"> </td> 303 <th> 304 <a href="../../../nw/gfx/SceneEnvironment/IsFogDirty.html"><CODE>IsFogDirty</CODE></a> 305 </th> 306 <td>Gets the flag that indicates whether to reconfigure fog. This feature is provisional.</td> 307 </tr> 308 <tr> 309 <td width="100"> </td> 310 <th> 311 <a href="../../../nw/gfx/SceneEnvironment/SetFogDirty.html"><CODE>SetFogDirty</CODE></a> 312 </th> 313 <td>Sets the flag that indicates whether to reconfigure fog. This feature is provisional.</td> 314 </tr> 315 <tr> 316 <td width="100"> </td> 317 <th> 318 <a href="../../../nw/gfx/SceneEnvironment/SetAllFlagsDirty.html">SetAllFlagsDirty</a> 319 </th> 320 <td>Sets the flag that indicates whether to reconfigure light and fog. This feature is provisional.</td> 321 </tr> 322 <tr> 323 <th class="category" colspan="3">State-related</th> 324 </tr> 325 <tr> 326 <td width="100"> </td> 327 <th> 328 <a href="../../../nw/gfx/SceneEnvironment/Reset.html">Reset</a> 329 </th> 330 <td>Resets all states.</td> 331 </tr> 332 <tr> 333 <td width="100"> </td> 334 <th> 335 <a href="../../../nw/gfx/SceneEnvironment/ResetFragmentLights.html">ResetFragmentLights</a> 336 </th> 337 <td>Resets the fragment light state.</td> 338 </tr> 339 <tr> 340 <td width="100"> </td> 341 <th> 342 <a href="../../../nw/gfx/SceneEnvironment/ResetVertexLights.html">ResetVertexLights</a> 343 </th> 344 <td>Resets the vertex light state.</td> 345 </tr> 346 <tr> 347 <td width="100"> </td> 348 <th> 349 <a href="../../../nw/gfx/SceneEnvironment/ResetHemiSphereLight.html">ResetHemiSphereLight</a> 350 </th> 351 <td>Resets the hemispherical light state.</td> 352 </tr> 353 <tr> 354 <td width="100"> </td> 355 <th> 356 <a href="../../../nw/gfx/SceneEnvironment/ResetAmbientLight.html">ResetAmbientLight</a> 357 </th> 358 <td>Resets the ambient light state.</td> 359 </tr> 360 <tr> 361 <td width="100"> </td> 362 <th> 363 <a href="../../../nw/gfx/SceneEnvironment/NW_DEPRECATED_FUNCTION.html">NW_DEPRECATED_FUNCTION</a> 364 </th> 365 <td>Resets the camera state. This function is scheduled to be removed in version 1.2.0.</td> 366 </tr> 367 <tr> 368 <td width="100"> </td> 369 <th> 370 <a href="../../../nw/gfx/SceneEnvironment/ResetFog.html">ResetFog</a> 371 </th> 372 <td>Resets the fog state.</td> 373 </tr> 374 <tr> 375 <td width="100"> </td> 376 <th> 377 <a href="../../../nw/gfx/SceneEnvironment/ResetLightSet.html">ResetLightSet</a> 378 </th> 379 <td>Resets the light set state.</td> 380 </tr> 381 <tr> 382 <th class="category" colspan="3">Other</th> 383 </tr> 384 <tr> 385 <td width="100"> </td> 386 <th> 387 <a href="../../../nw/gfx/SceneEnvironment/SceneEnvironment.html">SceneEnvironment</a> 388 </th> 389 <td>Constructor.</td> 390 </tr> </table> 391 </div> 392 </a> 393 <hr><p>CONFIDENTIAL</p></body> 394</html>