Documentation for vtkImplicitSelectionLoop

vtkImplicitSelectionLoop - implicit function for a selection loop

Super Class: vtkImplicitFunction

Description:

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

 

Methods:

void vtkImplicitSelectionLoop ()
void vtkImplicitSelectionLoop ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
static vtkImplicitSelectionLoop *New ()
float EvaluateFunction (float )
void EvaluateGradient (float ,float )
void SetLoop (vtkPoints *)
vtkPoints *GetLoop ()
void SetAutomaticNormalGeneration (int )
int GetAutomaticNormalGeneration ()
void AutomaticNormalGenerationOn ()
void AutomaticNormalGenerationOff ()
void SetNormal (float ,float ,float )
void SetNormal (float *)
float *GetNormal ()
unsigned long GetMTime ()
void Initialize ()

 

Detailed Method Descriptions:

Evaluate selection loop returning a signed distance.

static vtkImplicitSelectionLoop *New ()
float EvaluateFunction (float )

Evaluate selection loop returning the gradient.

void EvaluateGradient (float ,float )

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

void SetLoop (vtkPoints *)
vtkPoints *GetLoop ()

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.

void SetAutomaticNormalGeneration (int )
int GetAutomaticNormalGeneration ()
void AutomaticNormalGenerationOn ()
void AutomaticNormalGenerationOff ()

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

void SetNormal (float ,float ,float )
void SetNormal (float *)
float *GetNormal ()

Overload GetMTime() because we depend on the Loop

unsigned long GetMTime ()