Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkImplicitSelectionLoop Class Reference

implicit function for a selection loop. More...

#include <vtkImplicitSelectionLoop.h>

Inheritance diagram for vtkImplicitSelectionLoop:

Inheritance graph
[legend]
Collaboration diagram for vtkImplicitSelectionLoop:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
float EvaluateFunction (float x[3])
float EvaluateFunction (float x, float y, float z)
void EvaluateGradient (float x[3], float n[3])
virtual void SetLoop (vtkPoints *)
virtual vtkPointsGetLoop ()
virtual void SetAutomaticNormalGeneration (int)
virtual int GetAutomaticNormalGeneration ()
virtual void AutomaticNormalGenerationOn ()
virtual void AutomaticNormalGenerationOff ()
virtual void SetNormal (float, float, float)
virtual void SetNormal (float[3])
virtual float * GetNormal ()
virtual void GetNormal (float data[3])
unsigned long GetMTime ()

Static Public Methods

int IsTypeOf (const char *type)
vtkImplicitSelectionLoop * SafeDownCast (vtkObject *o)
vtkImplicitSelectionLoop * New ()

Protected Methods

 vtkImplicitSelectionLoop ()
 ~vtkImplicitSelectionLoop ()
 vtkImplicitSelectionLoop (const vtkImplicitSelectionLoop &)
void operator= (const vtkImplicitSelectionLoop &)

Protected Attributes

vtkPointsLoop
float Normal [3]
int AutomaticNormalGeneration

Detailed Description

implicit function for a selection loop.

Date:
2000/12/10 20:08:39
Revision:
1.14

vtkImplicitSelectionLoop computes the implicit function value and function gradient for a irregular, cylinder-like object whose cross section is defined by a set of points forming a loop. The loop need not be convex nor its points coplanar. However, the loop must be non-self-intersecting when projected onto the plane defined by the accumulated cross product around the loop (i.e., the axis of the loop). (Alternatively, you can specify the normal to use.)

The following procedure is used to compute the implicit function value for a point x. Each point of the loop is first projected onto the plane defined by the loop normal. This forms a polygon. Then, to evaluate the implicit function value, inside/outside tests are used to determine if x is inside the polygon, and the distance to the loop boundary is computed (negative values are inside the loop).

One example application of this implicit function class is to draw a loop on the surface of a mesh, and use the loop to clip or extract cells from within the loop. Remember, the selection loop is "infinite" in length, you can use a plane (in boolean combination) to cap the extent of the selection loop. Another trick is to use a connectivity filter to extract the closest region to a given point (i.e., one of the points used to define the selection loop).

See also:
vtkImplicitFunction vtkImplicitBoolean vtkExtractGeometry vtkClipPolyData vtkConnectivityFilter vtkPolyDataConnectivityFilter
Examples:
vtkImplicitSelectionLoop (examples)

Definition at line 83 of file vtkImplicitSelectionLoop.h.


Constructor & Destructor Documentation

vtkImplicitSelectionLoop::vtkImplicitSelectionLoop   [protected]
 

vtkImplicitSelectionLoop::~vtkImplicitSelectionLoop   [protected]
 

vtkImplicitSelectionLoop::vtkImplicitSelectionLoop const vtkImplicitSelectionLoop &    [inline, protected]
 

Definition at line 123 of file vtkImplicitSelectionLoop.h.


Member Function Documentation

virtual const char* vtkImplicitSelectionLoop::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImplicitFunction.

int vtkImplicitSelectionLoop::IsTypeOf const char *    type [static]
 

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImplicitFunction.

virtual int vtkImplicitSelectionLoop::IsA const char *    type [virtual]
 

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImplicitFunction.

vtkImplicitSelectionLoop* vtkImplicitSelectionLoop::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImplicitFunction.

void vtkImplicitSelectionLoop::PrintSelf ostream &    os,
vtkIndent    indent
[virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImplicitFunction.

vtkImplicitSelectionLoop* vtkImplicitSelectionLoop::New   [static]
 

Instantiate object with no initial loop.

Reimplemented from vtkObject.

float vtkImplicitSelectionLoop::EvaluateFunction float    x[3] [virtual]
 

Evaluate selection loop returning a signed distance.

Reimplemented from vtkImplicitFunction.

float vtkImplicitSelectionLoop::EvaluateFunction float    x,
float    y,
float    z
[inline]
 

Reimplemented from vtkImplicitFunction.

Definition at line 94 of file vtkImplicitSelectionLoop.h.

void vtkImplicitSelectionLoop::EvaluateGradient float    x[3],
float    n[3]
[virtual]
 

Evaluate selection loop returning the gradient.

Reimplemented from vtkImplicitFunction.

virtual void vtkImplicitSelectionLoop::SetLoop vtkPoints   [virtual]
 

Set/Get the array of point coordinates defining the loop. There must be at least three points used to define a loop.

virtual vtkPoints* vtkImplicitSelectionLoop::GetLoop   [virtual]
 

virtual void vtkImplicitSelectionLoop::SetAutomaticNormalGeneration int    [virtual]
 

Turn on/off automatic normal generation. By default, the normal is computed from the accumulated cross product of the edges. You can also specify the normal to use.

virtual int vtkImplicitSelectionLoop::GetAutomaticNormalGeneration   [virtual]
 

virtual void vtkImplicitSelectionLoop::AutomaticNormalGenerationOn   [virtual]
 

virtual void vtkImplicitSelectionLoop::AutomaticNormalGenerationOff   [virtual]
 

virtual void vtkImplicitSelectionLoop::SetNormal float   ,
float   ,
float   
[virtual]
 

Set / get the normal used to determine what is inside and what is outside.

virtual void vtkImplicitSelectionLoop::SetNormal float   [3] [virtual]
 

virtual float* vtkImplicitSelectionLoop::GetNormal   [virtual]
 

virtual void vtkImplicitSelectionLoop::GetNormal float    data[3] [virtual]
 

unsigned long vtkImplicitSelectionLoop::GetMTime   [virtual]
 

Overload GetMTime() because we depend on the Loop

Reimplemented from vtkImplicitFunction.

void vtkImplicitSelectionLoop::operator= const vtkImplicitSelectionLoop &    [inline, protected]
 

Definition at line 124 of file vtkImplicitSelectionLoop.h.


Member Data Documentation

vtkPoints* vtkImplicitSelectionLoop::Loop [protected]
 

Definition at line 126 of file vtkImplicitSelectionLoop.h.

float vtkImplicitSelectionLoop::Normal[3] [protected]
 

Definition at line 127 of file vtkImplicitSelectionLoop.h.

int vtkImplicitSelectionLoop::AutomaticNormalGeneration [protected]
 

Definition at line 128 of file vtkImplicitSelectionLoop.h.


The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:49:11 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001