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
|
<!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>Light Properties (GNU Octave (version 6.2.0))</title>
<meta name="description" content="Light Properties (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Light 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="Uimenu-Properties.html" rel="next" title="Uimenu Properties">
<link href="Surface-Properties.html" rel="prev" title="Surface 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="Light-Properties"></span><div class="header">
<p>
Next: <a href="Uimenu-Properties.html" accesskey="n" rel="next">Uimenu Properties</a>, Previous: <a href="Surface-Properties.html" accesskey="p" rel="prev">Surface 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="Light-Properties-1"></span><h4 class="subsubsection">15.3.3.10 Light Properties</h4>
<span id="index--Light-PropertiesLight-Properties"></span>
<p>Properties of <code>light</code> objects (see <a href="Graphics-Objects.html#XREFlight">light</a>):
</p>
<dl compact="compact">
<dd>
<span id="XREFlightbeingdeleted"></span><span id="index-light-beingdeleted"></span>
</dd>
<dt><code>beingdeleted</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<span id="XREFlightbusyaction"></span><span id="index-light-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="XREFlightbuttondownfcn"></span><span id="index-light-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="XREFlightchildren"></span><span id="index-light-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="XREFlightclipping"></span><span id="index-light-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 light is clipped in its parent axes limits.
</p>
<span id="XREFlightcolor"></span><span id="index-light-color"></span>
</dd>
<dt><code>color</code>: colorspec, def. <code>[1 1 1]</code></dt>
<dd><p>Color of the light source. See <a href="Colors.html">colorspec</a>.
</p>
<span id="XREFlightcreatefcn"></span><span id="index-light-createfcn"></span>
</dd>
<dt><code>createfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>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!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFlightdeletefcn"></span><span id="index-light-deletefcn"></span>
</dd>
<dt><code>deletefcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately before light 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="XREFlighthandlevisibility"></span><span id="index-light-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 light’s handle is not visible in its parent’s "children" property.
</p>
<span id="XREFlighthittest"></span><span id="index-light-hittest"></span>
</dd>
<dt><code>hittest</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>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 <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="#XREFlightpickableparts">pickableparts property<!-- /@w --></a>.
</p>
<span id="XREFlightinterruptible"></span><span id="index-light-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="XREFlightparent"></span><span id="index-light-parent"></span>
</dd>
<dt><code>parent</code>: graphics handle</dt>
<dd><p>Handle of the parent graphics object.
</p>
<span id="XREFlightpickableparts"></span><span id="index-light-pickableparts"></span>
</dd>
<dt><code>pickableparts</code>: <code>"all"</code> | <code>"none"</code> | {<code>"visible"</code>}</dt>
<dd><p>Specify whether light will accept mouse clicks. By default, <code>pickableparts</code> is <code>"visible"</code> and only visible parts of the light 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="#XREFlighthittest">hittest property<!-- /@w --></a>.
</p>
<span id="XREFlightposition"></span><span id="index-light-position"></span>
</dd>
<dt><code>position</code>: def. <code>[1 0 1]</code></dt>
<dd><p>Position of the light source.
</p>
<span id="XREFlightselected"></span><span id="index-light-selected"></span>
</dd>
<dt><code>selected</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<span id="XREFlightselectionhighlight"></span><span id="index-light-selectionhighlight"></span>
</dd>
<dt><code>selectionhighlight</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<span id="XREFlightstyle"></span><span id="index-light-style"></span>
</dd>
<dt><code>style</code>: {<code>"infinite"</code>} | <code>"local"</code></dt>
<dd><p>This string defines whether the light emanates from a light source at infinite distance (<code>"infinite"</code>) or from a local point source (<code>"local"</code>).
</p>
<span id="XREFlighttag"></span><span id="index-light-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="XREFlighttype"></span><span id="index-light-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>"light"</code>
</p>
<span id="XREFlightuicontextmenu"></span><span id="index-light-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 light object.
</p>
<span id="XREFlightuserdata"></span><span id="index-light-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="XREFlightvisible"></span><span id="index-light-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 light is not rendered on screen.
</p>
</dd>
</dl>
<hr>
<div class="header">
<p>
Next: <a href="Uimenu-Properties.html" accesskey="n" rel="next">Uimenu Properties</a>, Previous: <a href="Surface-Properties.html" accesskey="p" rel="prev">Surface 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>
|
