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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleDataURI: Class TDataURI</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<a name="TDataURI"></a><h1 class="cio">Class TDataURI</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="CastleDataURI.html">CastleDataURI</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TDataURI = class(TObject)</code></p>
<h2 class="description">Description</h2>
<p>
Reading data URI scheme, see <a href="http://en.wikipedia.org/wiki/Data_URI_scheme">http://en.wikipedia.org/wiki/Data_URI_scheme</a>. Such URI specifies the MIME type and contains the data, encoded in plain text or <a class="normal" href="CastleDataURI.TDataURI.html#Base64">base64</a>. That is, the data is not merely referenced / linked (like with a usual URL), it's simply fully encoded inside the URI. Since such URI can be used anywhere a normal URI is expected, it allows you to inline any kind of data inside any container file. For example, you can place images (textures) and such directly inside a VRML/X3D file.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TDataURI</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <b><a href="CastleDataURI.TDataURI.html#Destroy">Destroy</a></b>; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <b><a href="CastleDataURI.TDataURI.html#IsDataURI">IsDataURI</a></b>(const URI: string; out Colon: Integer): boolean;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <b><a href="CastleDataURI.TDataURI.html#IsDataURI">IsDataURI</a></b>(const URI: string): boolean;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="CastleDataURI.TDataURI.html#Stream">Stream</a></b>: TStream;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="CastleDataURI.TDataURI.html#ExtractStream">ExtractStream</a></b>: TStream;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleDataURI.TDataURI.html#ForceMemoryStream">ForceMemoryStream</a></b>: boolean
read FForceMemoryStream write FForceMemoryStream;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleDataURI.TDataURI.html#URI">URI</a></b>: string read FURI write SetURI;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleDataURI.TDataURI.html#Valid">Valid</a></b>: boolean read FValid;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleDataURI.TDataURI.html#MimeType">MimeType</a></b>: string read FMimeType;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleDataURI.TDataURI.html#Base64">Base64</a></b>: boolean read FBase64;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleDataURI.TDataURI.html#Charset">Charset</a></b>: string read FCharset;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleDataURI.TDataURI.html#URIPrefix">URIPrefix</a></b>: string read FURIPrefix;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="IsDataURI"></a><code>class function <b>IsDataURI</b>(const URI: string; out Colon: Integer): boolean;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="IsDataURI"></a><code>class function <b>IsDataURI</b>(const URI: string): boolean;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Stream"></a><code>function <b>Stream</b>: TStream;</code></td>
</tr>
<tr><td colspan="2">
<p>
Read the actual data contents. If the <a class="normal" href="CastleDataURI.TDataURI.html#URI">URI</a> is not valid (includes the initial state when it's not set) then returns <code>Nil</code>.
<p>The important property of this reader is that no expensive encoding is done until you call this method. In particular, you can set URI, check <a class="normal" href="CastleDataURI.TDataURI.html#MimeType">MimeType</a>, and if you see that <a class="normal" href="CastleDataURI.TDataURI.html#MimeType">MimeType</a> is something not interesting for you (for example, maybe you require some image type) just don't call this method. Then nothing expensive will happen, e.g. data will not be <a class="normal" href="CastleDataURI.TDataURI.html#Base64">base64</a>-decoded without a need.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ExtractStream"></a><code>function <b>ExtractStream</b>: TStream;</code></td>
</tr>
<tr><td colspan="2">
<p>
Get <a class="normal" href="CastleDataURI.TDataURI.html#Stream">Stream</a> and clear it. Makes the stream no longer owner by this <a class="normal" href="CastleDataURI.TDataURI.html">TDataURI</a> instance.
<p>Do not call <a class="normal" href="CastleDataURI.TDataURI.html#Stream">Stream</a> after calling <a class="normal" href="CastleDataURI.TDataURI.html#ExtractStream">ExtractStream</a>. Results are undefined. (Right now, another decoding stream will then be created, that will return the same thing as previous stream. But do not depend on it.)</p>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ForceMemoryStream"></a><code>property <b>ForceMemoryStream</b>: boolean
read FForceMemoryStream write FForceMemoryStream;</code></td>
</tr>
<tr><td colspan="2">
<p>
Force <a class="normal" href="CastleDataURI.TDataURI.html#Stream">Stream</a> and <a class="normal" href="CastleDataURI.TDataURI.html#ExtractStream">ExtractStream</a> to return a TMemoryStream, that is always seekable and fully buffered in memory. Without this, they may return TBase64DecodingStream that may not be seekable.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="URI"></a><code>property <b>URI</b>: string read FURI write SetURI;</code></td>
</tr>
<tr><td colspan="2">
<p>
The data URI that this class reads.
<p>When you set this, we read the beginning of URI. If this is a valid data URI, then we set <a class="normal" href="CastleDataURI.TDataURI.html#Valid">Valid</a> to <code>True</code>, update <a class="normal" href="CastleDataURI.TDataURI.html#MimeType">MimeType</a>, <a class="normal" href="CastleDataURI.TDataURI.html#Base64">Base64</a>, <a class="normal" href="CastleDataURI.TDataURI.html#Charset">Charset</a>, <a class="normal" href="CastleDataURI.TDataURI.html#URIPrefix">URIPrefix</a> accordingly, and you can call <a class="normal" href="CastleDataURI.TDataURI.html#Stream">Stream</a> if you want to read actual contents.
<p>If this is not a valid data URI, then we set <a class="normal" href="CastleDataURI.TDataURI.html#Valid">Valid</a> to <code>False</code>, make appropriate warning through <a class="normal" href="CastleWarnings.html#OnWarning">OnWarning</a>, and reset <a class="normal" href="CastleDataURI.TDataURI.html#MimeType">MimeType</a>, <a class="normal" href="CastleDataURI.TDataURI.html#Base64">Base64</a>, <a class="normal" href="CastleDataURI.TDataURI.html#Charset">Charset</a>, <a class="normal" href="CastleDataURI.TDataURI.html#URIPrefix">URIPrefix</a> to some default values.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Valid"></a><code>property <b>Valid</b>: boolean read FValid;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="MimeType"></a><code>property <b>MimeType</b>: string read FMimeType;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Base64"></a><code>property <b>Base64</b>: boolean read FBase64;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Charset"></a><code>property <b>Charset</b>: string read FCharset;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="URIPrefix"></a><code>property <b>URIPrefix</b>: string read FURIPrefix;</code></td>
</tr>
<tr><td colspan="2">
<p>
URI without the data, nice to show to user.</p>
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(["trackPageView"]);
_paq.push(["enableLinkTracking"]);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
_paq.push(["setTrackerUrl", u+"piwik.php"]);
_paq.push(["setSiteId", "1"]);
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Piwik Code -->
<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:09</em>
</span>
</td></tr></table></body></html>
|
