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
|
@c DO NOT EDIT! Generated automatically by genpropdoc.m.
@c Copyright (C) 2014-2025 The Octave Project Developers
@c
@c See the file COPYRIGHT.md in the top-level directory of this
@c distribution or <https://octave.org/copyright/>.
@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
@c the Free Software Foundation, either version 3 of the License, or
@c (at your option) any later version.
@c
@c Octave is distributed in the hope that it will be useful, but
@c WITHOUT ANY WARRANTY; without even the implied warranty of
@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
@c GNU General Public License 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 <https://www.gnu.org/licenses/>.
Properties of @code{light} objects (@pxref{XREFlight,,light}):
@subsubheading Categories:
@ref{XREFlightcategoryCallbackExecution, , @w{Callback Execution}}@: | @ref{XREFlightcategoryCreation/Deletion, , @w{Creation/Deletion}}@: | @ref{XREFlightcategoryDisplay, , @w{Display}}@: | @ref{XREFlightcategoryLighting, , @w{Lighting}}@: | @ref{XREFlightcategoryMouseInteraction, , @w{Mouse Interaction}}@: | @ref{XREFlightcategoryObjectIdentification, , @w{Object Identification}}@: | @ref{XREFlightcategoryParent/Children, , @w{Parent/Children}}@:
@anchor{XREFlightcategoryCallbackExecution}
@subsubheading Callback Execution
@table @asis
@anchor{XREFlightbusyaction}
@prindex light busyaction
@item @code{busyaction}: @qcode{"cancel"} | @{@qcode{"queue"}@}
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} property set to @qcode{"off"}. The @code{busyaction} property of the interrupting callback object indicates whether the interrupting callback is queued (@qcode{"queue"} (default)) or discarded (@qcode{"cancel"}).
@xref{Callbacks, , @w{Callbacks section}}.
@anchor{XREFlightinterruptible}
@prindex light interruptible
@item @code{interruptible}: @qcode{"off"} | @{@qcode{"on"}@}
Specify whether this object's callback functions may be interrupted by other callbacks. By default @code{interruptible} is @qcode{"on"} and callbacks that make use of @code{drawnow}, @code{figure}, @code{waitfor}, @code{getframe} or @code{pause} functions are eventually interrupted.
@xref{Callbacks, , @w{Callbacks section}}.
@end table
@anchor{XREFlightcategoryCreation/Deletion}
@subsubheading Creation/Deletion
@table @asis
@anchor{XREFlightbeingdeleted}
@prindex light beingdeleted
@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"}
Property indicating that a function has initiated deletion of the object. @code{beingdeleted} is set to true until the object no longer exists.
@anchor{XREFlightcreatefcn}
@prindex light createfcn
@item @code{createfcn}: string | function handle, def. @code{[](0x0)}
Callback function executed immediately after light has been created. Function is set by using default property on root object, e.g., @code{set (groot, "defaultlightcreatefcn", 'disp ("light created!")')}.
For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}.
@anchor{XREFlightdeletefcn}
@prindex light deletefcn
@item @code{deletefcn}: string | function handle, def. @code{[](0x0)}
Callback function executed immediately before light is deleted.
For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}.
@end table
@anchor{XREFlightcategoryDisplay}
@subsubheading Display
@table @asis
@anchor{XREFlightclipping}
@prindex light clipping
@item @code{clipping}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{clipping} is @qcode{"on"}, the light is clipped in its parent axes limits.
@anchor{XREFlightvisible}
@prindex light visible
@item @code{visible}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{visible} is @qcode{"off"}, the light is not rendered on screen.
@end table
@anchor{XREFlightcategoryLighting}
@subsubheading Lighting
@table @asis
@anchor{XREFlightcolor}
@prindex light color
@item @code{color}: colorspec, def. @code{[1 1 1]}
Color of the light source. @xref{Colors, ,colorspec}.
@anchor{XREFlightposition}
@prindex light position
@item @code{position}: def. @code{[1 0 1]}
Position of the light source.
@anchor{XREFlightstyle}
@prindex light style
@item @code{style}: @{@qcode{"infinite"}@} | @qcode{"local"}
This string defines whether the light emanates from a light source at infinite distance (@qcode{"infinite"}) or from a local point source (@qcode{"local"}).
@end table
@anchor{XREFlightcategoryMouseInteraction}
@subsubheading Mouse Interaction
@table @asis
@anchor{XREFlightbuttondownfcn}
@prindex light buttondownfcn
@item @code{buttondownfcn}: string | function handle, def. @code{[](0x0)}
For information on how to write graphics listener functions see @ref{Callbacks, , @w{Callbacks section}}.
@anchor{XREFlightcontextmenu}
@prindex light contextmenu
@item @code{contextmenu}: graphics handle, def. @code{[](0x0)}
Graphics handle of the uicontextmenu object that is currently associated to this light object.
@anchor{XREFlighthittest}
@prindex light hittest
@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@}
Specify whether light processes mouse events or passes them to ancestors of the object. When enabled, the object may respond to mouse clicks by evaluating the @qcode{"buttondownfcn"}, showing the uicontextmenu, and eventually becoming the root @qcode{"currentobject"}. This property is only relevant when the object can accept mouse clicks which is determined by the @qcode{"pickableparts"} property. @xref{XREFlightpickableparts, , @w{pickableparts property}}.
@anchor{XREFlightpickableparts}
@prindex light pickableparts
@item @code{pickableparts}: @qcode{"all"} | @qcode{"none"} | @{@qcode{"visible"}@}
Specify whether light will accept mouse clicks. By default, @code{pickableparts} is @qcode{"visible"} and only visible parts of the light or its children may react to mouse clicks. When @code{pickableparts} is @qcode{"all"} both visible and invisible parts (or children) may react to mouse clicks. When @code{pickableparts} is @qcode{"none"} 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 @qcode{"hittest"} property will determine how they are processed. @xref{XREFlighthittest, , @w{hittest property}}.
@anchor{XREFlightselected}
@prindex light selected
@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"}
Property indicates whether this light is selected.
@anchor{XREFlightselectionhighlight}
@prindex light selectionhighlight
@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{selectionhighlight} is @qcode{"on"}, then the light's selection state is visually highlighted.
@end table
@anchor{XREFlightcategoryObjectIdentification}
@subsubheading Object Identification
@table @asis
@anchor{XREFlighttag}
@prindex light tag
@item @code{tag}: string, def. @qcode{""}
A user-defined string to label the graphics object.
@anchor{XREFlighttype}
@prindex light type
@item @code{type} (read-only): string
Class name of the graphics object. @code{type} is always @qcode{"light"}.
@anchor{XREFlightuserdata}
@prindex light userdata
@item @code{userdata}: Any Octave data, def. @code{[](0x0)}
User-defined data to associate with the graphics object.
@end table
@anchor{XREFlightcategoryParent/Children}
@subsubheading Parent/Children
@table @asis
@anchor{XREFlightchildren}
@prindex light children
@item @code{children} (read-only): vector of graphics handles, def. @code{[](0x1)}
light objects have no child objects. @code{children} is unused.
@anchor{XREFlighthandlevisibility}
@prindex light handlevisibility
@item @code{handlevisibility}: @qcode{"callback"} | @qcode{"off"} | @{@qcode{"on"}@}
If @code{handlevisibility} is @qcode{"off"}, the light's handle is not visible in its parent's @qcode{"children"} property.
@anchor{XREFlightparent}
@prindex light parent
@item @code{parent}: graphics handle
Handle of the parent graphics object.
@end table
|
