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
|
<!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: vtkImplicitWindowFunction</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 Page</span></a></li>
<li class="current"><a href="pages.html"><span>Related 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('vtkfiltering_vtkimplicitwindowfunction.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">vtkImplicitWindowFunction </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Section: <a class="el" href="sec_vtkfiltering.html">Visualization Toolkit Filtering Classes</a> </p>
<h1><a class="anchor" id="Usage"></a>
Usage</h1>
<p>vtkImplicitWindowFunction is used to modify the output of another implicit function to lie within a specified "window", or function range. This can be used to add "thickness" to cutting or clipping functions.</p>
<p>This class works as follows. First, it evaluates the function value of the user-specified implicit function. Then, based on the window range specified, it maps the function value into the window values specified.</p>
<p>To create an instance of class vtkImplicitWindowFunction, simply invoke its constructor as follows </p>
<pre class="fragment"> obj = vtkImplicitWindowFunction
</pre> <h1><a class="anchor" id="Methods"></a>
Methods</h1>
<p>The class vtkImplicitWindowFunction 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 vtkImplicitWindowFunction class. </p>
<ul>
<li>
<code>string = obj.GetClassName ()</code> </li>
<li>
<code>int = obj.IsA (string name)</code> </li>
<li>
<code>vtkImplicitWindowFunction = obj.NewInstance ()</code> </li>
<li>
<code>vtkImplicitWindowFunction = obj.SafeDownCast (vtkObject o)</code> </li>
<li>
<code>double = obj.EvaluateFunction (double x[3])</code> </li>
<li>
<code>double = obj.EvaluateFunction (double x, double y, double z)</code> </li>
<li>
<code>obj.EvaluateGradient (double x[3], double n[3])</code> </li>
<li>
<code>obj.SetImplicitFunction (vtkImplicitFunction )</code> - Specify an implicit function to operate on. </li>
<li>
<code>vtkImplicitFunction = obj.GetImplicitFunction ()</code> - Specify an implicit function to operate on. </li>
<li>
<code>obj.SetWindowRange (double , double )</code> - Specify the range of function values which are considered to lie within the window. WindowRange[0] is assumed to be less than WindowRange[1]. </li>
<li>
<code>obj.SetWindowRange (double a[2])</code> - Specify the range of function values which are considered to lie within the window. WindowRange[0] is assumed to be less than WindowRange[1]. </li>
<li>
<code>double = obj. GetWindowRange ()</code> - Specify the range of function values which are considered to lie within the window. WindowRange[0] is assumed to be less than WindowRange[1]. </li>
<li>
<code>obj.SetWindowValues (double , double )</code> - Specify the range of output values that the window range is mapped into. This is effectively a scaling and shifting of the original function values. </li>
<li>
<code>obj.SetWindowValues (double a[2])</code> - Specify the range of output values that the window range is mapped into. This is effectively a scaling and shifting of the original function values. </li>
<li>
<code>double = obj. GetWindowValues ()</code> - Specify the range of output values that the window range is mapped into. This is effectively a scaling and shifting of the original function values. </li>
<li>
<code>long = obj.GetMTime ()</code> - Override modified time retrieval because of object dependencies. </li>
<li>
<code>obj.Register (vtkObjectBase o)</code> - Participate in garbage collection. </li>
<li>
<code>obj.UnRegister (vtkObjectBase o)</code> - Participate in garbage collection. </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_vtkfiltering.html">Visualization Toolkit Filtering Classes</a></li>
<li class="footer">Generated on Thu Jul 25 2013 17:18:30 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>
|