implicit function for a selection loop More...

#include <vtkImplicitSelectionLoop.h>

Inheritance diagram for vtkImplicitSelectionLoop:

Collaboration diagram for vtkImplicitSelectionLoop:

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 vtkPoints *	GetLoop ()


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])

Public Member Functions inherited from vtkImplicitFunction
vtkImplicitFunction *	NewInstance () const

double	FunctionValue (const double x[3])

double	FunctionValue (double x, double y, double z)

void	FunctionGradient (const double x[3], double g[3])

double *	FunctionGradient (const double x[3])

double *	FunctionGradient (double x, double y, double z)

virtual void	SetTransform (vtkAbstractTransform *)

virtual void	SetTransform (const double elements[16])

virtual vtkAbstractTransform *	GetTransform ()

double	EvaluateFunction (double x, double y, double z)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkImplicitSelectionLoop *	New ()

Static Public Member Functions inherited from vtkImplicitFunction
static int	IsTypeOf (const char *type)

static vtkImplicitFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
	vtkImplicitSelectionLoop ()

	~vtkImplicitSelectionLoop ()

Protected Member Functions inherited from vtkImplicitFunction
	vtkImplicitFunction ()

	~vtkImplicitFunction ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkPoints *	Loop

double	Normal [3]

int	AutomaticNormalGeneration

Protected Attributes inherited from vtkImplicitFunction
vtkAbstractTransform *	Transform

double	ReturnValue [3]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkImplicitFunction	Superclass

static int	IsTypeOf (const char *type)

static vtkImplicitSelectionLoop *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkImplicitSelectionLoop *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkImplicitFunction
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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.

Reimplemented from vtkImplicitFunction.

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.

Reimplemented from vtkImplicitFunction.

vtkImplicitSelectionLoop* vtkImplicitSelectionLoop::NewInstance ( ) const

Standard VTK methods for printing and type information.

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

virtual

Standard VTK methods for printing and type information.

Reimplemented from vtkImplicitFunction.

static vtkImplicitSelectionLoop* vtkImplicitSelectionLoop::New ( )

static

Instantiate object with no initial loop.

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

virtual

Evaluate selection loop returning a signed distance.

Implements vtkImplicitFunction.

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]
	)

virtual

Evaluate selection loop returning the gradient.

Implements 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

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 ( )

virtual

Overload GetMTime() because we depend on the Loop

Reimplemented from vtkImplicitFunction.

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:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkImplicitSelectionLoop.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation