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
408
409
410
411
412
413
414
415
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Surface Properties (GNU Octave (version 10.3.0))</title>
<meta name="description" content="Surface Properties (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Surface Properties (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Graphics-Object-Properties.html" rel="up" title="Graphics Object Properties">
<link href="Light-Properties.html" rel="next" title="Light Properties">
<link href="Scatter-Properties.html" rel="prev" title="Scatter Properties">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="subsubsection-level-extent" id="Surface-Properties">
<div class="nav-panel">
<p>
Next: <a href="Light-Properties.html" accesskey="n" rel="next">Light Properties</a>, Previous: <a href="Scatter-Properties.html" accesskey="p" rel="prev">Scatter Properties</a>, Up: <a href="Graphics-Object-Properties.html" 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" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsubsection" id="Surface-Properties-1"><span>15.3.3.10 Surface Properties<a class="copiable-link" href="#Surface-Properties-1"> ¶</a></span></h4>
<a class="index-entry-id" id="index-Surface-Properties"></a>
<p>Properties of <code class="code">surface</code> objects (see <a class="pxref" href="Creating-Graphics-Objects.html#XREFsurface">surface</a>):
</p>
<h4 class="subsubheading" id="Categories_003a-9"><span>Categories:<a class="copiable-link" href="#Categories_003a-9"> ¶</a></span></h4>
<p><a class="ref" href="#XREFsurfacecategoryCallbackExecution">Callback Execution<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryColorandTransparency">Color and Transparency<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryCoordinateData">Coordinate Data<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryCreation_002fDeletion">Creation/Deletion<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryDisplay">Display<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryFacesAppearance">Faces Appearance<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryLegendOptions">Legend Options<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryLighting">Lighting<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryMarkerAppearance">Marker Appearance<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryMouseInteraction">Mouse Interaction<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryObjectIdentification">Object Identification<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryOutlineAppearance">Outline Appearance<!-- /@w --></a> | <a class="ref" href="#XREFsurfacecategoryParent_002fChildren">Parent/Children<!-- /@w --></a>
</p>
<a class="anchor" id="XREFsurfacecategoryCallbackExecution"></a><h4 class="subsubheading" id="Callback-Execution-9"><span>Callback Execution<a class="copiable-link" href="#Callback-Execution-9"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfacebusyaction"></a></dd>
<dt><a id="index-surface-busyaction"></a><span><code class="code">busyaction</code>: <code class="code">"cancel"</code> | {<code class="code">"queue"</code>}<a class="copiable-link" href="#index-surface-busyaction"> ¶</a></span></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 class="code">interruptible</code> property set to <code class="code">"off"</code>. The <code class="code">busyaction</code> property of the interrupting callback object indicates whether the interrupting callback is queued (<code class="code">"queue"</code> (default)) or discarded (<code class="code">"cancel"</code>).
See <a class="xref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFsurfaceinterruptible"></a></dd>
<dt><a id="index-surface-interruptible"></a><span><code class="code">interruptible</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-surface-interruptible"> ¶</a></span></dt>
<dd><p>Specify whether this object’s callback functions may be interrupted by other callbacks. By default <code class="code">interruptible</code> is <code class="code">"on"</code> and callbacks that make use of <code class="code">drawnow</code>, <code class="code">figure</code>, <code class="code">waitfor</code>, <code class="code">getframe</code> or <code class="code">pause</code> functions are eventually interrupted.
See <a class="xref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryColorandTransparency"></a><h4 class="subsubheading" id="Color-and-Transparency-2"><span>Color and Transparency<a class="copiable-link" href="#Color-and-Transparency-2"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfacealphadata"></a></dd>
<dt><a id="index-surface-alphadata"></a><span><code class="code">alphadata</code>: scalar | matrix, def. <code class="code">1</code><a class="copiable-link" href="#index-surface-alphadata"> ¶</a></span></dt>
<dd><p>Transparency is not yet implemented for surface objects. <code class="code">alphadata</code> is unused.
</p>
<a class="anchor" id="XREFsurfacealphadatamapping"></a></dd>
<dt><a id="index-surface-alphadatamapping"></a><span><code class="code">alphadatamapping</code>: <code class="code">"direct"</code> | <code class="code">"none"</code> | {<code class="code">"scaled"</code>}<a class="copiable-link" href="#index-surface-alphadatamapping"> ¶</a></span></dt>
<dd><p>Transparency is not yet implemented for surface objects. <code class="code">alphadatamapping</code> is unused.
</p>
<a class="anchor" id="XREFsurfacecdata"></a></dd>
<dt><a id="index-surface-cdata"></a><span><code class="code">cdata</code>: array, def. 3-by-3 double<a class="copiable-link" href="#index-surface-cdata"> ¶</a></span></dt>
<dd><p>Color data values for surface vertices. Data is stored either as a 2-D matrix the same size as <a class="ref" href="#XREFsurfacezdata"><code class="code">"zdata"</code></a> where each element’s value determines that vertex’s color according to the current colormap, or as a 3-D array where the third dimension contains separate red, blue, and green components for each vertex.
</p>
<a class="anchor" id="XREFsurfacecdatamapping"></a></dd>
<dt><a id="index-surface-cdatamapping"></a><span><code class="code">cdatamapping</code>: <code class="code">"direct"</code> | {<code class="code">"scaled"</code>}<a class="copiable-link" href="#index-surface-cdatamapping"> ¶</a></span></dt>
<dd><p>Sets the method for mapping data from the <a class="ref" href="#XREFsurfacecdata"><code class="code">"cdata"</code> property<!-- /@w --></a> to the current colormap. <code class="code">"Direct"</code> mapping selects the color using the <code class="code">"cdata"</code> value as an index to the current colormap. <code class="code">"Scale"</code> mapping scales the <code class="code">"cdata"</code> values to the range specified in the <a class="ref" href="Axes-Properties.html#XREFaxesclim"><code class="code">"clim"</code> axes property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFsurfacecdatasource"></a></dd>
<dt><a id="index-surface-cdatasource"></a><span><code class="code">cdatasource</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-surface-cdatasource"> ¶</a></span></dt>
<dd><p>The name of a workspace variable that contains data that will be used for the <a class="ref" href="#XREFsurfacecdata"><code class="code">"cdata"</code> property<!-- /@w --></a>. Data is transferred into <code class="code">"cdata"</code> using the <a class="ref" href="Data-Sources-in-Object-Groups.html#XREFrefreshdata">refreshdata function<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryCoordinateData"></a><h4 class="subsubheading" id="Coordinate-Data-3"><span>Coordinate Data<a class="copiable-link" href="#Coordinate-Data-3"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfacexdata"></a></dd>
<dt><a id="index-surface-xdata"></a><span><code class="code">xdata</code>: matrix, def. <code class="code">[1 2 3]</code><a class="copiable-link" href="#index-surface-xdata"> ¶</a></span></dt>
<dd><p>Data for the x-coordinate.
</p>
<a class="anchor" id="XREFsurfacexdatasource"></a></dd>
<dt><a id="index-surface-xdatasource"></a><span><code class="code">xdatasource</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-surface-xdatasource"> ¶</a></span></dt>
<dd><p>The name of a workspace variable that contains data that will be used for the <a class="ref" href="#XREFsurfacexdata"><code class="code">"xdata"</code> property<!-- /@w --></a>. Data is transferred into <code class="code">"xdata"</code> using the <a class="ref" href="Data-Sources-in-Object-Groups.html#XREFrefreshdata">refreshdata function<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFsurfaceydata"></a></dd>
<dt><a id="index-surface-ydata"></a><span><code class="code">ydata</code>: matrix, def. <code class="code">[1; 2; 3]</code><a class="copiable-link" href="#index-surface-ydata"> ¶</a></span></dt>
<dd><p>Data for the y-coordinate.
</p>
<a class="anchor" id="XREFsurfaceydatasource"></a></dd>
<dt><a id="index-surface-ydatasource"></a><span><code class="code">ydatasource</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-surface-ydatasource"> ¶</a></span></dt>
<dd><p>The name of a workspace variable that contains data that will be used for the <a class="ref" href="#XREFsurfaceydata"><code class="code">"ydata"</code> property<!-- /@w --></a>. Data is transferred into <code class="code">"ydata"</code> using the <a class="ref" href="Data-Sources-in-Object-Groups.html#XREFrefreshdata">refreshdata function<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFsurfacezdata"></a></dd>
<dt><a id="index-surface-zdata"></a><span><code class="code">zdata</code>: matrix, def. 3-by-3 double<a class="copiable-link" href="#index-surface-zdata"> ¶</a></span></dt>
<dd><p>Data for the z-coordinate.
</p>
<a class="anchor" id="XREFsurfacezdatasource"></a></dd>
<dt><a id="index-surface-zdatasource"></a><span><code class="code">zdatasource</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-surface-zdatasource"> ¶</a></span></dt>
<dd><p>The name of a workspace variable that contains data that will be used for the <a class="ref" href="#XREFsurfacezdata"><code class="code">"zdata"</code> property<!-- /@w --></a>. Data is transferred into <code class="code">"zdata"</code> using the <a class="ref" href="Data-Sources-in-Object-Groups.html#XREFrefreshdata">refreshdata function<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryCreation_002fDeletion"></a><h4 class="subsubheading" id="Creation_002fDeletion-7"><span>Creation/Deletion<a class="copiable-link" href="#Creation_002fDeletion-7"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfacebeingdeleted"></a></dd>
<dt><a id="index-surface-beingdeleted"></a><span><code class="code">beingdeleted</code>: {<code class="code">"off"</code>} | <code class="code">"on"</code><a class="copiable-link" href="#index-surface-beingdeleted"> ¶</a></span></dt>
<dd><p>Property indicating that a function has initiated deletion of the object. <code class="code">beingdeleted</code> is set to true until the object no longer exists.
</p>
<a class="anchor" id="XREFsurfacecreatefcn"></a></dd>
<dt><a id="index-surface-createfcn"></a><span><code class="code">createfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-surface-createfcn"> ¶</a></span></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 class="code">set (groot, "defaultsurfacecreatefcn", 'disp ("surface created!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFsurfacedeletefcn"></a></dd>
<dt><a id="index-surface-deletefcn"></a><span><code class="code">deletefcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-surface-deletefcn"> ¶</a></span></dt>
<dd><p>Callback function executed immediately before surface is deleted.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryDisplay"></a><h4 class="subsubheading" id="Display-7"><span>Display<a class="copiable-link" href="#Display-7"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfaceclipping"></a></dd>
<dt><a id="index-surface-clipping"></a><span><code class="code">clipping</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-surface-clipping"> ¶</a></span></dt>
<dd><p>If <code class="code">clipping</code> is <code class="code">"on"</code>, the surface is clipped in its parent axes limits.
</p>
<a class="anchor" id="XREFsurfacevisible"></a></dd>
<dt><a id="index-surface-visible"></a><span><code class="code">visible</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-surface-visible"> ¶</a></span></dt>
<dd><p>If <code class="code">visible</code> is <code class="code">"off"</code>, the surface is not rendered on screen.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryFacesAppearance"></a><h4 class="subsubheading" id="Faces-Appearance"><span>Faces Appearance<a class="copiable-link" href="#Faces-Appearance"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfacefacealpha"></a></dd>
<dt><a id="index-surface-facealpha"></a><span><code class="code">facealpha</code>: scalar | <code class="code">"flat"</code> | <code class="code">"interp"</code> | <code class="code">"texturemap"</code>, def. <code class="code">1</code><a class="copiable-link" href="#index-surface-facealpha"> ¶</a></span></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 class="code">"flat"</code>, <code class="code">"interp"</code> or <code class="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 class="anchor" id="XREFsurfacefacecolor"></a></dd>
<dt><a id="index-surface-facecolor"></a><span><code class="code">facecolor</code>: colorspec | <code class="code">"none"</code> | {<code class="code">"flat"</code>} | <code class="code">"interp"</code><a class="copiable-link" href="#index-surface-facecolor"> ¶</a></span></dt>
<dd><p>Color of the faces of the surface object, specified as either a valid color specification or one of <code class="code">"none"</code>, <code class="code">"flat"</code>, or <code class="code">"interp"</code>. <code class="code">"flat"</code> and <code class="code">"interp"</code> will set either a single color for each face or a color interpolated across the face’s vertices using the color value data stored in <a class="ref" href="#XREFsurfacecdata"><code class="code">"cdata"</code></a>. See <a class="xref" href="Colors.html">colorspec</a>.
</p>
<a class="anchor" id="XREFsurfacefacelighting"></a></dd>
<dt><a id="index-surface-facelighting"></a><span><code class="code">facelighting</code>: {<code class="code">"flat"</code>} | <code class="code">"gouraud"</code> | <code class="code">"none"</code> | <code class="code">"phong"</code><a class="copiable-link" href="#index-surface-facelighting"> ¶</a></span></dt>
<dd><p>When set to a value other than <code class="code">"none"</code>, the faces of the object are drawn with light and shadow effects. Supported values are <code class="code">"none"</code> (no lighting effects), <code class="code">"flat"</code> (faceted look), and <code class="code">"gouraud"</code> (linear interpolation of the lighting effects between the vertices). <code class="code">"phong"</code> is deprecated and has the same effect as <code class="code">"gouraud"</code>.
</p>
<a class="anchor" id="XREFsurfacefacenormals"></a></dd>
<dt><a id="index-surface-facenormals"></a><span><code class="code">facenormals</code>: def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-surface-facenormals"> ¶</a></span></dt>
<dd><p>Face normals are used for lighting the edges or faces if the <code class="code">edgelighting</code> or <code class="code">facelighting</code> properties are set to <code class="code">"flat"</code>. Setting <code class="code">facenormals</code> also forces the <code class="code">facenormalsmode</code> property to be set to <code class="code">"manual"</code>.
</p>
<a class="anchor" id="XREFsurfacefacenormalsmode"></a></dd>
<dt><a id="index-surface-facenormalsmode"></a><span><code class="code">facenormalsmode</code>: {<code class="code">"auto"</code>} | <code class="code">"manual"</code><a class="copiable-link" href="#index-surface-facenormalsmode"> ¶</a></span></dt>
<dd><p>If this property is set to <code class="code">"auto"</code>, <code class="code">facenormals</code> are automatically calculated if the <code class="code">edgelighting</code> or <code class="code">facelighting</code> property are set to <code class="code">"flat"</code> and at least one <code class="code">light</code> object is present and visible in the same axes.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryLegendOptions"></a><h4 class="subsubheading" id="Legend-Options-3"><span>Legend Options<a class="copiable-link" href="#Legend-Options-3"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfacedisplayname"></a></dd>
<dt><a id="index-surface-displayname"></a><span><code class="code">displayname</code>: def. <code class="code">""</code><a class="copiable-link" href="#index-surface-displayname"> ¶</a></span></dt>
<dd><p>Text for the legend entry corresponding to this surface.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryLighting"></a><h4 class="subsubheading" id="Lighting-1"><span>Lighting<a class="copiable-link" href="#Lighting-1"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfaceambientstrength"></a></dd>
<dt><a id="index-surface-ambientstrength"></a><span><code class="code">ambientstrength</code>: scalar, def. <code class="code">0.3000</code><a class="copiable-link" href="#index-surface-ambientstrength"> ¶</a></span></dt>
<dd><p>Strength of the ambient light. Value between 0.0 and 1.0.
</p>
<a class="anchor" id="XREFsurfacebackfacelighting"></a></dd>
<dt><a id="index-surface-backfacelighting"></a><span><code class="code">backfacelighting</code>: <code class="code">"lit"</code> | {<code class="code">"reverselit"</code>} | <code class="code">"unlit"</code><a class="copiable-link" href="#index-surface-backfacelighting"> ¶</a></span></dt>
<dd><p><code class="code">"lit"</code>: The normals are used as is for lighting. <code class="code">"reverselit"</code>: The normals are always oriented towards the point of view. <code class="code">"unlit"</code>: Faces with normals pointing away from the point of view are unlit.
</p>
<a class="anchor" id="XREFsurfacediffusestrength"></a></dd>
<dt><a id="index-surface-diffusestrength"></a><span><code class="code">diffusestrength</code>: scalar, def. <code class="code">0.6000</code><a class="copiable-link" href="#index-surface-diffusestrength"> ¶</a></span></dt>
<dd><p>Strength of the diffuse reflection. Value between 0.0 (no diffuse reflection) and 1.0 (full diffuse reflection).
</p>
<a class="anchor" id="XREFsurfacespecularcolorreflectance"></a></dd>
<dt><a id="index-surface-specularcolorreflectance"></a><span><code class="code">specularcolorreflectance</code>: scalar, def. <code class="code">1</code><a class="copiable-link" href="#index-surface-specularcolorreflectance"> ¶</a></span></dt>
<dd><p>Reflectance for specular color. Value between 0.0 (color of underlying face) and 1.0 (color of light source).
</p>
<a class="anchor" id="XREFsurfacespecularexponent"></a></dd>
<dt><a id="index-surface-specularexponent"></a><span><code class="code">specularexponent</code>: scalar, def. <code class="code">10</code><a class="copiable-link" href="#index-surface-specularexponent"> ¶</a></span></dt>
<dd><p>Exponent for the specular reflection. The lower the value, the more the reflection is spread out.
</p>
<a class="anchor" id="XREFsurfacespecularstrength"></a></dd>
<dt><a id="index-surface-specularstrength"></a><span><code class="code">specularstrength</code>: scalar, def. <code class="code">0.9000</code><a class="copiable-link" href="#index-surface-specularstrength"> ¶</a></span></dt>
<dd><p>Strength of the specular reflection. Value between 0.0 (no specular reflection) and 1.0 (full specular reflection).
</p>
<a class="anchor" id="XREFsurfacevertexnormals"></a></dd>
<dt><a id="index-surface-vertexnormals"></a><span><code class="code">vertexnormals</code>: def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-surface-vertexnormals"> ¶</a></span></dt>
<dd><p>Vertex normals are used for lighting the edges or faces if the <code class="code">edgelighting</code> or <code class="code">facelighting</code> properties are set to <code class="code">"gouraud"</code>. Setting <code class="code">vertexnormals</code> also forces the <code class="code">vertexnormalsmode</code> property to be set to <code class="code">"manual"</code>.
</p>
<a class="anchor" id="XREFsurfacevertexnormalsmode"></a></dd>
<dt><a id="index-surface-vertexnormalsmode"></a><span><code class="code">vertexnormalsmode</code>: {<code class="code">"auto"</code>} | <code class="code">"manual"</code><a class="copiable-link" href="#index-surface-vertexnormalsmode"> ¶</a></span></dt>
<dd><p>If this property is set to <code class="code">"auto"</code>, <code class="code">vertexnormals</code> are automatically calculated if the <code class="code">edgelighting</code> or <code class="code">facelighting</code> property are set to <code class="code">"gouraud"</code> and at least one <code class="code">light</code> object is present and visible in the same axes.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryMarkerAppearance"></a><h4 class="subsubheading" id="Marker-Appearance-3"><span>Marker Appearance<a class="copiable-link" href="#Marker-Appearance-3"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfacemarker"></a></dd>
<dt><a id="index-surface-marker"></a><span><code class="code">marker</code>: <code class="code">"*"</code> | <code class="code">"+"</code> | <code class="code">"."</code> | <code class="code">"<"</code> | <code class="code">">"</code> | <code class="code">"^"</code> | <code class="code">"_"</code> | <code class="code">"d"</code> | <code class="code">"diamond"</code> | <code class="code">"h"</code> | <code class="code">"hexagram"</code> | {<code class="code">"none"</code>} | <code class="code">"o"</code> | <code class="code">"p"</code> | <code class="code">"pentagram"</code> | <code class="code">"s"</code> | <code class="code">"square"</code> | <code class="code">"v"</code> | <code class="code">"x"</code> | <code class="code">"|"</code><a class="copiable-link" href="#index-surface-marker"> ¶</a></span></dt>
<dd><p>See <a class="xref" href="Marker-Styles.html">Marker Styles</a>.
</p>
<a class="anchor" id="XREFsurfacemarkeredgecolor"></a></dd>
<dt><a id="index-surface-markeredgecolor"></a><span><code class="code">markeredgecolor</code>: {<code class="code">"auto"</code>} | <code class="code">"flat"</code> | <code class="code">"none"</code><a class="copiable-link" href="#index-surface-markeredgecolor"> ¶</a></span></dt>
<dd><p>See <a class="xref" href="Line-Properties.html#XREFlinemarkeredgecolor">line markeredgecolor property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFsurfacemarkerfacecolor"></a></dd>
<dt><a id="index-surface-markerfacecolor"></a><span><code class="code">markerfacecolor</code>: <code class="code">"auto"</code> | <code class="code">"flat"</code> | {<code class="code">"none"</code>}<a class="copiable-link" href="#index-surface-markerfacecolor"> ¶</a></span></dt>
<dd><p>See <a class="xref" href="Line-Properties.html#XREFlinemarkerfacecolor">line markerfacecolor property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFsurfacemarkersize"></a></dd>
<dt><a id="index-surface-markersize"></a><span><code class="code">markersize</code>: scalar, def. <code class="code">6</code><a class="copiable-link" href="#index-surface-markersize"> ¶</a></span></dt>
<dd><p>See <a class="xref" href="Line-Properties.html#XREFlinemarkersize">line markersize property<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryMouseInteraction"></a><h4 class="subsubheading" id="Mouse-Interaction-8"><span>Mouse Interaction<a class="copiable-link" href="#Mouse-Interaction-8"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfacebuttondownfcn"></a></dd>
<dt><a id="index-surface-buttondownfcn"></a><span><code class="code">buttondownfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-surface-buttondownfcn"> ¶</a></span></dt>
<dd><p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFsurfacecontextmenu"></a></dd>
<dt><a id="index-surface-contextmenu"></a><span><code class="code">contextmenu</code>: graphics handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-surface-contextmenu"> ¶</a></span></dt>
<dd><p>Graphics handle of the uicontextmenu object that is currently associated to this surface object.
</p>
<a class="anchor" id="XREFsurfacehittest"></a></dd>
<dt><a id="index-surface-hittest"></a><span><code class="code">hittest</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-surface-hittest"> ¶</a></span></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 class="code">"buttondownfcn"</code>, showing the uicontextmenu, and eventually becoming the root <code class="code">"currentobject"</code>. This property is only relevant when the object can accept mouse clicks which is determined by the <code class="code">"pickableparts"</code> property. See <a class="xref" href="#XREFsurfacepickableparts">pickableparts property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFsurfacepickableparts"></a></dd>
<dt><a id="index-surface-pickableparts"></a><span><code class="code">pickableparts</code>: <code class="code">"all"</code> | <code class="code">"none"</code> | {<code class="code">"visible"</code>}<a class="copiable-link" href="#index-surface-pickableparts"> ¶</a></span></dt>
<dd><p>Specify whether surface will accept mouse clicks. By default, <code class="code">pickableparts</code> is <code class="code">"visible"</code> and only visible parts of the surface or its children may react to mouse clicks. When <code class="code">pickableparts</code> is <code class="code">"all"</code> both visible and invisible parts (or children) may react to mouse clicks. When <code class="code">pickableparts</code> is <code class="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 class="code">"hittest"</code> property will determine how they are processed. See <a class="xref" href="#XREFsurfacehittest">hittest property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFsurfaceselected"></a></dd>
<dt><a id="index-surface-selected"></a><span><code class="code">selected</code>: {<code class="code">"off"</code>} | <code class="code">"on"</code><a class="copiable-link" href="#index-surface-selected"> ¶</a></span></dt>
<dd><p>Property indicates whether this surface is selected.
</p>
<a class="anchor" id="XREFsurfaceselectionhighlight"></a></dd>
<dt><a id="index-surface-selectionhighlight"></a><span><code class="code">selectionhighlight</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-surface-selectionhighlight"> ¶</a></span></dt>
<dd><p>If <code class="code">selectionhighlight</code> is <code class="code">"on"</code>, then the surface’s selection state is visually highlighted.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryObjectIdentification"></a><h4 class="subsubheading" id="Object-Identification-9"><span>Object Identification<a class="copiable-link" href="#Object-Identification-9"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfacetag"></a></dd>
<dt><a id="index-surface-tag"></a><span><code class="code">tag</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-surface-tag"> ¶</a></span></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<a class="anchor" id="XREFsurfacetype"></a></dd>
<dt><a id="index-surface-type"></a><span><code class="code">type</code> (read-only): string<a class="copiable-link" href="#index-surface-type"> ¶</a></span></dt>
<dd><p>Class name of the graphics object. <code class="code">type</code> is always <code class="code">"surface"</code>.
</p>
<a class="anchor" id="XREFsurfaceuserdata"></a></dd>
<dt><a id="index-surface-userdata"></a><span><code class="code">userdata</code>: Any Octave data, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-surface-userdata"> ¶</a></span></dt>
<dd><p>User-defined data to associate with the graphics object.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryOutlineAppearance"></a><h4 class="subsubheading" id="Outline-Appearance-1"><span>Outline Appearance<a class="copiable-link" href="#Outline-Appearance-1"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfaceedgealpha"></a></dd>
<dt><a id="index-surface-edgealpha"></a><span><code class="code">edgealpha</code>: scalar, def. <code class="code">1</code><a class="copiable-link" href="#index-surface-edgealpha"> ¶</a></span></dt>
<dd><p>Transparency is not yet implemented for surface objects. <code class="code">edgealpha</code> is unused.
</p>
<a class="anchor" id="XREFsurfaceedgecolor"></a></dd>
<dt><a id="index-surface-edgecolor"></a><span><code class="code">edgecolor</code>: colorspec | <code class="code">"none"</code> | <code class="code">"flat"</code> | <code class="code">"interp"</code>, def. <code class="code">[0 0 0]</code><a class="copiable-link" href="#index-surface-edgecolor"> ¶</a></span></dt>
<dd><p>Color of the edges of the surface object, specified as either a valid color specification or one of <code class="code">"none"</code>, <code class="code">"flat"</code>, or <code class="code">"interp"</code>. <code class="code">"flat"</code> and <code class="code">"interp"</code> will set either a single color for each edge or a color interpolated between two adjacent vertices using the color value data stored in <a class="ref" href="#XREFsurfacecdata"><code class="code">"cdata"</code></a>. See <a class="xref" href="Colors.html">colorspec</a>.
</p>
<a class="anchor" id="XREFsurfaceedgelighting"></a></dd>
<dt><a id="index-surface-edgelighting"></a><span><code class="code">edgelighting</code>: <code class="code">"flat"</code> | <code class="code">"gouraud"</code> | {<code class="code">"none"</code>} | <code class="code">"phong"</code><a class="copiable-link" href="#index-surface-edgelighting"> ¶</a></span></dt>
<dd><p>When set to a value other than <code class="code">"none"</code>, the edges of the object are drawn with light and shadow effects. Supported values are <code class="code">"none"</code> (no lighting effects), <code class="code">"flat"</code> (faceted look), and <code class="code">"gouraud"</code> (linear interpolation of the lighting effects between the vertices). <code class="code">"phong"</code> is deprecated and has the same effect as <code class="code">"gouraud"</code>.
</p>
<a class="anchor" id="XREFsurfacelinestyle"></a></dd>
<dt><a id="index-surface-linestyle"></a><span><code class="code">linestyle</code>: {<code class="code">"-"</code>} | <code class="code">"--"</code> | <code class="code">"-."</code> | <code class="code">":"</code> | <code class="code">"none"</code><a class="copiable-link" href="#index-surface-linestyle"> ¶</a></span></dt>
<dd><p>See <a class="xref" href="Line-Styles.html">Line Styles</a>.
</p>
<a class="anchor" id="XREFsurfacelinewidth"></a></dd>
<dt><a id="index-surface-linewidth"></a><span><code class="code">linewidth</code>: scalar, def. <code class="code">0.5000</code><a class="copiable-link" href="#index-surface-linewidth"> ¶</a></span></dt>
<dd><p>See <a class="xref" href="Line-Properties.html#XREFlinelinewidth">line linewidth property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFsurfacemeshstyle"></a></dd>
<dt><a id="index-surface-meshstyle"></a><span><code class="code">meshstyle</code>: {<code class="code">"both"</code>} | <code class="code">"column"</code> | <code class="code">"row"</code><a class="copiable-link" href="#index-surface-meshstyle"> ¶</a></span></dt>
<dd><p>Specifies whether to display the edges associated with the surface data’s rows, columns, or both.
</p>
</dd>
</dl>
<a class="anchor" id="XREFsurfacecategoryParent_002fChildren"></a><h4 class="subsubheading" id="Parent_002fChildren-8"><span>Parent/Children<a class="copiable-link" href="#Parent_002fChildren-8"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFsurfacechildren"></a></dd>
<dt><a id="index-surface-children"></a><span><code class="code">children</code> (read-only): vector of graphics handles, def. <code class="code">[](0x1)</code><a class="copiable-link" href="#index-surface-children"> ¶</a></span></dt>
<dd><p>Child objects for Surfaces is not yet implemented for surface objects. <code class="code">children</code> is unused.
</p>
<a class="anchor" id="XREFsurfacehandlevisibility"></a></dd>
<dt><a id="index-surface-handlevisibility"></a><span><code class="code">handlevisibility</code>: <code class="code">"callback"</code> | <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-surface-handlevisibility"> ¶</a></span></dt>
<dd><p>If <code class="code">handlevisibility</code> is <code class="code">"off"</code>, the surface’s handle is not visible in its parent’s <code class="code">"children"</code> property.
</p>
<a class="anchor" id="XREFsurfaceparent"></a></dd>
<dt><a id="index-surface-parent"></a><span><code class="code">parent</code>: graphics handle<a class="copiable-link" href="#index-surface-parent"> ¶</a></span></dt>
<dd><p>Handle of the parent graphics object.
</p>
</dd>
</dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Light-Properties.html">Light Properties</a>, Previous: <a href="Scatter-Properties.html">Scatter Properties</a>, Up: <a href="Graphics-Object-Properties.html">Graphics Object Properties</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
