-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapiskykeyframe.html
More file actions
250 lines (215 loc) · 18.2 KB
/
Copy pathapiskykeyframe.html
File metadata and controls
250 lines (215 loc) · 18.2 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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" ><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" >
<title>Sky Keyframe — Simul documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" >
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" >
<link rel="shortcut icon" href="../_static/favicon.ico">
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" >
<link rel="search" title="Search" href="../search.html" >
<link rel="next" title="Skylight" href="apiskylight.html" >
<link rel="prev" title="Sky Keyframer" href="apiskykeyframer.html" >
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="" >
<span class="sidebartitle">
trueSKY 4.3
</span>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<label class="search-label" for="q">Search the documentation</label>
<input type="text" name="q" id="q" placeholder="Search..." aria-label="Search docs" >
<input type="hidden" name="check_keywords" value="yes" >
<input type="hidden" name="area" value="default" >
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation and Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorialsindex.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../unreal.html">trueSKY for Unreal Engine</a></li>
<li class="toctree-l1"><a class="reference internal" href="../unity.html">trueSKY for Unity</a></li>
<li class="toctree-l1"><a class="reference internal" href="../skysequencer.html">Sky Sequencer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../programming.html">Programming with the trueSKY SDK</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../legalindex.html">trueSKY Licences</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="apiindex.html">API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="apibaseweatherrenderer.html">Base Weather Renderer</a></li>
<li class="toctree-l2"><a class="reference internal" href="apienvironment.html">Environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="apicloudrenderer.html">Cloud Renderer</a></li>
<li class="toctree-l2"><a class="reference internal" href="apicloudkeyframer.html">Cloud Keyframer</a></li>
<li class="toctree-l2"><a class="reference internal" href="apicloudkeyframe.html">Cloud Keyframe</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiskykeyframer.html">Sky Keyframer</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Sky Keyframe</a></li>
<li class="toctree-l2"><a class="reference internal" href="apiskylight.html">Skylight</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../Reference/referenceindex.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelist.html">Changelist</a></li>
</ul>
</div>
</div>
</nav>
<div data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<h2 class="wy-nav-top">Navigation</h2><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Simul</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="apiindex.html">API</a></li>
<li class="breadcrumb-item active">Sky Keyframe</li>
<li class="wy-breadcrumbs-aside">
<div class="truesky-version-switch">
<button id="version-switch-button">Switch Version</button>
</div>
<script>
const switchButton = document.getElementById('version-switch-button');
// current URL
const currentURL = window.location.href;
const isVersion4_3 = currentURL.includes('/4.3');
const isVersion4_4 = currentURL.includes('/4.4');
if (isVersion4_3) {
switchButton.textContent = 'Switch to 4.4';
switchButton.addEventListener('click', () => {
window.location.href = '/4.4';
});
} else if (isVersion4_4) {
switchButton.textContent = 'Switch to 4.3';
switchButton.addEventListener('click', () => {
window.location.href = '/4.3';
});
} else {
switchButton.textContent = 'Switch to 4.3';
switchButton.addEventListener('click', () => {
window.location.href = '/4.3';
});
}
</script>
</li>
</ul>
<hr>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="sky-keyframe">
<h1>Sky Keyframe<a class="headerlink" href="#sky-keyframe" title="Permalink to this heading">¶</a></h1>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframeE">
<span id="_CPPv3N5simul3sky11SkyKeyframeE"></span><span id="_CPPv2N5simul3sky11SkyKeyframeE"></span><span id="simul::sky::SkyKeyframe"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SkyKeyframe</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">simul</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">sky</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">BaseKeyframe</span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The keyframe structure for <a class="reference internal" href="../Reference/Sky/skykeyframer.html#classsimul_1_1sky_1_1_sky_keyframer"><span class="std std-ref">simul::sky::SkyKeyframer</span></a>. </p>
<p>The properties of any sky keyframe can be changed at any time. However, only HazeEccentricity can be changed for an in-use keyframe without triggering a recalculation of the colour tables. </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric">Public Members</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe7daytimeE">
<span id="_CPPv3N5simul3sky11SkyKeyframe7daytimeE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe7daytimeE"></span><span id="simul::sky::SkyKeyframe::daytime__float"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1aa2e71e97bce93e87dbe95180c23abe46"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">daytime</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe7daytimeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The time this keyframe represents, in a floating-point number of days from the starting midnight of the sequence. If simul::sky::SkyKeyframer::SetLinkKeyframeTimeAndDaytime is true, this is not used. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe3MieE">
<span id="_CPPv3N5simul3sky11SkyKeyframe3MieE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe3MieE"></span><span id="simul::sky::SkyKeyframe::Mie__float4"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1a4aea4d3416012349f0358ba4799a51d4"></span><span class="k"><span class="pre">mutable</span></span><span class="w"> </span><span class="n"><span class="pre">float4</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Mie</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe3MieE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The Mie scattering coefficients (x=red,y=green,z=blue). Mutable because of AutoMie. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe4HazeE">
<span id="_CPPv3N5simul3sky11SkyKeyframe4HazeE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe4HazeE"></span><span id="simul::sky::SkyKeyframe::Haze__float"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1a419234a7ced35b650c4d141a53e0063f"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Haze</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe4HazeE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The amount of haze, mist or fog. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe10HazeBaseKmE">
<span id="_CPPv3N5simul3sky11SkyKeyframe10HazeBaseKmE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe10HazeBaseKmE"></span><span id="simul::sky::SkyKeyframe::HazeBaseKm__float"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1aa88b3f13c9ab9cd2cce0feaa6024be1a"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HazeBaseKm</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe10HazeBaseKmE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The base altitude, above which haze starts to decrease in density. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe11HazeScaleKmE">
<span id="_CPPv3N5simul3sky11SkyKeyframe11HazeScaleKmE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe11HazeScaleKmE"></span><span id="simul::sky::SkyKeyframe::HazeScaleKm__float"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1a0fe6944ca955e386b04fca4c258e392d"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HazeScaleKm</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe11HazeScaleKmE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The vertical scale over which haze reduces with altitude. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe16HazeEccentricityE">
<span id="_CPPv3N5simul3sky11SkyKeyframe16HazeEccentricityE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe16HazeEccentricityE"></span><span id="simul::sky::SkyKeyframe::HazeEccentricity__float"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1ad38f511128b7c2de3304ade39cb5b6be"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HazeEccentricity</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe16HazeEccentricityE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>The anisotropy of Mie scattering. Can be changed without recalculating tables. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe9GroundFogE">
<span id="_CPPv3N5simul3sky11SkyKeyframe9GroundFogE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe9GroundFogE"></span><span id="simul::sky::SkyKeyframe::GroundFog__float"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1a897d0ecbc478572ff6c30070abcae75b"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GroundFog</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe9GroundFogE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Thick ground fog. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe12FogCeilingKmE">
<span id="_CPPv3N5simul3sky11SkyKeyframe12FogCeilingKmE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe12FogCeilingKmE"></span><span id="simul::sky::SkyKeyframe::FogCeilingKm__float"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1a51e1d14766062cd968f10b23c65025b4"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FogCeilingKm</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe12FogCeilingKmE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Upper limit of ground fog. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe20SeaLevelTemperatureKE">
<span id="_CPPv3N5simul3sky11SkyKeyframe20SeaLevelTemperatureKE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe20SeaLevelTemperatureKE"></span><span id="simul::sky::SkyKeyframe::SeaLevelTemperatureK__float"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1add48aae5d32ba2f52a7c0be072cb1eac"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SeaLevelTemperatureK</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe20SeaLevelTemperatureKE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Temperature at sealevel, in kelvins - mainly relevant to infra-red. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe14StoreAsColoursE">
<span id="_CPPv3N5simul3sky11SkyKeyframe14StoreAsColoursE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe14StoreAsColoursE"></span><span id="simul::sky::SkyKeyframe::StoreAsColours__float"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1a4390fc48442fa98529b7cd0ec7367b72"></span><span class="kt"><span class="pre">float</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StoreAsColours</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe14StoreAsColoursE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>If true, the keyframe is stored as a colour table, rather than generating its colours from its properties. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe7AutoMieE">
<span id="_CPPv3N5simul3sky11SkyKeyframe7AutoMieE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe7AutoMieE"></span><span id="simul::sky::SkyKeyframe::AutoMie__b"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1aa9b008521ddd014a04a11f68e573f728"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AutoMie</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe7AutoMieE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Whether to recalculate the Mie coefficients based on the haze at this keyframe. </p>
</dd></dl>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N5simul3sky11SkyKeyframe20automaticSunPositionE">
<span id="_CPPv3N5simul3sky11SkyKeyframe20automaticSunPositionE"></span><span id="_CPPv2N5simul3sky11SkyKeyframe20automaticSunPositionE"></span><span id="simul::sky::SkyKeyframe::automaticSunPosition__b"></span><span class="target" id="structsimul_1_1sky_1_1_sky_keyframe_1a43c06a2a0139666abae0a6a595535345"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">automaticSunPosition</span></span></span><a class="headerlink" href="#_CPPv4N5simul3sky11SkyKeyframe20automaticSunPositionE" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Whether to calculate the sun position from the date and time. </p>
</dd></dl>
</div>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="apiskykeyframer.html" class="btn btn-neutral float-left" title="Sky Keyframer" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="apiskylight.html" class="btn btn-neutral float-right" title="Skylight" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr>
<div role="contentinfo">
<p>© Copyright 2007-2023, Simul Software Ltd.</p>
</div>
</footer>
</div>
</div>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<div class="overlay" style="display: none;">
<img class="fullsize" alt="fullscreen image overlay" src="data:,">
</div>
</body>
</html>