File: plot-patchproperties.texi

package info (click to toggle)
octave 4.0.3-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 94,200 kB
  • ctags: 52,925
  • sloc: cpp: 316,850; ansic: 43,469; fortran: 23,670; sh: 13,805; yacc: 8,204; objc: 7,939; lex: 3,631; java: 2,127; makefile: 1,746; perl: 1,022; awk: 988
file content (341 lines) | stat: -rw-r--r-- 10,154 bytes parent folder | download | duplicates (2)
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
@c DO NOT EDIT!  Generated automatically by genpropdoc.m.

@c Copyright (C) 2014-2015 Pantxo Diribarne
@c
@c This file is part of Octave.
@c
@c Octave is free software; you can redistribute it and/or modify it
@c under the terms of the GNU General Public License as published by the
@c Free Software Foundation; either version 3 of the License, or (at
@c your option) any later version.
@c
@c Octave is distributed in the hope that it will be useful, but WITHOUT
@c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
@c FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
@c for more details.
@c
@c You should have received a copy of the GNU General Public License
@c along with Octave; see the file COPYING.  If not, see
@c <http://www.gnu.org/licenses/>.

@table @asis

@anchor{XREFpatch__modified__}
@cindex patch __modified__
@item @code{__modified__}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFpatchalphadatamapping}
@cindex patch alphadatamapping
@item @code{alphadatamapping}: @qcode{"direct"} | @qcode{"none"} | @{@qcode{"scaled"}@}
Transparency is not yet implemented for patch objects.  @code{alphadatamapping} is unused.


@anchor{XREFpatchambientstrength}
@cindex patch ambientstrength
@item @code{ambientstrength}: scalar, def. @code{0.30000}
Light is not yet implemented for patch objects.  @code{ambientstrength} is unused.


@anchor{XREFpatchbackfacelighting}
@cindex patch backfacelighting
@item @code{backfacelighting}: @qcode{"lit"} | @{@qcode{"reverselit"}@} | @qcode{"unlit"}
Light is not yet implemented for patch objects.  @code{backfacelighting} is unused.


@anchor{XREFpatchbeingdeleted}
@cindex patch beingdeleted
@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFpatchbusyaction}
@cindex patch busyaction
@item @code{busyaction}: @qcode{"cancel"} | @{@qcode{"queue"}@}



@anchor{XREFpatchbuttondownfcn}
@cindex patch buttondownfcn
@item @code{buttondownfcn}: string | function handle, def. @code{[](0x0)}



@anchor{XREFpatchcdata}
@cindex patch cdata
@item @code{cdata}: scalar | matrix, def. @code{[](0x0)}
Data defining the patch object color.
Patch color can be defined for faces or for vertices.

If @code{cdata} is a scalar index into the current colormap or a RGB triplet, it defines the color of all faces.

If @code{cdata} 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.

If @code{cdata} is an N-by-M or an N-by-M-by-3 (RGB) matrix, it defines the color at each vertex.


@anchor{XREFpatchcdatamapping}
@cindex patch cdatamapping
@item @code{cdatamapping}: @qcode{"direct"} | @{@qcode{"scaled"}@}



@anchor{XREFpatchchildren}
@cindex patch children
@item @code{children} (read-only): vector of graphics handles, def. @code{[](0x1)}
@code{children} is unused.


@anchor{XREFpatchclipping}
@cindex patch clipping
@item @code{clipping}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{clipping} is @qcode{"on"}, the patch is clipped in its parent axes limits.


@anchor{XREFpatchcreatefcn}
@cindex patch createfcn
@item @code{createfcn}: string | function handle, def. @code{[](0x0)}
Callback function executed immediately after patch has been created.  Function is set by using default property on root object, e.g., @code{set (0, "defaultpatchcreatefcn", 'disp ("patch created!")')}.


@anchor{XREFpatchdeletefcn}
@cindex patch deletefcn
@item @code{deletefcn}: string | function handle, def. @code{[](0x0)}
Callback function executed immediately before patch is deleted.


@anchor{XREFpatchdiffusestrength}
@cindex patch diffusestrength
@item @code{diffusestrength}: scalar, def. @code{0.60000}
Light is not yet implemented for patch objects.  @code{diffusestrength} is unused.


@anchor{XREFpatchdisplayname}
@cindex patch displayname
@item @code{displayname}: def. @qcode{""}
Text of the legend entry corresponding to this patch.


@anchor{XREFpatchedgealpha}
@cindex patch edgealpha
@item @code{edgealpha}: scalar | matrix, def. @code{1}
Transparency is not yet implemented for patch objects.  @code{edgealpha} is unused.


@anchor{XREFpatchedgecolor}
@cindex patch edgecolor
@item @code{edgecolor}: def. @code{[0   0   0]}



@anchor{XREFpatchedgelighting}
@cindex patch edgelighting
@item @code{edgelighting}: @qcode{"flat"} | @qcode{"gouraud"} | @{@qcode{"none"}@} | @qcode{"phong"}
Light is not yet implemented for patch objects.  @code{edgelighting} is unused.


@anchor{XREFpatcherasemode}
@cindex patch erasemode
@item @code{erasemode}: @qcode{"background"} | @qcode{"none"} | @{@qcode{"normal"}@} | @qcode{"xor"}
@code{erasemode} is unused.


@anchor{XREFpatchfacealpha}
@cindex patch facealpha
@item @code{facealpha}: scalar | matrix, def. @code{1}
Transparency is not yet implemented for patch objects.  @code{facealpha} is unused.


@anchor{XREFpatchfacecolor}
@cindex patch facecolor
@item @code{facecolor}: @{colorspec@} | @qcode{"none"} | @qcode{"flat"} | @qcode{"interp"}, def. @code{[0   0   0]}



@anchor{XREFpatchfacelighting}
@cindex patch facelighting
@item @code{facelighting}: @qcode{"flat"} | @qcode{"gouraud"} | @{@qcode{"none"}@} | @qcode{"phong"}
Light is not yet implemented for patch objects.  @code{facelighting} is unused.


@anchor{XREFpatchfaces}
@cindex patch faces
@item @code{faces}: def. @code{[1   2   3]}



@anchor{XREFpatchfacevertexalphadata}
@cindex patch facevertexalphadata
@item @code{facevertexalphadata}: scalar | matrix, def. @code{[](0x0)}
Transparency is not yet implemented for patch objects.  @code{facevertexalphadata} is unused.


@anchor{XREFpatchfacevertexcdata}
@cindex patch facevertexcdata
@item @code{facevertexcdata}: def. @code{[](0x0)}



@anchor{XREFpatchhandlevisibility}
@cindex patch handlevisibility
@item @code{handlevisibility}: @qcode{"callback"} | @qcode{"off"} | @{@qcode{"on"}@}
If @code{handlevisibility} is @qcode{"off"}, the patch's handle is not visible in its parent's "children" property.


@anchor{XREFpatchhittest}
@cindex patch hittest
@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFpatchinterpreter}
@cindex patch interpreter
@item @code{interpreter}: @qcode{"latex"} | @qcode{"none"} | @{@qcode{"tex"}@}
@code{interpreter} is unused.


@anchor{XREFpatchinterruptible}
@cindex patch interruptible
@item @code{interruptible}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFpatchlinestyle}
@cindex patch linestyle
@item @code{linestyle}: @{@qcode{"-"}@} | @qcode{"--"} | @qcode{"-."} | @qcode{":"} | @qcode{"none"}



@anchor{XREFpatchlinewidth}
@cindex patch linewidth
@item @code{linewidth}: def. @code{0.50000}



@anchor{XREFpatchmarker}
@cindex patch marker
@item @code{marker}: @qcode{"*"} | @qcode{"+"} | @qcode{"."} | @qcode{"<"} | @qcode{">"} | @qcode{"^"} | @qcode{"d"} | @qcode{"diamond"} | @qcode{"h"} | @qcode{"hexagram"} | @{@qcode{"none"}@} | @qcode{"o"} | @qcode{"p"} | @qcode{"pentagram"} | @qcode{"s"} | @qcode{"square"} | @qcode{"v"} | @qcode{"x"}
@xref{XREFlinemarker, , @w{line marker property}}.


@anchor{XREFpatchmarkeredgecolor}
@cindex patch markeredgecolor
@item @code{markeredgecolor}: @{@qcode{"auto"}@} | @qcode{"flat"} | @qcode{"none"}
@xref{XREFlinemarkeredgecolor, , @w{line markeredgecolor property}}.


@anchor{XREFpatchmarkerfacecolor}
@cindex patch markerfacecolor
@item @code{markerfacecolor}: @qcode{"auto"} | @qcode{"flat"} | @{@qcode{"none"}@}
@xref{XREFlinemarkerfacecolor, , @w{line markerfacecolor property}}.


@anchor{XREFpatchmarkersize}
@cindex patch markersize
@item @code{markersize}: scalar, def. @code{6}
@xref{XREFlinemarkersize, , @w{line markersize property}}.


@anchor{XREFpatchnormalmode}
@cindex patch normalmode
@item @code{normalmode}: @{@qcode{"auto"}@} | @qcode{"manual"}



@anchor{XREFpatchparent}
@cindex patch parent
@item @code{parent}: graphics handle
Handle of the parent graphics object.


@anchor{XREFpatchselected}
@cindex patch selected
@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFpatchselectionhighlight}
@cindex patch selectionhighlight
@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFpatchspecularcolorreflectance}
@cindex patch specularcolorreflectance
@item @code{specularcolorreflectance}: scalar, def. @code{1}
Light is not yet implemented for patch objects.  @code{specularcolorreflectance} is unused.


@anchor{XREFpatchspecularexponent}
@cindex patch specularexponent
@item @code{specularexponent}: scalar, def. @code{10}
Light is not yet implemented for patch objects.  @code{specularexponent} is unused.


@anchor{XREFpatchspecularstrength}
@cindex patch specularstrength
@item @code{specularstrength}: scalar, def. @code{0.90000}
Light is not yet implemented for patch objects.  @code{specularstrength} is unused.


@anchor{XREFpatchtag}
@cindex patch tag
@item @code{tag}: string, def. @qcode{""}
A user-defined string to label the graphics object.


@anchor{XREFpatchtype}
@cindex patch type
@item @code{type} (read-only): string
Class name of the graphics object.  @code{type} is always @qcode{"patch"}


@anchor{XREFpatchuicontextmenu}
@cindex patch uicontextmenu
@item @code{uicontextmenu}: graphics handle, def. @code{[](0x0)}
Graphics handle of the uicontextmenu object that is currently associated to this patch object.


@anchor{XREFpatchuserdata}
@cindex patch userdata
@item @code{userdata}: Any Octave data, def. @code{[](0x0)}
User-defined data to associate with the graphics object.


@anchor{XREFpatchvertexnormals}
@cindex patch vertexnormals
@item @code{vertexnormals}: def. @code{[](0x0)}



@anchor{XREFpatchvertices}
@cindex patch vertices
@item @code{vertices}: vector | matrix, def. 3-by-2 double



@anchor{XREFpatchvisible}
@cindex patch visible
@item @code{visible}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{visible} is @qcode{"off"}, the patch is not rendered on screen.


@anchor{XREFpatchxdata}
@cindex patch xdata
@item @code{xdata}: vector | matrix, def. @code{[0;    1;    0]}



@anchor{XREFpatchydata}
@cindex patch ydata
@item @code{ydata}: vector | matrix, def. @code{[1;    1;    0]}



@anchor{XREFpatchzdata}
@cindex patch zdata
@item @code{zdata}: vector | matrix, def. @code{[](0x0)}


@end table