File: Introduction-to-Graphics-Structures.html

package info (click to toggle)
octave 7.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 130,464 kB
  • sloc: cpp: 332,823; ansic: 71,320; fortran: 20,963; objc: 8,562; sh: 8,115; yacc: 4,882; lex: 4,438; perl: 1,554; java: 1,366; awk: 1,257; makefile: 652; xml: 173
file content (180 lines) | stat: -rw-r--r-- 9,184 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Introduction to Graphics Structures (GNU Octave (version 7.3.0))</title>

<meta name="description" content="Introduction to Graphics Structures (GNU Octave (version 7.3.0))">
<meta name="keywords" content="Introduction to Graphics Structures (GNU Octave (version 7.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">

<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-Data-Structures.html" rel="up" title="Graphics Data Structures">
<link href="Graphics-Objects.html" rel="next" title="Graphics Objects">
<style type="text/css">
<!--
a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em}
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {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}
span:hover a.copiable-anchor {visibility: visible}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<div class="subsection" id="Introduction-to-Graphics-Structures">
<div class="header">
<p>
Next: <a href="Graphics-Objects.html" accesskey="n" rel="next">Graphics Objects</a>, Up: <a href="Graphics-Data-Structures.html" accesskey="u" rel="up">Graphics Data Structures</a> &nbsp; [<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="Introduction-to-Graphics-Structures-1"></span><h4 class="subsection">15.3.1 Introduction to Graphics Structures</h4>
<span id="index-introduction-to-graphics-structures"></span>
<span id="XREFgraphics-structures"></span>
<p>The graphics functions use pointers, which are of class graphics_handle, in
order to address the data structures which control visual display.  A
graphics handle may point to any one of a number of different base object
types.  These objects are the graphics data structures themselves.  The
primitive graphic object types are: <code>figure</code>, <code>axes</code>, <code>line</code>,
<code>text</code>, <code>patch</code>, <code>scatter</code>, <code>surface</code>, <code>text</code>,
<code>image</code>, and <code>light</code>.
</p>
<p>Each of these objects has a function by the same name, and each of these
functions returns a graphics handle pointing to an object of the corresponding
type.
</p>
<p>In addition, there are several functions which operate on properties of the
graphics objects and which also return handles.  This includes but is not
limited to the following functions: The functions <code>plot</code> and <code>plot3</code>
return a handle pointing to an object of type <code>line</code>.  The function
<code>subplot</code> returns a handle pointing to an object of type <code>axes</code>.
The functions <code>fill</code>, <code>fill3</code>, <code>trimesh</code>, and <code>trisurf</code>
return a handle pointing to an object of type patch.  The function
<code>scatter3</code> returns a handle to an object of type scatter.  The functions
<code>slice</code>, <code>surf</code>, <code>surfl</code>, <code>mesh</code>, <code>meshz</code>,
<code>pcolor</code>, and <code>waterfall</code> each return a handle of type surface.  The
function <code>camlight</code> returns a handle to an object of type light.  The
functions <code>area</code>, <code>bar</code>, <code>barh</code>, <code>contour</code>,
<code>contourf</code>, <code>contour3</code>, <code>surfc</code>, <code>meshc</code>, <code>errorbar</code>,
<code>quiver</code>, <code>quiver3</code>, <code>stair</code>, <code>stem</code>, <code>stem3</code> each
return a handle to a complex data structure as documented in
<a href="Data-Sources-in-Object-Groups.html#XREFdatasources">Data Sources</a>.
</p>
<p>The graphics objects are arranged in a hierarchy:
</p>
<p>1. The root object is returned by <code>groot</code> (historically, equivalent to
the handle 0).  In other words, <code>get (groot)</code> returns the properties of
the root object.
</p>
<p>2. Below the root are <code>figure</code> objects.
</p>
<p>3. Below the <code>figure</code> objects are <code>axes</code> or <code>hggroup</code> objects.
</p>
<p>4. Below the <code>axes</code> or <code>hggroup</code> objects are <code>line</code>,
<code>text</code>, <code>patch</code>, <code>scatter</code>, <code>surface</code>, <code>image</code>, and
<code>light</code> objects.
</p>
<p>It is possible to walk this hierarchical tree by querying the <code>&quot;parent&quot;</code>
and <code>&quot;children&quot;</code> properties of the graphics objects.
</p>
<p>Graphics handles may be distinguished from function handles
(see <a href="Function-Handles.html">Function Handles</a>) by means of the function <code>ishghandle</code>.
<code>ishghandle</code> returns true if its argument is a handle of a graphics
object.  In addition, a figure or axes object may be tested using
<code>isfigure</code> or <code>isaxes</code> respectively.  To test for a specific type of
graphics handle, such as a patch or line object, use <code>isgraphics</code>.  The
more specific test functions return true only if the argument is both a
graphics handle and of the correct type (figure, axes, specified object type).
</p>
<p>The <code>get</code> and <code>set</code> commands are used to obtain and set the values of
properties of graphics objects.  In addition, the <code>get</code> command may be
used to obtain property names.
</p>
<p>For example, the property <code>&quot;type&quot;</code> of the graphics object pointed to by
the graphics handle h may be displayed by:
</p>
<div class="example">
<pre class="example">get (h, &quot;type&quot;)
</pre></div>

<p>The properties and their current values may be obtained in the form of a
structure using <code>s = get (h)</code>, where <code>h</code> is the handle of a graphics
object.  If only the names of the properties and the allowed values (for radio
properties only) are wanted, one may use <code>set (h)</code>.
</p>
<p>Thus, for example:
</p>
<div class="example">
<pre class="example">h = figure ();
get (h, &quot;type&quot;)
&rArr; ans = figure
set (h)
&rArr;
        alphamap:
        beingdeleted:  [ {off} | on ]
        busyaction:  [ cancel | {queue} ]
        buttondownfcn:
        clipping:  [ off | {on} ]
        closerequestfcn:
        color:
        colormap:
        createfcn:
        currentaxes:
        deletefcn:
        dockcontrols:  [ {off} | on ]
        filename:
        graphicssmoothing:  [ off | {on} ]
        handlevisibility:  [ callback | off | {on} ]
        ...
</pre></div>

<p>The uses of <code>get</code> and <code>set</code> are further explained in
<a href="Graphics-Objects.html#XREFget">get</a>, <a href="Graphics-Objects.html#XREFset">set</a>.
</p>
<span id="XREFisprop"></span><dl class="def">
<dt id="index-isprop"><span class="category">: </span><span><em><var>res</var> =</em> <strong>isprop</strong> <em>(<var>obj</var>, &quot;<var>prop</var>&quot;)</em><a href='#index-isprop' class='copiable-anchor'> &para;</a></span></dt>
<dd><p>Return true if <var>prop</var> is a property of the object <var>obj</var>.
</p>
<p><var>obj</var> may also be an array of objects in which case <var>res</var> will be a
logical array indicating whether each handle has the property <var>prop</var>.
</p>
<p>For plotting, <var>obj</var> is a handle to a graphics object.  Otherwise,
<var>obj</var> should be an instance of a class.  <code>isprop</code> reports whether
the class defines a property, but <code>Access</code> permissions or visibility
restrictions (<code>Hidden = true</code>) may prevent use by the programmer.
</p>
<p><strong>See also:</strong> <a href="Graphics-Objects.html#XREFget">get</a>, <a href="Graphics-Objects.html#XREFset">set</a>, <a href="Properties.html#XREFproperties">properties</a>, <a href="Creating-a-Class.html#XREFismethod">ismethod</a>, <a href="Creating-a-Class.html#XREFisobject">isobject</a>.
</p></dd></dl>


</div>
<hr>
<div class="header">
<p>
Next: <a href="Graphics-Objects.html">Graphics Objects</a>, Up: <a href="Graphics-Data-Structures.html">Graphics Data Structures</a> &nbsp; [<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>