#include <vtkImplicitProjectOnPlaneDistance.h>

Inheritance diagram for vtkImplicitProjectOnPlaneDistance:

Collaboration diagram for vtkImplicitProjectOnPlaneDistance:

Public Types
enum	NormType { NormType::L0 = 0, NormType::L2 = 2 }

typedef vtkImplicitFunction	Superclass

Public Types inherited from vtkImplicitFunction
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkImplicitProjectOnPlaneDistance *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

vtkMTimeType	GetMTime () override
	Return the MTime also considering the Input dependency. More...

double	EvaluateFunction (double x[3]) override
	Evaluate function at position x-y-z and return value. More...

void	EvaluateGradient (double x[3], double g[3]) override
	Evaluate function gradient of nearest triangle to point x[3]. More...

void	SetInput (vtkPolyData *input)
	Set the input vtkPolyData used for the implicit function evaluation. More...

virtual double	GetTolerance ()
	Set/get the tolerance usued for the locator. More...

virtual void	SetTolerance (double)

NormType	GetNorm () const
	Set the norm to use: L0: 0 when the projection is inside the input polygon, 1 otherwise L2: Euclidean distance between the projection and the polygon (default) More...

void	SetNorm (NormType n)

void	SetNorm (int n)

	vtkGetSmartPointerMacro (Locator, vtkAbstractCellLocator)
	Set/get the Locator used by to compute the distance. More...

	vtkSetSmartPointerMacro (Locator, vtkAbstractCellLocator)

virtual double	EvaluateFunction (double x[3])=0
	Project x onto the plane defined by the Input polydata and evalute the distance to the geometry defined by the Input polydata. More...

virtual void	EvaluateFunction (vtkDataArray input, vtkDataArray output)
	Project x onto the plane defined by the Input polydata and evalute the distance to the geometry defined by the Input polydata. More...

virtual double	EvaluateFunction (double x, double y, double z)
	Project x onto the plane defined by the Input polydata and evalute the distance to the geometry defined by the Input polydata. More...

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

virtual void	FunctionValue (vtkDataArray input, vtkDataArray output)
	Evaluate function at position x-y-z and return value. More...

double	FunctionValue (const double x[3])

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

void	FunctionGradient (const double x[3], double g[3])
	Evaluate function gradient at position x-y-z and pass back vector. More...

double *	FunctionGradient (const double x[3])

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

virtual void	SetTransform (vtkAbstractTransform *)
	Set/Get a transformation to apply to input points before executing the implicit function. More...

virtual void	SetTransform (const double elements[16])

virtual vtkAbstractTransform *	GetTransform ()

virtual void	EvaluateFunction (vtkDataArray input, vtkDataArray output)

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

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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 )

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)

vtkTypeBool	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

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)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

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
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

Static Public Member Functions
static vtkImplicitProjectOnPlaneDistance *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkImplicitProjectOnPlaneDistance *	SafeDownCast (vtkObjectBase *o)

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

static vtkImplicitFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImplicitProjectOnPlaneDistance ()

	~vtkImplicitProjectOnPlaneDistance () override=default

void	CreateDefaultLocator (void)
	Create a default locator (vtkStaticCellLocator). More...

Protected Member Functions inherited from vtkImplicitFunction
	vtkImplicitFunction ()

	~vtkImplicitFunction () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	Tolerance

NormType	Norm

vtkSmartPointer< vtkPolyData >	Input

vtkSmartPointer< vtkAbstractCellLocator >	Locator

vtkSmartPointer< vtkPlane >	ProjectionPlane

vtkSmartPointer< vtkGenericCell >	UnusedCell

double	Bounds [6]

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
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

This class recieve a plannar polygon as input. Given a point, it can evaluate the L0 or L2 norm between the projection of this point on the plan of the polygon and the polygon itself.

An interesting use of this class is to enable the L0 norm and evaluate the "projected distance" between every vertex of a mesh and the given plannar polygon. As a reslut, all the vertices that project onto the polygon will corresond to the value 0 and ohter ones will recieve the value 1. From there, we can use a clip to keep only the part of the mesh "below" the polygon.

TLDR: This filter allows to clip using the extrusion of any plannar polygon.

Definition at line 44 of file vtkImplicitProjectOnPlaneDistance.h.

Member Typedef Documentation

◆ Superclass

typedef vtkImplicitFunction vtkImplicitProjectOnPlaneDistance::Superclass

Definition at line 54 of file vtkImplicitProjectOnPlaneDistance.h.

Member Enumeration Documentation

◆ NormType

enum vtkImplicitProjectOnPlaneDistance::NormType

strong

Enumerator
L0
L2

Definition at line 47 of file vtkImplicitProjectOnPlaneDistance.h.

Constructor & Destructor Documentation

◆ vtkImplicitProjectOnPlaneDistance()

vtkImplicitProjectOnPlaneDistance::vtkImplicitProjectOnPlaneDistance ( )

protected

◆ ~vtkImplicitProjectOnPlaneDistance()

vtkImplicitProjectOnPlaneDistance::~vtkImplicitProjectOnPlaneDistance ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkImplicitProjectOnPlaneDistance* vtkImplicitProjectOnPlaneDistance::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkImplicitProjectOnPlaneDistance::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkImplicitProjectOnPlaneDistance::IsA ( const char * name )

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.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImplicitProjectOnPlaneDistance::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImplicitFunction.

◆ NewInstance()

vtkImplicitProjectOnPlaneDistance* vtkImplicitProjectOnPlaneDistance::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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.

◆ GetMTime()

vtkMTimeType vtkImplicitProjectOnPlaneDistance::GetMTime ( )

overridevirtual

