/usr/share/doc/octave/octave.html/Patch-Properties.html is in octave-doc 4.2.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Patch Properties (GNU Octave)</title>
<meta name="description" content="Patch Properties (GNU Octave)">
<meta name="keywords" content="Patch Properties (GNU Octave)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Graphics-Object-Properties.html#Graphics-Object-Properties" rel="up" title="Graphics Object Properties">
<link href="Surface-Properties.html#Surface-Properties" rel="next" title="Surface Properties">
<link href="Image-Properties.html#Image-Properties" rel="prev" title="Image Properties">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
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">
<a name="Patch-Properties"></a>
<div class="header">
<p>
Next: <a href="Surface-Properties.html#Surface-Properties" accesskey="n" rel="next">Surface Properties</a>, Previous: <a href="Image-Properties.html#Image-Properties" accesskey="p" rel="prev">Image Properties</a>, Up: <a href="Graphics-Object-Properties.html#Graphics-Object-Properties" 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#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Patch-Properties-1"></a>
<h4 class="subsubsection">15.3.3.7 Patch Properties</h4>
<a name="index-patch-properties"></a>
<p>The <code>patch</code> properties are:
</p>
<dl compact="compact">
<dd>
<a name="XREFpatch_005f_005fmodified_005f_005f"></a><a name="index-patch-_005f_005fmodified_005f_005f"></a>
</dd>
<dt><code>__modified__</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFpatchalphadatamapping"></a><a name="index-patch-alphadatamapping"></a>
</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>
<a name="XREFpatchambientstrength"></a><a name="index-patch-ambientstrength"></a>
</dd>
<dt><code>ambientstrength</code>: scalar, def. <code>0.30000</code></dt>
<dd><p>Strength of the ambient light. Value between 0.0 and 1.0
</p>
<a name="XREFpatchbackfacelighting"></a><a name="index-patch-backfacelighting"></a>
</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>
<a name="XREFpatchbeingdeleted"></a><a name="index-patch-beingdeleted"></a>
</dd>
<dt><code>beingdeleted</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<a name="XREFpatchbusyaction"></a><a name="index-patch-busyaction"></a>
</dd>
<dt><code>busyaction</code>: <code>"cancel"</code> | {<code>"queue"</code>}</dt>
<dd>
<a name="XREFpatchbuttondownfcn"></a><a name="index-patch-buttondownfcn"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFpatchcdata"></a><a name="index-patch-cdata"></a>
</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>
<a name="XREFpatchcdatamapping"></a><a name="index-patch-cdatamapping"></a>
</dd>
<dt><code>cdatamapping</code>: <code>"direct"</code> | {<code>"scaled"</code>}</dt>
<dd>
<a name="XREFpatchchildren"></a><a name="index-patch-children"></a>
</dd>
<dt><code>children</code> (read-only): vector of graphics handles, def. <code>[](0x1)</code></dt>
<dd><p><code>children</code> is unused.
</p>
<a name="XREFpatchclipping"></a><a name="index-patch-clipping"></a>
</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>
<a name="XREFpatchcreatefcn"></a><a name="index-patch-createfcn"></a>
</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 (0, "defaultpatchcreatefcn", 'disp ("patch created!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html#Callbacks">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFpatchdeletefcn"></a><a name="index-patch-deletefcn"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFpatchdiffusestrength"></a><a name="index-patch-diffusestrength"></a>
</dd>
<dt><code>diffusestrength</code>: scalar, def. <code>0.60000</code></dt>
<dd><p>Strength of the diffuse reflex. Value between 0.0 (no diffuse reflex) and 1.0 (full diffuse reflex).
</p>
<a name="XREFpatchdisplayname"></a><a name="index-patch-displayname"></a>
</dd>
<dt><code>displayname</code>: def. <code>""</code></dt>
<dd><p>Text of the legend entry corresponding to this patch.
</p>
<a name="XREFpatchedgealpha"></a><a name="index-patch-edgealpha"></a>
</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>
<a name="XREFpatchedgecolor"></a><a name="index-patch-edgecolor"></a>
</dd>
<dt><code>edgecolor</code>: def. <code>[0 0 0]</code></dt>
<dd>
<a name="XREFpatchedgelighting"></a><a name="index-patch-edgelighting"></a>
</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>
<a name="XREFpatchfacealpha"></a><a name="index-patch-facealpha"></a>
</dd>
<dt><code>facealpha</code>: scalar | matrix, def. <code>1</code></dt>
<dd><p>Transparency is not yet implemented for patch objects. <code>facealpha</code> is unused.
</p>
<a name="XREFpatchfacecolor"></a><a name="index-patch-facecolor"></a>
</dd>
<dt><code>facecolor</code>: {colorspec} | <code>"none"</code> | <code>"flat"</code> | <code>"interp"</code>, def. <code>[0 0 0]</code></dt>
<dd>
<a name="XREFpatchfacelighting"></a><a name="index-patch-facelighting"></a>
</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>
<a name="XREFpatchfacenormals"></a><a name="index-patch-facenormals"></a>
</dd>
<dt><code>facenormals</code>: def. <code>[](0x0)</code></dt>
<dd>
<a name="XREFpatchfacenormalsmode"></a><a name="index-patch-facenormalsmode"></a>
</dd>
<dt><code>facenormalsmode</code>: {<code>"auto"</code>} | <code>"manual"</code></dt>
<dd>
<a name="XREFpatchfaces"></a><a name="index-patch-faces"></a>
</dd>
<dt><code>faces</code>: def. <code>[1 2 3]</code></dt>
<dd>
<a name="XREFpatchfacevertexalphadata"></a><a name="index-patch-facevertexalphadata"></a>
</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>
<a name="XREFpatchfacevertexcdata"></a><a name="index-patch-facevertexcdata"></a>
</dd>
<dt><code>facevertexcdata</code>: def. <code>[](0x0)</code></dt>
<dd>
<a name="XREFpatchhandlevisibility"></a><a name="index-patch-handlevisibility"></a>
</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>
<a name="XREFpatchhittest"></a><a name="index-patch-hittest"></a>
</dd>
<dt><code>hittest</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFpatchinterpreter"></a><a name="index-patch-interpreter"></a>
</dd>
<dt><code>interpreter</code>: <code>"latex"</code> | <code>"none"</code> | {<code>"tex"</code>}</dt>
<dd><p><code>interpreter</code> is unused.
</p>
<a name="XREFpatchinterruptible"></a><a name="index-patch-interruptible"></a>
</dd>
<dt><code>interruptible</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFpatchlinestyle"></a><a name="index-patch-linestyle"></a>
</dd>
<dt><code>linestyle</code>: {<code>"-"</code>} | <code>"--"</code> | <code>"-."</code> | <code>":"</code> | <code>"none"</code></dt>
<dd>
<a name="XREFpatchlinewidth"></a><a name="index-patch-linewidth"></a>
</dd>
<dt><code>linewidth</code>: def. <code>0.50000</code></dt>
<dd>
<a name="XREFpatchmarker"></a><a name="index-patch-marker"></a>
</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>
<a name="XREFpatchmarkeredgecolor"></a><a name="index-patch-markeredgecolor"></a>
</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>
<a name="XREFpatchmarkerfacecolor"></a><a name="index-patch-markerfacecolor"></a>
</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>
<a name="XREFpatchmarkersize"></a><a name="index-patch-markersize"></a>
</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>
<a name="XREFpatchparent"></a><a name="index-patch-parent"></a>
</dd>
<dt><code>parent</code>: graphics handle</dt>
<dd><p>Handle of the parent graphics object.
</p>
<a name="XREFpatchselected"></a><a name="index-patch-selected"></a>
</dd>
<dt><code>selected</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<a name="XREFpatchselectionhighlight"></a><a name="index-patch-selectionhighlight"></a>
</dd>
<dt><code>selectionhighlight</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFpatchspecularcolorreflectance"></a><a name="index-patch-specularcolorreflectance"></a>
</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>
<a name="XREFpatchspecularexponent"></a><a name="index-patch-specularexponent"></a>
</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>
<a name="XREFpatchspecularstrength"></a><a name="index-patch-specularstrength"></a>
</dd>
<dt><code>specularstrength</code>: scalar, def. <code>0.90000</code></dt>
<dd><p>Strength of the specular reflex. Value between 0.0 (no specular reflex) and 1.0 (full specular reflex).
</p>
<a name="XREFpatchtag"></a><a name="index-patch-tag"></a>
</dd>
<dt><code>tag</code>: string, def. <code>""</code></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<a name="XREFpatchtype"></a><a name="index-patch-type"></a>
</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>
<a name="XREFpatchuicontextmenu"></a><a name="index-patch-uicontextmenu"></a>
</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>
<a name="XREFpatchuserdata"></a><a name="index-patch-userdata"></a>
</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>
<a name="XREFpatchvertexnormals"></a><a name="index-patch-vertexnormals"></a>
</dd>
<dt><code>vertexnormals</code>: def. <code>[](0x0)</code></dt>
<dd>
<a name="XREFpatchvertexnormalsmode"></a><a name="index-patch-vertexnormalsmode"></a>
</dd>
<dt><code>vertexnormalsmode</code>: {<code>"auto"</code>} | <code>"manual"</code></dt>
<dd>
<a name="XREFpatchvertices"></a><a name="index-patch-vertices"></a>
</dd>
<dt><code>vertices</code>: vector | matrix, def. 3-by-2 double</dt>
<dd>
<a name="XREFpatchvisible"></a><a name="index-patch-visible"></a>
</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>
<a name="XREFpatchxdata"></a><a name="index-patch-xdata"></a>
</dd>
<dt><code>xdata</code>: vector | matrix, def. <code>[0; 1; 0]</code></dt>
<dd>
<a name="XREFpatchydata"></a><a name="index-patch-ydata"></a>
</dd>
<dt><code>ydata</code>: vector | matrix, def. <code>[1; 1; 0]</code></dt>
<dd>
<a name="XREFpatchzdata"></a><a name="index-patch-zdata"></a>
</dd>
<dt><code>zdata</code>: vector | matrix, def. <code>[](0x0)</code></dt>
</dl>
<hr>
<div class="header">
<p>
Next: <a href="Surface-Properties.html#Surface-Properties" accesskey="n" rel="next">Surface Properties</a>, Previous: <a href="Image-Properties.html#Image-Properties" accesskey="p" rel="prev">Image Properties</a>, Up: <a href="Graphics-Object-Properties.html#Graphics-Object-Properties" 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#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|