File: vtkgraphics_vtkarrowsource.html

package info (click to toggle)
freemat 4.2%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 141,800 kB
  • ctags: 14,082
  • sloc: ansic: 126,788; cpp: 62,046; python: 2,080; perl: 1,255; sh: 1,146; yacc: 1,019; lex: 239; makefile: 100
file content (138 lines) | stat: -rw-r--r-- 7,886 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FreeMat: vtkArrowSource</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">FreeMat
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('vtkgraphics_vtkarrowsource.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">vtkArrowSource </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkgraphics.html">Visualization Toolkit Graphics Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkArrowSource was intended to be used as the source for a glyph. The shaft base is always at (0,0,0). The arrow tip is always at (1,0,0). If "Invert" is true, then the ends are flipped i.e. tip is at (0,0,0) while base is at (1, 0, 0). The resolution of the cone and shaft can be set and default to 6. The radius of the cone and shaft can be set and default to 0.03 and 0.1. The length of the tip can also be set, and defaults to 0.35.</p>
<p>To create an instance of class vtkArrowSource, simply invoke its constructor as follows </p>
<pre class="fragment">  obj = vtkArrowSource
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkArrowSource has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, <code>obj</code> is an instance of the vtkArrowSource class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code>  </li>
<li>
<code>int = obj.IsA (string name)</code>  </li>
<li>
<code>vtkArrowSource = obj.NewInstance ()</code>  </li>
<li>
<code>vtkArrowSource = obj.SafeDownCast (vtkObject o)</code>  </li>
<li>
<code>obj.SetTipLength (double )</code> - Set the length, and radius of the tip. They default to 0.35 and 0.1  </li>
<li>
<code>double = obj.GetTipLengthMinValue ()</code> - Set the length, and radius of the tip. They default to 0.35 and 0.1  </li>
<li>
<code>double = obj.GetTipLengthMaxValue ()</code> - Set the length, and radius of the tip. They default to 0.35 and 0.1  </li>
<li>
<code>double = obj.GetTipLength ()</code> - Set the length, and radius of the tip. They default to 0.35 and 0.1  </li>
<li>
<code>obj.SetTipRadius (double )</code> - Set the length, and radius of the tip. They default to 0.35 and 0.1  </li>
<li>
<code>double = obj.GetTipRadiusMinValue ()</code> - Set the length, and radius of the tip. They default to 0.35 and 0.1  </li>
<li>
<code>double = obj.GetTipRadiusMaxValue ()</code> - Set the length, and radius of the tip. They default to 0.35 and 0.1  </li>
<li>
<code>double = obj.GetTipRadius ()</code> - Set the length, and radius of the tip. They default to 0.35 and 0.1  </li>
<li>
<code>obj.SetTipResolution (int )</code> - Set the resolution of the tip. The tip behaves the same as a cone. Resoultion 1 gives a single triangle, 2 gives two crossed triangles.  </li>
<li>
<code>int = obj.GetTipResolutionMinValue ()</code> - Set the resolution of the tip. The tip behaves the same as a cone. Resoultion 1 gives a single triangle, 2 gives two crossed triangles.  </li>
<li>
<code>int = obj.GetTipResolutionMaxValue ()</code> - Set the resolution of the tip. The tip behaves the same as a cone. Resoultion 1 gives a single triangle, 2 gives two crossed triangles.  </li>
<li>
<code>int = obj.GetTipResolution ()</code> - Set the resolution of the tip. The tip behaves the same as a cone. Resoultion 1 gives a single triangle, 2 gives two crossed triangles.  </li>
<li>
<code>obj.SetShaftRadius (double )</code> - Set the radius of the shaft. Defaults to 0.03.  </li>
<li>
<code>double = obj.GetShaftRadiusMinValue ()</code> - Set the radius of the shaft. Defaults to 0.03.  </li>
<li>
<code>double = obj.GetShaftRadiusMaxValue ()</code> - Set the radius of the shaft. Defaults to 0.03.  </li>
<li>
<code>double = obj.GetShaftRadius ()</code> - Set the radius of the shaft. Defaults to 0.03.  </li>
<li>
<code>obj.SetShaftResolution (int )</code> - Set the resolution of the shaft. 2 gives a rectangle. I would like to extend the cone to produce a line, but this is not an option now.  </li>
<li>
<code>int = obj.GetShaftResolutionMinValue ()</code> - Set the resolution of the shaft. 2 gives a rectangle. I would like to extend the cone to produce a line, but this is not an option now.  </li>
<li>
<code>int = obj.GetShaftResolutionMaxValue ()</code> - Set the resolution of the shaft. 2 gives a rectangle. I would like to extend the cone to produce a line, but this is not an option now.  </li>
<li>
<code>int = obj.GetShaftResolution ()</code> - Set the resolution of the shaft. 2 gives a rectangle. I would like to extend the cone to produce a line, but this is not an option now.  </li>
<li>
<code>obj.InvertOn ()</code> - Inverts the arrow direction. When set to true, base is at (1, 0, 0) while the tip is at (0, 0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).  </li>
<li>
<code>obj.InvertOff ()</code> - Inverts the arrow direction. When set to true, base is at (1, 0, 0) while the tip is at (0, 0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).  </li>
<li>
<code>obj.SetInvert (bool )</code> - Inverts the arrow direction. When set to true, base is at (1, 0, 0) while the tip is at (0, 0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).  </li>
<li>
<code>bool = obj.GetInvert ()</code> - Inverts the arrow direction. When set to true, base is at (1, 0, 0) while the tip is at (0, 0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).  </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="index.html">FreeMat Documentation</a></li><li class="navelem"><a class="el" href="sec_vtkgraphics.html">Visualization Toolkit Graphics Classes</a></li>
    <li class="footer">Generated on Thu Jul 25 2013 17:18:31 for FreeMat by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
  </ul>
</div>
</body>
</html>