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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Surface Properties (GNU Octave (version 4.4.1))</title>
<meta name="description" content="Surface Properties (GNU Octave (version 4.4.1))">
<meta name="keywords" content="Surface Properties (GNU Octave (version 4.4.1))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Graphics-Object-Properties.html#Graphics-Object-Properties" rel="up" title="Graphics Object Properties">
<link href="Light-Properties.html#Light-Properties" rel="next" title="Light Properties">
<link href="Patch-Properties.html#Patch-Properties" rel="prev" title="Patch Properties">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<a name="Surface-Properties"></a>
<div class="header">
<p>
Next: <a href="Light-Properties.html#Light-Properties" accesskey="n" rel="next">Light Properties</a>, Previous: <a href="Patch-Properties.html#Patch-Properties" accesskey="p" rel="prev">Patch Properties</a>, Up: <a href="Graphics-Object-Properties.html#Graphics-Object-Properties" accesskey="u" rel="up">Graphics Object Properties</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Surface-Properties-1"></a>
<h4 class="subsubsection">15.3.3.8 Surface Properties</h4>
<a name="index--Surface-PropertiesSurface-Properties"></a>
<p>The <code>surface</code> properties are:
</p>
<dl compact="compact">
<dd>
<a name="XREFsurfacealphadata"></a><a name="index-surface-alphadata"></a>
</dd>
<dt><code>alphadata</code>: scalar | matrix, def. <code>1</code></dt>
<dd><p>Transparency is not yet implemented for surface objects. <code>alphadata</code> is unused.
</p>
<a name="XREFsurfacealphadatamapping"></a><a name="index-surface-alphadatamapping"></a>
</dd>
<dt><code>alphadatamapping</code>: <code>"direct"</code> | <code>"none"</code> | {<code>"scaled"</code>}</dt>
<dd><p>Transparency is not yet implemented for surface objects. <code>alphadatamapping</code> is unused.
</p>
<a name="XREFsurfaceambientstrength"></a><a name="index-surface-ambientstrength"></a>
</dd>
<dt><code>ambientstrength</code>: scalar, def. <code>0.30000</code></dt>
<dd><p>Strength of the ambient light. Value between 0.0 and 1.0
</p>
<a name="XREFsurfacebackfacelighting"></a><a name="index-surface-backfacelighting"></a>
</dd>
<dt><code>backfacelighting</code>: <code>"lit"</code> | {<code>"reverselit"</code>} | <code>"unlit"</code></dt>
<dd><p><code>"lit"</code>: The normals are used as is for lighting. <code>"reverselit"</code>: The normals are always oriented towards the point of view. <code>"unlit"</code>: Faces with normals pointing away from the point of view are unlit.
</p>
<a name="XREFsurfacebeingdeleted"></a><a name="index-surface-beingdeleted"></a>
</dd>
<dt><code>beingdeleted</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<a name="XREFsurfacebusyaction"></a><a name="index-surface-busyaction"></a>
</dd>
<dt><code>busyaction</code>: <code>"cancel"</code> | {<code>"queue"</code>}</dt>
<dd><p>Define how Octave handles the execution of this object’s callback properties when it is unable to interrupt another object’s executing callback. This is only relevant when the currently executing callback object has its <code>interruptible</code> property set to <code>"off"</code>. The <code>busyaction</code> property of the interrupting callback object indicates whether the interrupting callback is queued (<code>"queue"</code> (default)) or discarded (<code>"cancel"</code>).
See <a href="Callbacks.html#Callbacks">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFsurfacebuttondownfcn"></a><a name="index-surface-buttondownfcn"></a>
</dd>
<dt><code>buttondownfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>For information on how to write graphics listener functions see <a href="Callbacks.html#Callbacks">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFsurfacecdata"></a><a name="index-surface-cdata"></a>
</dd>
<dt><code>cdata</code>: matrix, def. 3-by-3 double</dt>
<dd>
<a name="XREFsurfacecdatamapping"></a><a name="index-surface-cdatamapping"></a>
</dd>
<dt><code>cdatamapping</code>: <code>"direct"</code> | {<code>"scaled"</code>}</dt>
<dd>
<a name="XREFsurfacecdatasource"></a><a name="index-surface-cdatasource"></a>
</dd>
<dt><code>cdatasource</code>: def. <code>""</code></dt>
<dd>
<a name="XREFsurfacechildren"></a><a name="index-surface-children"></a>
</dd>
<dt><code>children</code> (read-only): vector of graphics handles, def. <code>[](0x1)</code></dt>
<dd><p><code>children</code> is unused.
</p>
<a name="XREFsurfaceclipping"></a><a name="index-surface-clipping"></a>
</dd>
<dt><code>clipping</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>clipping</code> is <code>"on"</code>, the surface is clipped in its parent axes limits.
</p>
<a name="XREFsurfacecreatefcn"></a><a name="index-surface-createfcn"></a>
</dd>
<dt><code>createfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately after surface has been created. Function is set by using default property on root object, e.g., <code>set (groot, "defaultsurfacecreatefcn", 'disp ("surface created!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html#Callbacks">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFsurfacedeletefcn"></a><a name="index-surface-deletefcn"></a>
</dd>
<dt><code>deletefcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately before surface is deleted.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html#Callbacks">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFsurfacediffusestrength"></a><a name="index-surface-diffusestrength"></a>
</dd>
<dt><code>diffusestrength</code>: scalar, def. <code>0.60000</code></dt>
<dd><p>Strength of the diffuse reflex. Value between 0.0 (no diffuse reflex) and 1.0 (full diffuse reflex).
</p>
<a name="XREFsurfacedisplayname"></a><a name="index-surface-displayname"></a>
</dd>
<dt><code>displayname</code>: def. <code>""</code></dt>
<dd><p>Text for the legend entry corresponding to this surface.
</p>
<a name="XREFsurfaceedgealpha"></a><a name="index-surface-edgealpha"></a>
</dd>
<dt><code>edgealpha</code>: scalar, def. <code>1</code></dt>
<dd><p>Transparency is not yet implemented for surface objects. <code>edgealpha</code> is unused.
</p>
<a name="XREFsurfaceedgecolor"></a><a name="index-surface-edgecolor"></a>
</dd>
<dt><code>edgecolor</code>: def. <code>[0 0 0]</code></dt>
<dd>
<a name="XREFsurfaceedgelighting"></a><a name="index-surface-edgelighting"></a>
</dd>
<dt><code>edgelighting</code>: <code>"flat"</code> | <code>"gouraud"</code> | {<code>"none"</code>} | <code>"phong"</code></dt>
<dd><p>When set to a value other than <code>"none"</code>, the edges of the object are drawn with light and shadow effects. Supported values are <code>"none"</code> (no lighting effects), <code>"flat"</code> (facetted look) and <code>"gouraud"</code> (linear interpolation of the lighting effects between the vertices). <code>"phong"</code> is deprecated and has the same effect as <code>"gouraud"</code>.
</p>
<a name="XREFsurfacefacealpha"></a><a name="index-surface-facealpha"></a>
</dd>
<dt><code>facealpha</code>: scalar | <code>"flat"</code> | <code>"interp"</code> | <code>"texturemap"</code>, def. <code>1</code></dt>
<dd><p>Transparency level of the faces of the surface object. Only double values are supported at present where a value of 0 means complete transparency and a value of 1 means solid faces without transparency. Setting the property to <code>"flat"</code>, <code>"interp"</code> or <code>"texturemap"</code> causes the faces to not being rendered. Additionally, the faces are not sorted from back to front which might lead to unexpected results when rendering layered transparent faces.
</p>
<a name="XREFsurfacefacecolor"></a><a name="index-surface-facecolor"></a>
</dd>
<dt><code>facecolor</code>: {<code>"flat"</code>} | <code>"interp"</code> | <code>"none"</code> | <code>"texturemap"</code></dt>
<dd>
<a name="XREFsurfacefacelighting"></a><a name="index-surface-facelighting"></a>
</dd>
<dt><code>facelighting</code>: {<code>"flat"</code>} | <code>"gouraud"</code> | <code>"none"</code> | <code>"phong"</code></dt>
<dd><p>When set to a value other than <code>"none"</code>, the faces of the object are drawn with light and shadow effects. Supported values are <code>"none"</code> (no lighting effects), <code>"flat"</code> (facetted look) and <code>"gouraud"</code> (linear interpolation of the lighting effects between the vertices). <code>"phong"</code> is deprecated and has the same effect as <code>"gouraud"</code>.
</p>
<a name="XREFsurfacefacenormals"></a><a name="index-surface-facenormals"></a>
</dd>
<dt><code>facenormals</code>: def. <code>[](0x0)</code></dt>
<dd>
<a name="XREFsurfacefacenormalsmode"></a><a name="index-surface-facenormalsmode"></a>
</dd>
<dt><code>facenormalsmode</code>: {<code>"auto"</code>} | <code>"manual"</code></dt>
<dd>
<a name="XREFsurfacehandlevisibility"></a><a name="index-surface-handlevisibility"></a>
</dd>
<dt><code>handlevisibility</code>: <code>"callback"</code> | <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>handlevisibility</code> is <code>"off"</code>, the surface’s handle is not visible in its parent’s "children" property.
</p>
<a name="XREFsurfacehittest"></a><a name="index-surface-hittest"></a>
</dd>
<dt><code>hittest</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Specify whether surface processes mouse events or passes them to ancestors of the object. When enabled, the object may respond to mouse clicks by evaluating the <code>"buttondownfcn"</code>, showing the uicontextmenu, and eventually becoming the root <code>"currentobject"</code>. This property is only relevant when the object can accept mouse clicks which is determined by the <code>"pickableparts"</code> property. See <a href="#XREFsurfacepickableparts">pickableparts property<!-- /@w --></a>.
</p>
<a name="XREFsurfaceinterruptible"></a><a name="index-surface-interruptible"></a>
</dd>
<dt><code>interruptible</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Specify whether this object’s callback functions may be interrupted by other callbacks. By default <code>interruptible</code> is <code>"on"</code> and callbacks that make use of <code>drawnow</code>, <code>figure</code>, <code>waitfor</code>, <code>getframe</code> or <code>pause</code> functions are eventually interrupted.
See <a href="Callbacks.html#Callbacks">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFsurfacelinestyle"></a><a name="index-surface-linestyle"></a>
</dd>
<dt><code>linestyle</code>: {<code>"-"</code>} | <code>"--"</code> | <code>"-."</code> | <code>":"</code> | <code>"none"</code></dt>
<dd><p>See <a href="Line-Styles.html#Line-Styles">Line Styles</a>.
</p>
<a name="XREFsurfacelinewidth"></a><a name="index-surface-linewidth"></a>
</dd>
<dt><code>linewidth</code>: def. <code>0.50000</code></dt>
<dd><p>See <a href="Line-Properties.html#XREFlinelinewidth">line linewidth property<!-- /@w --></a>.
</p>
<a name="XREFsurfacemarker"></a><a name="index-surface-marker"></a>
</dd>
<dt><code>marker</code>: <code>"*"</code> | <code>"+"</code> | <code>"."</code> | <code>"<"</code> | <code>">"</code> | <code>"^"</code> | <code>"d"</code> | <code>"diamond"</code> | <code>"h"</code> | <code>"hexagram"</code> | {<code>"none"</code>} | <code>"o"</code> | <code>"p"</code> | <code>"pentagram"</code> | <code>"s"</code> | <code>"square"</code> | <code>"v"</code> | <code>"x"</code></dt>
<dd><p>See <a href="Marker-Styles.html#Marker-Styles">Marker Styles</a>.
</p>
<a name="XREFsurfacemarkeredgecolor"></a><a name="index-surface-markeredgecolor"></a>
</dd>
<dt><code>markeredgecolor</code>: {<code>"auto"</code>} | <code>"flat"</code> | <code>"none"</code></dt>
<dd><p>See <a href="Line-Properties.html#XREFlinemarkeredgecolor">line markeredgecolor property<!-- /@w --></a>.
</p>
<a name="XREFsurfacemarkerfacecolor"></a><a name="index-surface-markerfacecolor"></a>
</dd>
<dt><code>markerfacecolor</code>: <code>"auto"</code> | <code>"flat"</code> | {<code>"none"</code>}</dt>
<dd><p>See <a href="Line-Properties.html#XREFlinemarkerfacecolor">line markerfacecolor property<!-- /@w --></a>.
</p>
<a name="XREFsurfacemarkersize"></a><a name="index-surface-markersize"></a>
</dd>
<dt><code>markersize</code>: scalar, def. <code>6</code></dt>
<dd><p>See <a href="Line-Properties.html#XREFlinemarkersize">line markersize property<!-- /@w --></a>.
</p>
<a name="XREFsurfacemeshstyle"></a><a name="index-surface-meshstyle"></a>
</dd>
<dt><code>meshstyle</code>: {<code>"both"</code>} | <code>"column"</code> | <code>"row"</code></dt>
<dd>
<a name="XREFsurfaceparent"></a><a name="index-surface-parent"></a>
</dd>
<dt><code>parent</code>: graphics handle</dt>
<dd><p>Handle of the parent graphics object.
</p>
<a name="XREFsurfacepickableparts"></a><a name="index-surface-pickableparts"></a>
</dd>
<dt><code>pickableparts</code>: <code>"all"</code> | <code>"none"</code> | {<code>"visible"</code>}</dt>
<dd><p>Specify whether surface will accept mouse clicks. By default, <code>pickableparts</code> is <code>"visible"</code> and only visible parts of the surface or its children may react to mouse clicks. When <code>pickableparts</code> is <code>"all"</code> both visible and invisible parts (or children) may react to mouse clicks. When <code>pickableparts</code> is <code>"none"</code> mouse clicks on the object are ignored and transmitted to any objects underneath this one. When an object is configured to accept mouse clicks the <code>"hittest"</code> property will determine how they are processed. See <a href="#XREFsurfacehittest">hittest property<!-- /@w --></a>.
</p>
<a name="XREFsurfaceselected"></a><a name="index-surface-selected"></a>
</dd>
<dt><code>selected</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<a name="XREFsurfaceselectionhighlight"></a><a name="index-surface-selectionhighlight"></a>
</dd>
<dt><code>selectionhighlight</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFsurfacespecularcolorreflectance"></a><a name="index-surface-specularcolorreflectance"></a>
</dd>
<dt><code>specularcolorreflectance</code>: scalar, def. <code>1</code></dt>
<dd><p>Reflectance for specular color. Value between 0.0 (color of underlying face) and 1.0 (color of light source).
</p>
<a name="XREFsurfacespecularexponent"></a><a name="index-surface-specularexponent"></a>
</dd>
<dt><code>specularexponent</code>: scalar, def. <code>10</code></dt>
<dd><p>Exponent for the specular reflex. The lower the value, the more the reflex is spread out.
</p>
<a name="XREFsurfacespecularstrength"></a><a name="index-surface-specularstrength"></a>
</dd>
<dt><code>specularstrength</code>: scalar, def. <code>0.90000</code></dt>
<dd><p>Strength of the specular reflex. Value between 0.0 (no specular reflex) and 1.0 (full specular reflex).
</p>
<a name="XREFsurfacetag"></a><a name="index-surface-tag"></a>
</dd>
<dt><code>tag</code>: string, def. <code>""</code></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<a name="XREFsurfacetype"></a><a name="index-surface-type"></a>
</dd>
<dt><code>type</code> (read-only): string</dt>
<dd><p>Class name of the graphics object. <code>type</code> is always <code>"surface"</code>
</p>
<a name="XREFsurfaceuicontextmenu"></a><a name="index-surface-uicontextmenu"></a>
</dd>
<dt><code>uicontextmenu</code>: graphics handle, def. <code>[](0x0)</code></dt>
<dd><p>Graphics handle of the uicontextmenu object that is currently associated to this surface object.
</p>
<a name="XREFsurfaceuserdata"></a><a name="index-surface-userdata"></a>
</dd>
<dt><code>userdata</code>: Any Octave data, def. <code>[](0x0)</code></dt>
<dd><p>User-defined data to associate with the graphics object.
</p>
<a name="XREFsurfacevertexnormals"></a><a name="index-surface-vertexnormals"></a>
</dd>
<dt><code>vertexnormals</code>: def. 3-by-3-by-3 double</dt>
<dd>
<a name="XREFsurfacevertexnormalsmode"></a><a name="index-surface-vertexnormalsmode"></a>
</dd>
<dt><code>vertexnormalsmode</code>: {<code>"auto"</code>} | <code>"manual"</code></dt>
<dd>
<a name="XREFsurfacevisible"></a><a name="index-surface-visible"></a>
</dd>
<dt><code>visible</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>visible</code> is <code>"off"</code>, the surface is not rendered on screen.
</p>
<a name="XREFsurfacexdata"></a><a name="index-surface-xdata"></a>
</dd>
<dt><code>xdata</code>: matrix, def. <code>[1 2 3]</code></dt>
<dd>
<a name="XREFsurfacexdatasource"></a><a name="index-surface-xdatasource"></a>
</dd>
<dt><code>xdatasource</code>: def. <code>""</code></dt>
<dd>
<a name="XREFsurfaceydata"></a><a name="index-surface-ydata"></a>
</dd>
<dt><code>ydata</code>: matrix, def. <code>[1; 2; 3]</code></dt>
<dd>
<a name="XREFsurfaceydatasource"></a><a name="index-surface-ydatasource"></a>
</dd>
<dt><code>ydatasource</code>: def. <code>""</code></dt>
<dd>
<a name="XREFsurfacezdata"></a><a name="index-surface-zdata"></a>
</dd>
<dt><code>zdata</code>: matrix, def. 3-by-3 double</dt>
<dd>
<a name="XREFsurfacezdatasource"></a><a name="index-surface-zdatasource"></a>
</dd>
<dt><code>zdatasource</code>: def. <code>""</code></dt>
</dl>
<hr>
<div class="header">
<p>
Next: <a href="Light-Properties.html#Light-Properties" accesskey="n" rel="next">Light Properties</a>, Previous: <a href="Patch-Properties.html#Patch-Properties" accesskey="p" rel="prev">Patch Properties</a>, Up: <a href="Graphics-Object-Properties.html#Graphics-Object-Properties" accesskey="u" rel="up">Graphics Object Properties</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
