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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Patch Properties (GNU Octave (version 6.2.0))</title>
<meta name="description" content="Patch Properties (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Patch Properties (GNU Octave (version 6.2.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<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="Surface-Properties.html" rel="next" title="Surface Properties">
<link href="Image-Properties.html" rel="prev" title="Image Properties">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {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}
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">
<span id="Patch-Properties"></span><div class="header">
<p>
Next: <a href="Surface-Properties.html" accesskey="n" rel="next">Surface Properties</a>, Previous: <a href="Image-Properties.html" accesskey="p" rel="prev">Image 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>
<span id="Patch-Properties-1"></span><h4 class="subsubsection">15.3.3.8 Patch Properties</h4>
<span id="index--Patch-PropertiesPatch-Properties"></span>
<p>Properties of <code>patch</code> objects (see <a href="Graphics-Objects.html#XREFpatch">patch</a>):
</p>
<dl compact="compact">
<dd>
<span id="XREFpatchalphadatamapping"></span><span id="index-patch-alphadatamapping"></span>
</dd>
<dt><code>alphadatamapping</code>: <code>"direct"</code> | <code>"none"</code> | {<code>"scaled"</code>}</dt>
<dd><p>Transparency is not yet implemented for patch objects. <code>alphadatamapping</code> is unused.
</p>
<span id="XREFpatchambientstrength"></span><span id="index-patch-ambientstrength"></span>
</dd>
<dt><code>ambientstrength</code>: scalar, def. <code>0.3000</code></dt>
<dd><p>Strength of the ambient light. Value between 0.0 and 1.0
</p>
<span id="XREFpatchbackfacelighting"></span><span id="index-patch-backfacelighting"></span>
</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>
<span id="XREFpatchbeingdeleted"></span><span id="index-patch-beingdeleted"></span>
</dd>
<dt><code>beingdeleted</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<span id="XREFpatchbusyaction"></span><span id="index-patch-busyaction"></span>
</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 section<!-- /@w --></a>.
</p>
<span id="XREFpatchbuttondownfcn"></span><span id="index-patch-buttondownfcn"></span>
</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 section<!-- /@w --></a>.
</p>
<span id="XREFpatchcdata"></span><span id="index-patch-cdata"></span>
</dd>
<dt><code>cdata</code>: scalar | matrix, def. <code>[](0x0)</code></dt>
<dd><p>Data defining the patch object color.
Patch color can be defined for faces or for vertices.
</p>
<p>If <code>cdata</code> is a scalar index into the current colormap or a RGB triplet, it defines the color of all faces.
</p>
<p>If <code>cdata</code> is an N-by-1 vector of indices or an N-by-3 (RGB) matrix, it defines the color of each one of the N faces.
</p>
<p>If <code>cdata</code> is an N-by-M or an N-by-M-by-3 (RGB) matrix, it defines the color at each vertex.
</p>
<span id="XREFpatchcdatamapping"></span><span id="index-patch-cdatamapping"></span>
</dd>
<dt><code>cdatamapping</code>: <code>"direct"</code> | {<code>"scaled"</code>}</dt>
<dd>
<span id="XREFpatchchildren"></span><span id="index-patch-children"></span>
</dd>
<dt><code>children</code> (read-only): vector of graphics handles, def. <code>[](0x1)</code></dt>
<dd><p><code>children</code> is unused.
</p>
<span id="XREFpatchclipping"></span><span id="index-patch-clipping"></span>
</dd>
<dt><code>clipping</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>clipping</code> is <code>"on"</code>, the patch is clipped in its parent axes limits.
</p>
<span id="XREFpatchcreatefcn"></span><span id="index-patch-createfcn"></span>
</dd>
<dt><code>createfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately after patch has been created. Function is set by using default property on root object, e.g., <code>set (groot, "defaultpatchcreatefcn", 'disp ("patch created!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFpatchdeletefcn"></span><span id="index-patch-deletefcn"></span>
</dd>
<dt><code>deletefcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately before patch is deleted.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFpatchdiffusestrength"></span><span id="index-patch-diffusestrength"></span>
</dd>
<dt><code>diffusestrength</code>: scalar, def. <code>0.6000</code></dt>
<dd><p>Strength of the diffuse reflex. Value between 0.0 (no diffuse reflex) and 1.0 (full diffuse reflex).
</p>
<span id="XREFpatchdisplayname"></span><span id="index-patch-displayname"></span>
</dd>
<dt><code>displayname</code>: def. <code>""</code></dt>
<dd><p>Text of the legend entry corresponding to this patch.
</p>
<span id="XREFpatchedgealpha"></span><span id="index-patch-edgealpha"></span>
</dd>
<dt><code>edgealpha</code>: scalar | matrix, def. <code>1</code></dt>
<dd><p>Transparency is not yet implemented for patch objects. <code>edgealpha</code> is unused.
</p>
<span id="XREFpatchedgecolor"></span><span id="index-patch-edgecolor"></span>
</dd>
<dt><code>edgecolor</code>: def. <code>[0 0 0]</code></dt>
<dd>
<span id="XREFpatchedgelighting"></span><span id="index-patch-edgelighting"></span>
</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>
<span id="XREFpatchfacealpha"></span><span id="index-patch-facealpha"></span>
</dd>
<dt><code>facealpha</code>: scalar | <code>"flat"</code> | <code>"interp"</code>, def. <code>1</code></dt>
<dd><p>Transparency level of the faces of the patch 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> or <code>"interp"</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>
<span id="XREFpatchfacecolor"></span><span id="index-patch-facecolor"></span>
</dd>
<dt><code>facecolor</code>: {colorspec} | <code>"none"</code> | <code>"flat"</code> | <code>"interp"</code>, def. <code>[0 0 0]</code></dt>
<dd>
<span id="XREFpatchfacelighting"></span><span id="index-patch-facelighting"></span>
</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>
<span id="XREFpatchfacenormals"></span><span id="index-patch-facenormals"></span>
</dd>
<dt><code>facenormals</code>: def. <code>[](0x0)</code></dt>
<dd><p>Face normals are used for lighting the edges or faces if the <code>edgelighting</code> or <code>facelighting</code> properties are set to <code>"flat"</code>. Setting <code>facenormals</code> also forces the <code>facenormalsmode</code> property to be set to <code>"manual"</code>
</p>
<span id="XREFpatchfacenormalsmode"></span><span id="index-patch-facenormalsmode"></span>
</dd>
<dt><code>facenormalsmode</code>: {<code>"auto"</code>} | <code>"manual"</code></dt>
<dd><p>If this property is set to <code>"auto"</code>, <code>facenormals</code> are automatically calculated if the <code>edgelighting</code> or <code>facelighting</code> property are set to <code>"flat"</code> and at least one <code>light</code> object is present and visible in the same axes.
</p>
<span id="XREFpatchfaces"></span><span id="index-patch-faces"></span>
</dd>
<dt><code>faces</code>: vector | matrix, def. <code>[1 2 3]</code></dt>
<dd>
<span id="XREFpatchfacevertexalphadata"></span><span id="index-patch-facevertexalphadata"></span>
</dd>
<dt><code>facevertexalphadata</code>: scalar | matrix, def. <code>[](0x0)</code></dt>
<dd><p>Transparency is not yet implemented for patch objects. <code>facevertexalphadata</code> is unused.
</p>
<span id="XREFpatchfacevertexcdata"></span><span id="index-patch-facevertexcdata"></span>
</dd>
<dt><code>facevertexcdata</code>: def. <code>[](0x0)</code></dt>
<dd>
<span id="XREFpatchhandlevisibility"></span><span id="index-patch-handlevisibility"></span>
</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 patch’s handle is not visible in its parent’s "children" property.
</p>
<span id="XREFpatchhittest"></span><span id="index-patch-hittest"></span>
</dd>
<dt><code>hittest</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Specify whether patch 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="#XREFpatchpickableparts">pickableparts property<!-- /@w --></a>.
</p>
<span id="XREFpatchinterruptible"></span><span id="index-patch-interruptible"></span>
</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 section<!-- /@w --></a>.
</p>
<span id="XREFpatchlinestyle"></span><span id="index-patch-linestyle"></span>
</dd>
<dt><code>linestyle</code>: {<code>"-"</code>} | <code>"--"</code> | <code>"-."</code> | <code>":"</code> | <code>"none"</code></dt>
<dd>
<span id="XREFpatchlinewidth"></span><span id="index-patch-linewidth"></span>
</dd>
<dt><code>linewidth</code>: def. <code>0.5000</code></dt>
<dd>
<span id="XREFpatchmarker"></span><span id="index-patch-marker"></span>
</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="Line-Properties.html#XREFlinemarker">line marker property<!-- /@w --></a>.
</p>
<span id="XREFpatchmarkeredgecolor"></span><span id="index-patch-markeredgecolor"></span>
</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>
<span id="XREFpatchmarkerfacecolor"></span><span id="index-patch-markerfacecolor"></span>
</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>
<span id="XREFpatchmarkersize"></span><span id="index-patch-markersize"></span>
</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>
<span id="XREFpatchparent"></span><span id="index-patch-parent"></span>
</dd>
<dt><code>parent</code>: graphics handle</dt>
<dd><p>Handle of the parent graphics object.
</p>
<span id="XREFpatchpickableparts"></span><span id="index-patch-pickableparts"></span>
</dd>
<dt><code>pickableparts</code>: <code>"all"</code> | <code>"none"</code> | {<code>"visible"</code>}</dt>
<dd><p>Specify whether patch will accept mouse clicks. By default, <code>pickableparts</code> is <code>"visible"</code> and only visible parts of the patch 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="#XREFpatchhittest">hittest property<!-- /@w --></a>.
</p>
<span id="XREFpatchselected"></span><span id="index-patch-selected"></span>
</dd>
<dt><code>selected</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<span id="XREFpatchselectionhighlight"></span><span id="index-patch-selectionhighlight"></span>
</dd>
<dt><code>selectionhighlight</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<span id="XREFpatchspecularcolorreflectance"></span><span id="index-patch-specularcolorreflectance"></span>
</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>
<span id="XREFpatchspecularexponent"></span><span id="index-patch-specularexponent"></span>
</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>
<span id="XREFpatchspecularstrength"></span><span id="index-patch-specularstrength"></span>
</dd>
<dt><code>specularstrength</code>: scalar, def. <code>0.9000</code></dt>
<dd><p>Strength of the specular reflex. Value between 0.0 (no specular reflex) and 1.0 (full specular reflex).
</p>
<span id="XREFpatchtag"></span><span id="index-patch-tag"></span>
</dd>
<dt><code>tag</code>: string, def. <code>""</code></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<span id="XREFpatchtype"></span><span id="index-patch-type"></span>
</dd>
<dt><code>type</code> (read-only): string</dt>
<dd><p>Class name of the graphics object. <code>type</code> is always <code>"patch"</code>
</p>
<span id="XREFpatchuicontextmenu"></span><span id="index-patch-uicontextmenu"></span>
</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 patch object.
</p>
<span id="XREFpatchuserdata"></span><span id="index-patch-userdata"></span>
</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>
<span id="XREFpatchvertexnormals"></span><span id="index-patch-vertexnormals"></span>
</dd>
<dt><code>vertexnormals</code>: def. <code>[](0x0)</code></dt>
<dd><p>Vertex normals are used for lighting the edges or faces if the <code>edgelighting</code> or <code>facelighting</code> properties are set to <code>"gouraud"</code>. Setting <code>vertexnormals</code> also forces the <code>vertexnormalsmode</code> property to be set to <code>"manual"</code>
</p>
<span id="XREFpatchvertexnormalsmode"></span><span id="index-patch-vertexnormalsmode"></span>
</dd>
<dt><code>vertexnormalsmode</code>: {<code>"auto"</code>} | <code>"manual"</code></dt>
<dd><p>If this property is set to <code>"auto"</code>, <code>vertexnormals</code> are automatically calculated if the <code>edgelighting</code> or <code>facelighting</code> property are set to <code>"gouraud"</code> and at least one <code>light</code> object is present and visible in the same axes.
</p>
<span id="XREFpatchvertices"></span><span id="index-patch-vertices"></span>
</dd>
<dt><code>vertices</code>: vector | matrix, def. 3-by-2 double</dt>
<dd>
<span id="XREFpatchvisible"></span><span id="index-patch-visible"></span>
</dd>
<dt><code>visible</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>visible</code> is <code>"off"</code>, the patch is not rendered on screen.
</p>
<span id="XREFpatchxdata"></span><span id="index-patch-xdata"></span>
</dd>
<dt><code>xdata</code>: vector | matrix, def. <code>[0; 1; 0]</code></dt>
<dd>
<span id="XREFpatchydata"></span><span id="index-patch-ydata"></span>
</dd>
<dt><code>ydata</code>: vector | matrix, def. <code>[1; 1; 0]</code></dt>
<dd>
<span id="XREFpatchzdata"></span><span id="index-patch-zdata"></span>
</dd>
<dt><code>zdata</code>: vector | matrix, def. <code>[](0x0)</code></dt>
</dl>
<hr>
<div class="header">
<p>
Next: <a href="Surface-Properties.html" accesskey="n" rel="next">Surface Properties</a>, Previous: <a href="Image-Properties.html" accesskey="p" rel="prev">Image 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>
</body>
</html>
|
