VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImplicitSelectionLoop Class Reference

implicit function for a selection loop More...

#include <vtkImplicitSelectionLoop.h>

Inherits vtkImplicitFunction.

Collaboration diagram for vtkImplicitSelectionLoop:
[legend]

Public Member Functions

void EvaluateGradient (double x[3], double n[3])
 
unsigned long GetMTime ()
 
double EvaluateFunction (double x[3])
 
double EvaluateFunction (double x, double y, double z)
 
virtual void SetLoop (vtkPoints *)
 
virtual vtkPointsGetLoop ()
 
virtual void SetAutomaticNormalGeneration (int)
 
virtual int GetAutomaticNormalGeneration ()
 
virtual void AutomaticNormalGenerationOn ()
 
virtual void AutomaticNormalGenerationOff ()
 
virtual void SetNormal (double, double, double)
 
virtual void SetNormal (double[3])
 
virtual double * GetNormal ()
 
virtual void GetNormal (double data[3])
 

Static Public Member Functions

static vtkImplicitSelectionLoopNew ()
 

Protected Member Functions

 vtkImplicitSelectionLoop ()
 
 ~vtkImplicitSelectionLoop ()
 

Protected Attributes

vtkPointsLoop
 
double Normal [3]
 
int AutomaticNormalGeneration
 
typedef vtkImplicitFunction Superclass
 
static int IsTypeOf (const char *type)
 
static vtkImplicitSelectionLoopSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkImplicitSelectionLoopNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBaseNewInstanceInternal () const
 

Detailed Description

implicit function for a selection loop

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
Tests:
vtkImplicitSelectionLoop (Tests)

Definition at line 59 of file vtkImplicitSelectionLoop.h.

Member Typedef Documentation

typedef vtkImplicitFunction vtkImplicitSelectionLoop::Superclass

Standard VTK methods for printing and type information.

Definition at line 64 of file vtkImplicitSelectionLoop.h.

Constructor & Destructor Documentation

vtkImplicitSelectionLoop::vtkImplicitSelectionLoop ( )
protected
vtkImplicitSelectionLoop::~vtkImplicitSelectionLoop ( )
protected

Member Function Documentation

static int vtkImplicitSelectionLoop::IsTypeOf ( const char *  type)
static

Standard VTK methods for printing and type information.

virtual int vtkImplicitSelectionLoop::IsA ( const char *  type)
virtual

Standard VTK methods for printing and type information.

static vtkImplicitSelectionLoop* vtkImplicitSelectionLoop::SafeDownCast ( vtkObjectBase o)
static

Standard VTK methods for printing and type information.

virtual vtkObjectBase* vtkImplicitSelectionLoop::NewInstanceInternal ( ) const
protectedvirtual

Standard VTK methods for printing and type information.

vtkImplicitSelectionLoop* vtkImplicitSelectionLoop::NewInstance ( ) const

Standard VTK methods for printing and type information.

void vtkImplicitSelectionLoop::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

Standard VTK methods for printing and type information.

static vtkImplicitSelectionLoop* vtkImplicitSelectionLoop::New ( )
static

Instantiate object with no initial loop.

double vtkImplicitSelectionLoop::EvaluateFunction ( double  x[3])

Evaluate selection loop returning a signed distance.

double vtkImplicitSelectionLoop::EvaluateFunction ( double  x,
double  y,
double  z 
)
inline

Evaluate selection loop returning a signed distance.

Definition at line 74 of file vtkImplicitSelectionLoop.h.

void vtkImplicitSelectionLoop::EvaluateGradient ( double  x[3],
double  n[3] 
)

Evaluate selection loop returning the gradient.

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

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

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

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 void vtkImplicitSelectionLoop::AutomaticNormalGenerationOn ( )
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 void vtkImplicitSelectionLoop::AutomaticNormalGenerationOff ( )
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 void vtkImplicitSelectionLoop::SetNormal ( double  ,
double  ,
double   
)
virtual

Set / get the normal used to determine whether a point is inside or outside the selection loop.

virtual void vtkImplicitSelectionLoop::SetNormal ( double  [3])
virtual

Set / get the normal used to determine whether a point is inside or outside the selection loop.

virtual double* vtkImplicitSelectionLoop::GetNormal ( )
virtual

Set / get the normal used to determine whether a point is inside or outside the selection loop.

virtual void vtkImplicitSelectionLoop::GetNormal ( double  data[3])
virtual

Set / get the normal used to determine whether a point is inside or outside the selection loop.

unsigned long vtkImplicitSelectionLoop::GetMTime ( )

Overload GetMTime() because we depend on the Loop

Member Data Documentation

vtkPoints* vtkImplicitSelectionLoop::Loop
protected

Definition at line 111 of file vtkImplicitSelectionLoop.h.

double vtkImplicitSelectionLoop::Normal[3]
protected

Definition at line 112 of file vtkImplicitSelectionLoop.h.

int vtkImplicitSelectionLoop::AutomaticNormalGeneration
protected

Definition at line 113 of file vtkImplicitSelectionLoop.h.


The documentation for this class was generated from the following file: