<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: vtkParametricBoy Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vtkParametricBoy Class Reference</h1><!-- doxytag: class="vtkParametricBoy" --><!-- doxytag: inherits="vtkParametricFunction" --><code>#include <<a class="el" href="a03886.html">vtkParametricBoy.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkParametricBoy:</div>
<div class="dynsection">
<p><center><img src="a12720.png" border="0" usemap="#a12721" alt="Inheritance graph"></center>
<map name="a12721">
<area shape="rect" href="a01167.html" title="abstract interface for parametric functions" alt="" coords="6,155,166,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="46,80,126,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="31,5,140,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkParametricBoy:</div>
<div class="dynsection">
<p><center><img src="a12722.png" border="0" usemap="#a12723" alt="Collaboration graph"></center>
<map name="a12723">
<area shape="rect" href="a01167.html" title="abstract interface for parametric functions" alt="" coords="47,174,207,200"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="87,96,167,123"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="5,6,115,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="139,6,248,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a12724.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Generate Boy's surface.
<p>
<a class="el" href="a01160.html" title="Generate Boy's surface.">vtkParametricBoy</a> generates Boy's surface. This is a Model of the projective plane without singularities. It was found by Werner Boy on assignment from David Hilbert.<p>
For further information about this surface, please consult the technical description "Parametric surfaces" in <a href="http://www.vtk.org/documents.php">http://www.vtk.org/documents.php</a> in the "VTK Technical Documents" section in the VTk.org web pages.<p>
<dl class="user" compact><dt><b>Thanks:</b></dt><dd>Andrew Maclean <a href="mailto:a.maclean@cas.edu.au">a.maclean@cas.edu.au</a> for creating and contributing the class.</dd></dl>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_12.html#c2_vtk_t_vtkParametricBoy">vtkParametricBoy (Tests)</a> </dd></dl>
<p>Definition at line <a class="el" href="a03886.html#l00040">40</a> of file <a class="el" href="a03886.html">vtkParametricBoy.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a01167.html">vtkParametricFunction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#8c14768809490ec0761052d044b10d77">Superclass</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#41da967713591147f0151c520e48475b">GetClassName</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#7be6b03a4e9c6c0f0de60cf91ebb38ef">IsA</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#a9459c3e53974c8902daf62103a7ed66">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#665b3b7812b8fb003249fb3f218a3b16">GetDimension</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#1a1eb537696c98214c6f38ef71010628">Evaluate</a> (double uvw[3], double Pt[3], double Duvw[9])</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#1dc9716491d255805462f54f2a475ede">EvaluateScalar</a> (double uvw[3], double Pt[3], double Duvw[9])</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#092ed91482115c7439121e30b5df29c4">SetZScale</a> (double)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#f439f5f3400b29f133ab439283dbd29e">GetZScale</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#2fb5f1d296f49dd309d7f9557216afbb">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01160.html">vtkParametricBoy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#20b7c978b497f577c903de8708b359a4">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01160.html">vtkParametricBoy</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#4e8fd8971b38dbd6fefe4856ada3a7a2">New</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#af7af0633a1b02619d3584df2a725f7f">vtkParametricBoy</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#ba2d3fbacdd169bf8277678368c8293d">~vtkParametricBoy</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a01160.html#ffd586eb1f1aefa3a818236b8632b172">ZScale</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="8c14768809490ec0761052d044b10d77"></a><!-- doxytag: member="vtkParametricBoy::Superclass" ref="8c14768809490ec0761052d044b10d77" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a01167.html">vtkParametricFunction</a> <a class="el" href="a01167.html">vtkParametricBoy::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01167.html#d7fca5ab1b9a89bf42a5250f37723ccc">vtkParametricFunction</a>.</p>
<p>Definition at line <a class="el" href="a03886.html#l00044">44</a> of file <a class="el" href="a03886.html">vtkParametricBoy.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="af7af0633a1b02619d3584df2a725f7f"></a><!-- doxytag: member="vtkParametricBoy::vtkParametricBoy" ref="af7af0633a1b02619d3584df2a725f7f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkParametricBoy::vtkParametricBoy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ba2d3fbacdd169bf8277678368c8293d"></a><!-- doxytag: member="vtkParametricBoy::~vtkParametricBoy" ref="ba2d3fbacdd169bf8277678368c8293d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkParametricBoy::~vtkParametricBoy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="41da967713591147f0151c520e48475b"></a><!-- doxytag: member="vtkParametricBoy::GetClassName" ref="41da967713591147f0151c520e48475b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkParametricBoy::GetClassName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01167.html#2e2ec66b0449ae8aa8fe951b719e0b5d">vtkParametricFunction</a>.</p>
</div>
</div><p>
<a class="anchor" name="2fb5f1d296f49dd309d7f9557216afbb"></a><!-- doxytag: member="vtkParametricBoy::IsTypeOf" ref="2fb5f1d296f49dd309d7f9557216afbb" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkParametricBoy::IsTypeOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
<p>Reimplemented from <a class="el" href="a01167.html#34ffcb5ba42bc0507abaecc4981b999b">vtkParametricFunction</a>.</p>
</div>
</div><p>
<a class="anchor" name="7be6b03a4e9c6c0f0de60cf91ebb38ef"></a><!-- doxytag: member="vtkParametricBoy::IsA" ref="7be6b03a4e9c6c0f0de60cf91ebb38ef" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkParametricBoy::IsA </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
<p>Reimplemented from <a class="el" href="a01167.html#d36b92de64d02926faad0ed48448f401">vtkParametricFunction</a>.</p>
</div>
</div><p>
<a class="anchor" name="20b7c978b497f577c903de8708b359a4"></a><!-- doxytag: member="vtkParametricBoy::SafeDownCast" ref="20b7c978b497f577c903de8708b359a4" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01160.html">vtkParametricBoy</a>* vtkParametricBoy::SafeDownCast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a01167.html#ee93e763930b887d9cbb325fb5fff997">vtkParametricFunction</a>.</p>
</div>
</div><p>
<a class="anchor" name="a9459c3e53974c8902daf62103a7ed66"></a><!-- doxytag: member="vtkParametricBoy::PrintSelf" ref="a9459c3e53974c8902daf62103a7ed66" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkParametricBoy::PrintSelf </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a> </td>
<td class="paramname"> <em>indent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes.
<p>Reimplemented from <a class="el" href="a01167.html#df5f1a91e154220007690f2a4c1e3969">vtkParametricFunction</a>.</p>
</div>
</div><p>
<a class="anchor" name="4e8fd8971b38dbd6fefe4856ada3a7a2"></a><!-- doxytag: member="vtkParametricBoy::New" ref="4e8fd8971b38dbd6fefe4856ada3a7a2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01160.html">vtkParametricBoy</a>* vtkParametricBoy::New </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct Boy's surface with the following parameters: MinimumU = 0, MaximumU = Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 1, TwistU = 1, TwistV = 1; ClockwiseOrdering = 1, DerivativesAvailable = 1, ZScale = 0.125.
<p>Reimplemented from <a class="el" href="a01084.html#4d5b227267c076d6f9e38483370b6612">vtkObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="665b3b7812b8fb003249fb3f218a3b16"></a><!-- doxytag: member="vtkParametricBoy::GetDimension" ref="665b3b7812b8fb003249fb3f218a3b16" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkParametricBoy::GetDimension </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the parametric dimension of the class.
<p>Implements <a class="el" href="a01167.html#093975fadf60dc8ce3ea0baac1b2ca34">vtkParametricFunction</a>.</p>
<p>Definition at line <a class="el" href="a03886.html#l00054">54</a> of file <a class="el" href="a03886.html">vtkParametricBoy.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="092ed91482115c7439121e30b5df29c4"></a><!-- doxytag: member="vtkParametricBoy::SetZScale" ref="092ed91482115c7439121e30b5df29c4" args="(double)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkParametricBoy::SetZScale </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/Get the scale factor for the z-coordinate. Default = 1/8, giving a nice shape.
</div>
</div><p>
<a class="anchor" name="f439f5f3400b29f133ab439283dbd29e"></a><!-- doxytag: member="vtkParametricBoy::GetZScale" ref="f439f5f3400b29f133ab439283dbd29e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double vtkParametricBoy::GetZScale </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/Get the scale factor for the z-coordinate. Default = 1/8, giving a nice shape.
</div>
</div><p>
<a class="anchor" name="1a1eb537696c98214c6f38ef71010628"></a><!-- doxytag: member="vtkParametricBoy::Evaluate" ref="1a1eb537696c98214c6f38ef71010628" args="(double uvw[3], double Pt[3], double Duvw[9])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkParametricBoy::Evaluate </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>uvw</em>[3], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>Pt</em>[3], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>Duvw</em>[9]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Boy's surface. This function performs the mapping <img class="formulaInl" alt="$f(u,v) \rightarrow (x,y,x)$" src="form_2.png">, returning it as Pt. It also returns the partial derivatives Du and Dv. <img class="formulaInl" alt="$Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv)$" src="form_3.png"> . Then the normal is <img class="formulaInl" alt="$N = Du X Dv$" src="form_4.png"> .
<p>Implements <a class="el" href="a01167.html#5d13e377b1cff56856b60d10bb66be34">vtkParametricFunction</a>.</p>
</div>
</div><p>
<a class="anchor" name="1dc9716491d255805462f54f2a475ede"></a><!-- doxytag: member="vtkParametricBoy::EvaluateScalar" ref="1dc9716491d255805462f54f2a475ede" args="(double uvw[3], double Pt[3], double Duvw[9])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double vtkParametricBoy::EvaluateScalar </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>uvw</em>[3], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>Pt</em>[3], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>Duvw</em>[9]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Calculate a user defined scalar using one or all of uvw, Pt, Duvw. uvw are the parameters with Pt being the the cartesian point, Duvw are the derivatives of this point with respect to u, v and w. Pt, Duvw are obtained from <a class="el" href="a01160.html#1a1eb537696c98214c6f38ef71010628">Evaluate()</a>. This function is only called if the ScalarMode has the value <a class="el" href="a01168.html#61adb5555eafb12c84e744578920dd15a8a26a8f6dceeeb0697e50c0bec0d06e">vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED</a> If the user does not need to calculate a scalar, then the instantiated function should return zero.
<p>Implements <a class="el" href="a01167.html#bb043638834315b6f18eb049ab8fdb9e">vtkParametricFunction</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="ffd586eb1f1aefa3a818236b8632b172"></a><!-- doxytag: member="vtkParametricBoy::ZScale" ref="ffd586eb1f1aefa3a818236b8632b172" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="a01160.html#ffd586eb1f1aefa3a818236b8632b172">vtkParametricBoy::ZScale</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a03886.html#l00085">85</a> of file <a class="el" href="a03886.html">vtkParametricBoy.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Common/<a class="el" href="a03886.html">vtkParametricBoy.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:22:27 2009 for VTK by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
1163