Return the MTime also considering the Input dependency.

Reimplemented from vtkImplicitFunction.

◆ EvaluateFunction() [1/4]

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

overridevirtual

Evaluate function at position x-y-z and return value.

You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Implements vtkImplicitFunction.

◆ EvaluateGradient()

void vtkImplicitProjectOnPlaneDistance::EvaluateGradient	(	double	x[3],
		double	g[3]
	)

overridevirtual

Evaluate function gradient of nearest triangle to point x[3].

WARNING: not implemented as it is of no use in this context.

Implements vtkImplicitFunction.

◆ SetInput()

void vtkImplicitProjectOnPlaneDistance::SetInput ( vtkPolyData * input )

Set the input vtkPolyData used for the implicit function evaluation.

This polydata needs to be planar.

◆ GetTolerance()

virtual double vtkImplicitProjectOnPlaneDistance::GetTolerance ( )

virtual

Set/get the tolerance usued for the locator.

Default is 0.01.

◆ SetTolerance()

virtual void vtkImplicitProjectOnPlaneDistance::SetTolerance ( double )

virtual

◆ GetNorm()

NormType vtkImplicitProjectOnPlaneDistance::GetNorm ( ) const

inline

Set the norm to use: L0: 0 when the projection is inside the input polygon, 1 otherwise L2: Euclidean distance between the projection and the polygon (default)

Definition at line 96 of file vtkImplicitProjectOnPlaneDistance.h.

◆ SetNorm() [1/2]

void vtkImplicitProjectOnPlaneDistance::SetNorm ( NormType n )

inline

Definition at line 97 of file vtkImplicitProjectOnPlaneDistance.h.

◆ SetNorm() [2/2]

void vtkImplicitProjectOnPlaneDistance::SetNorm ( int n )

inline

Definition at line 105 of file vtkImplicitProjectOnPlaneDistance.h.

◆ vtkGetSmartPointerMacro()

vtkImplicitProjectOnPlaneDistance::vtkGetSmartPointerMacro	(	Locator	,
		vtkAbstractCellLocator
	)

Set/get the Locator used by to compute the distance.

A vtkStaticCellLocator is provided by default if none is given by the user.

◆ vtkSetSmartPointerMacro()

vtkImplicitProjectOnPlaneDistance::vtkSetSmartPointerMacro	(	Locator	,
		vtkAbstractCellLocator
	)

◆ CreateDefaultLocator()

void vtkImplicitProjectOnPlaneDistance::CreateDefaultLocator ( void )

protected

Create a default locator (vtkStaticCellLocator).

Used to create one when none is specified by the user.

◆ EvaluateFunction() [2/4]

virtual double vtkImplicitFunction::EvaluateFunction

Project x onto the plane defined by the Input polydata and evalute the distance to the geometry defined by the Input polydata.

◆ EvaluateFunction() [3/4]

virtual void vtkImplicitFunction::EvaluateFunction

Project x onto the plane defined by the Input polydata and evalute the distance to the geometry defined by the Input polydata.

◆ EvaluateFunction() [4/4]

virtual double vtkImplicitFunction::EvaluateFunction

inline

Project x onto the plane defined by the Input polydata and evalute the distance to the geometry defined by the Input polydata.

Definition at line 123 of file vtkImplicitFunction.h.

Member Data Documentation

◆ Tolerance

double vtkImplicitProjectOnPlaneDistance::Tolerance

protected

Definition at line 133 of file vtkImplicitProjectOnPlaneDistance.h.

◆ Norm

NormType vtkImplicitProjectOnPlaneDistance::Norm

protected

Definition at line 134 of file vtkImplicitProjectOnPlaneDistance.h.

◆ Input

vtkSmartPointer<vtkPolyData> vtkImplicitProjectOnPlaneDistance::Input

protected

Definition at line 136 of file vtkImplicitProjectOnPlaneDistance.h.

◆ Locator

vtkSmartPointer<vtkAbstractCellLocator> vtkImplicitProjectOnPlaneDistance::Locator

protected

Definition at line 137 of file vtkImplicitProjectOnPlaneDistance.h.

◆ ProjectionPlane

vtkSmartPointer<vtkPlane> vtkImplicitProjectOnPlaneDistance::ProjectionPlane

protected

Definition at line 138 of file vtkImplicitProjectOnPlaneDistance.h.

◆ UnusedCell

vtkSmartPointer<vtkGenericCell> vtkImplicitProjectOnPlaneDistance::UnusedCell

protected

Definition at line 141 of file vtkImplicitProjectOnPlaneDistance.h.

◆ Bounds

double vtkImplicitProjectOnPlaneDistance::Bounds[6]

protected

Definition at line 142 of file vtkImplicitProjectOnPlaneDistance.h.

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

Filters/Core/vtkImplicitProjectOnPlaneDistance.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ NormType

Constructor & Destructor Documentation

◆ vtkImplicitProjectOnPlaneDistance()

◆ ~vtkImplicitProjectOnPlaneDistance()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetMTime()

◆ EvaluateFunction() [1/4]

◆ EvaluateGradient()

◆ SetInput()

◆ GetTolerance()

◆ SetTolerance()

◆ GetNorm()

◆ SetNorm() [1/2]

◆ SetNorm() [2/2]

◆ vtkGetSmartPointerMacro()

◆ vtkSetSmartPointerMacro()

◆ CreateDefaultLocator()

◆ EvaluateFunction() [2/4]

◆ EvaluateFunction() [3/4]

◆ EvaluateFunction() [4/4]

Member Data Documentation

◆ Tolerance

◆ Norm

◆ Input

◆ Locator

◆ ProjectionPlane

◆ UnusedCell

◆ Bounds