File: plot-surfaceproperties.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 (346 lines) | stat: -rw-r--r-- 10,074 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
342
343
344
345
346
@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{XREFsurface__modified__}
@cindex surface __modified__
@item @code{__modified__}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFsurfacealphadata}
@cindex surface alphadata
@item @code{alphadata}: scalar | matrix, def. @code{1}
Transparency is not yet implemented for surface objects.  @code{alphadata} is unused.


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


@anchor{XREFsurfaceambientstrength}
@cindex surface ambientstrength
@item @code{ambientstrength}: def. @code{0.30000}
Light is not yet implemented for surface objects.  @code{ambientstrength} is unused.


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


@anchor{XREFsurfacebeingdeleted}
@cindex surface beingdeleted
@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFsurfacebusyaction}
@cindex surface busyaction
@item @code{busyaction}: @qcode{"cancel"} | @{@qcode{"queue"}@}



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



@anchor{XREFsurfacecdata}
@cindex surface cdata
@item @code{cdata}: matrix, def. 3-by-3 double



@anchor{XREFsurfacecdatamapping}
@cindex surface cdatamapping
@item @code{cdatamapping}: @qcode{"direct"} | @{@qcode{"scaled"}@}



@anchor{XREFsurfacecdatasource}
@cindex surface cdatasource
@item @code{cdatasource}: def. @qcode{""}



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


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


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


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


@anchor{XREFsurfacediffusestrength}
@cindex surface diffusestrength
@item @code{diffusestrength}: def. @code{0.60000}
Light is not yet implemented for surface objects.  @code{diffusestrength} is unused.


@anchor{XREFsurfacedisplayname}
@cindex surface displayname
@item @code{displayname}: def. @qcode{""}
Text for the legend entry corresponding to this surface.


@anchor{XREFsurfaceedgealpha}
@cindex surface edgealpha
@item @code{edgealpha}: scalar, def. @code{1}
Transparency is not yet implemented for surface objects.  @code{edgealpha} is unused.


@anchor{XREFsurfaceedgecolor}
@cindex surface edgecolor
@item @code{edgecolor}: def. @code{[0   0   0]}



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


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


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


@anchor{XREFsurfacefacecolor}
@cindex surface facecolor
@item @code{facecolor}: @{@qcode{"flat"}@} | @qcode{"interp"} | @qcode{"none"} | @qcode{"texturemap"}



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


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


@anchor{XREFsurfacehittest}
@cindex surface hittest
@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFsurfaceinterpreter}
@cindex surface interpreter
@item @code{interpreter}: @qcode{"latex"} | @qcode{"none"} | @{@qcode{"tex"}@}



@anchor{XREFsurfaceinterruptible}
@cindex surface interruptible
@item @code{interruptible}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFsurfacelinestyle}
@cindex surface linestyle
@item @code{linestyle}: @{@qcode{"-"}@} | @qcode{"--"} | @qcode{"-."} | @qcode{":"} | @qcode{"none"}
@xref{Line Styles}.


@anchor{XREFsurfacelinewidth}
@cindex surface linewidth
@item @code{linewidth}: def. @code{0.50000}
@xref{XREFlinelinewidth, , @w{line linewidth property}}.


@anchor{XREFsurfacemarker}
@cindex surface 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{Marker Styles}.


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


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


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


@anchor{XREFsurfacemeshstyle}
@cindex surface meshstyle
@item @code{meshstyle}: @{@qcode{"both"}@} | @qcode{"column"} | @qcode{"row"}



@anchor{XREFsurfacenormalmode}
@cindex surface normalmode
@item @code{normalmode}: @{@qcode{"auto"}@} | @qcode{"manual"}



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


@anchor{XREFsurfaceselected}
@cindex surface selected
@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFsurfaceselectionhighlight}
@cindex surface selectionhighlight
@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFsurfacespecularcolorreflectance}
@cindex surface specularcolorreflectance
@item @code{specularcolorreflectance}: def. @code{1}
Light is not yet implemented for surface objects.  @code{specularcolorreflectance} is unused.


@anchor{XREFsurfacespecularexponent}
@cindex surface specularexponent
@item @code{specularexponent}: def. @code{10}
Light is not yet implemented for surface objects.  @code{specularexponent} is unused.


@anchor{XREFsurfacespecularstrength}
@cindex surface specularstrength
@item @code{specularstrength}: def. @code{0.90000}
Light is not yet implemented for surface objects.  @code{specularstrength} is unused.


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


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


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


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


@anchor{XREFsurfacevertexnormals}
@cindex surface vertexnormals
@item @code{vertexnormals}: def. 3-by-3-by-3 double



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


@anchor{XREFsurfacexdata}
@cindex surface xdata
@item @code{xdata}: matrix, def. @code{[1   2   3]}



@anchor{XREFsurfacexdatasource}
@cindex surface xdatasource
@item @code{xdatasource}: def. @qcode{""}



@anchor{XREFsurfaceydata}
@cindex surface ydata
@item @code{ydata}: matrix, def. @code{[1;    2;    3]}



@anchor{XREFsurfaceydatasource}
@cindex surface ydatasource
@item @code{ydatasource}: def. @qcode{""}



@anchor{XREFsurfacezdata}
@cindex surface zdata
@item @code{zdata}: matrix, def. 3-by-3 double



@anchor{XREFsurfacezdatasource}
@cindex surface zdatasource
@item @code{zdatasource}: def. @qcode{""}


@end table