VTK  9.3.20240715
vtkHull Class Reference

produce an n-sided convex hull More...

#include <vtkHull.h>

Inheritance diagram for vtkHull:
[legend]
Collaboration diagram for vtkHull:
[legend]

## Public Member Functions

void RemoveAllPlanes ()
Remove all planes from the current set of planes.

void SetPlanes (vtkPlanes *planes)
Set all the planes at once using a vtkPlanes implicit function.

int GetNumberOfPlanes ()
Get the number of planes in the current set of planes.

Add the 8 planes that represent the vertices of a cube - the combination of the three face planes connecting to a vertex - (1,1,1), (1,1,-1), (1,-1,1), (1,-1,1), (-1,1,1), (-1,1,-1), (-1,-1,1), (-1,-1-1).

Add the 12 planes that represent the edges of a cube - halfway between the two connecting face planes - (1,1,0), (-1,-1,0), (-1,1,0), (1,-1,0), (0,1,1), (0,-1,-1), (0,1,-1), (0,-1,1), (1,0,1), (-1,0,-1), (1,0,-1), (-1,0,1)

Add the six planes that make up the faces of a cube - (1,0,0), (-1, 0, 0), (0,1,0), (0,-1,0), (0,0,1), (0,0,-1)

Add the planes that represent the normals of the vertices of a polygonal sphere formed by recursively subdividing the triangles in an octahedron.

int AddPlane (double A, double B, double C)
Add a plane to the current set of planes.

Add a plane to the current set of planes.

void SetPlane (int i, double A, double B, double C)
Set the normal values for plane i.

void SetPlane (int i, double plane[3])
Set the normal values for plane i.

int AddPlane (double A, double B, double C, double D)
Variations of AddPlane()/SetPlane() that allow D to be set.

int AddPlane (double plane[3], double D)
Variations of AddPlane()/SetPlane() that allow D to be set.

void SetPlane (int i, double A, double B, double C, double D)
Variations of AddPlane()/SetPlane() that allow D to be set.

void SetPlane (int i, double plane[3], double D)
Variations of AddPlane()/SetPlane() that allow D to be set.

void GenerateHull (vtkPolyData *pd, double *bounds)
A special method that is used to generate a polyhedron directly from a set of n planes.

void GenerateHull (vtkPolyData *pd, double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
A special method that is used to generate a polyhedron directly from a set of n planes.

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

vtkPointSetAlgorithmNewInstance () const

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

vtkPolyDataGetPolyDataOutput ()
Get the output as vtkPolyData.

vtkStructuredGridGetStructuredGridOutput ()
Get the output as vtkStructuredGrid.

vtkUnstructuredGridGetUnstructuredGridOutput ()
Get the output as vtkUnstructuredGrid.

vtkDataObjectGetInput ()

vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
see vtkAlgorithm for details

vtkPointSetGetOutput ()
Get the output data object for a port on this algorithm.

vtkPointSetGetOutput (int)
Get the output data object for a port on this algorithm.

void SetInputData (vtkDataObject *)
Assign a data object as input.

void SetInputData (int, vtkDataObject *)
Assign a data object as input.

void SetInputData (vtkPointSet *)
Assign a data object as input.

void SetInputData (int, vtkPointSet *)
Assign a data object as input.

Assign a data object as input.

Assign a data object as input.

Assign a data object as input.

Assign a data object as input.

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

vtkAlgorithmNewInstance () const

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

vtkTypeBool HasExecutive ()
Check whether this algorithm has an assigned executive.

vtkExecutiveGetExecutive ()
Get this algorithm's executive.

virtual void SetExecutive (vtkExecutive *executive)
Set this algorithm's executive.

virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
Version of ProcessRequest() that is wrapped.

virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
A special version of ProcessRequest meant specifically for the pipeline modified time request.

virtual int ModifyRequest (vtkInformation *request, int when)
This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

vtkInformationGetInputPortInformation (int port)
Get the information object associated with an input port.

vtkInformationGetOutputPortInformation (int port)
Get the information object associated with an output port.

int GetNumberOfInputPorts ()
Get the number of input ports used by the algorithm.

int GetNumberOfOutputPorts ()
Get the number of output ports provided by the algorithm.

void SetAbortExecuteAndUpdateTime ()
Set AbortExecute Flag and update LastAbortTime.

void UpdateProgress (double amount)
Update the progress of the process object.

bool CheckAbort ()
Checks to see if this filter should abort.

virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
String based versions of SetInputArrayToProcess().

vtkInformationGetInputArrayInformation (int idx)
Get the info object for the specified input array to this algorithm.

void RemoveAllInputs ()
Remove all the input data.

vtkDataObjectGetOutputDataObject (int port)
Get the data object that will contain the algorithm output for the given port.

vtkDataObjectGetInputDataObject (int port, int connection)
Get the data object that will contain the algorithm input for the given port and given connection.

virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
Remove a connection from the given input port index.

virtual void RemoveInputConnection (int port, int idx)
Remove a connection given by index idx.

virtual void RemoveAllInputConnections (int port)
Removes all input connections.

virtual void SetInputDataObject (int port, vtkDataObject *data)
Sets the data-object as an input on the given port index.

virtual void SetInputDataObject (vtkDataObject *data)

virtual void AddInputDataObject (int port, vtkDataObject *data)
Add the data-object as an input to this given port.

vtkAlgorithmOutputGetOutputPort (int index)
Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutputGetOutputPort ()

int GetNumberOfInputConnections (int port)
Get the number of inputs currently connected to a port.

int GetTotalNumberOfInputConnections ()
Get the total number of inputs for this algorithm.

vtkAlgorithmOutputGetInputConnection (int port, int index)
Get the algorithm output port connected to an input port.

vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithmGetInputAlgorithm (int port, int index)
Returns the algorithm connected to a port-index pair.

vtkAlgorithmGetInputAlgorithm ()
Equivalent to GetInputAlgorithm(0, 0).

vtkExecutiveGetInputExecutive (int port, int index)
Returns the executive associated with a particular input connection.

vtkExecutiveGetInputExecutive ()
Equivalent to GetInputExecutive(0, 0)

vtkInformationGetInputInformation (int port, int index)
Return the information object that is associated with a particular input connection.

vtkInformationGetInputInformation ()
Equivalent to GetInputInformation(0, 0)

vtkInformationGetOutputInformation (int port)
Return the information object that is associated with a particular output port.

virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

virtual vtkTypeBool Update (vtkInformation *requests)
Convenience method to update an algorithm after passing requests to its first output port.

virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int UpdateExtent (const int extents[6])
Convenience method to update an algorithm after passing requests to its first output port.

virtual VTK_UNBLOCKTHREADS int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
Convenience method to update an algorithm after passing requests to its first output port.

Bring the algorithm's information up-to-date.

virtual void UpdateDataObject ()
Create output object(s).

virtual void PropagateUpdateExtent ()
Propagate meta-data upstream.

Bring this algorithm's outputs up-to-date.

void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

void RemoveNoPriorTemporalAccessInformationKey ()
Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.

virtual vtkInformationGetInformation ()
Set/Get the information object associated with this algorithm.

virtual void SetInformation (vtkInformation *)
Set/Get the information object associated with this algorithm.

bool UsesGarbageCollector () const override
Participate in garbage collection.

virtual void SetAbortExecute (vtkTypeBool)
Set/Get the AbortExecute flag for the process object.

virtual vtkTypeBool GetAbortExecute ()
Set/Get the AbortExecute flag for the process object.

virtual void AbortExecuteOn ()
Set/Get the AbortExecute flag for the process object.

virtual void AbortExecuteOff ()
Set/Get the AbortExecute flag for the process object.

virtual double GetProgress ()
Get the execution progress of a process object.

void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
Set/get a Container algorithm for this algorithm.

vtkAlgorithmGetContainerAlgorithm ()
Set/get a Container algorithm for this algorithm.

virtual void SetAbortOutput (bool)
Set/Get an internal variable used to communicate between the algorithm and executive.

virtual bool GetAbortOutput ()
Set/Get an internal variable used to communicate between the algorithm and executive.

void SetProgressShiftScale (double shift, double scale)
Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.

virtual double GetProgressShift ()
Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.

virtual double GetProgressScale ()
Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.

void SetProgressText (const char *ptext)
Set the current text message associated with the progress state.

virtual char * GetProgressText ()
Set the current text message associated with the progress state.

virtual unsigned long GetErrorCode ()
The error code contains a possible error that occurred while reading or writing the file.

virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
Set the input data arrays that this algorithm will process.

virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
Set the input data arrays that this algorithm will process.

virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
Set the input data arrays that this algorithm will process.

virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
Set the connection for the given input port index.

virtual void SetInputConnection (vtkAlgorithmOutput *input)
Set the connection for the given input port index.

virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
Add a connection to the given input port index.

Add a connection to the given input port index.

virtual VTK_UNBLOCKTHREADS void Update (int port)
Bring this algorithm's outputs up-to-date.

Bring this algorithm's outputs up-to-date.

virtual void SetReleaseDataFlag (vtkTypeBool)
Turn release data flag on or off for all output ports.

virtual vtkTypeBool GetReleaseDataFlag ()
Turn release data flag on or off for all output ports.

void ReleaseDataFlagOn ()
Turn release data flag on or off for all output ports.

void ReleaseDataFlagOff ()
Turn release data flag on or off for all output ports.

int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int * GetUpdateExtent ()
These functions return the update extent for output ports that use 3D extents.

int * GetUpdateExtent (int port)
These functions return the update extent for output ports that use 3D extents.

void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
These functions return the update extent for output ports that use 3D extents.

void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
These functions return the update extent for output ports that use 3D extents.

void GetUpdateExtent (int extent[6])
These functions return the update extent for output ports that use 3D extents.

void GetUpdateExtent (int port, int extent[6])
These functions return the update extent for output ports that use 3D extents.

int GetUpdatePiece ()
These functions return the update extent for output ports that use piece extents.

int GetUpdatePiece (int port)
These functions return the update extent for output ports that use piece extents.

int GetUpdateNumberOfPieces ()
These functions return the update extent for output ports that use piece extents.

int GetUpdateNumberOfPieces (int port)
These functions return the update extent for output ports that use piece extents.

int GetUpdateGhostLevel ()
These functions return the update extent for output ports that use piece extents.

int GetUpdateGhostLevel (int port)
These functions return the update extent for output ports that use piece extents.

void SetProgressObserver (vtkProgressObserver *)
If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual vtkProgressObserverGetProgressObserver ()
If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

void SetNoPriorTemporalAccessInformationKey (int key)
Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().

void SetNoPriorTemporalAccessInformationKey ()
Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().

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

virtual void DebugOn ()
Turn debugging output on.

virtual void DebugOff ()
Turn debugging output off.

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

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

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

virtual vtkMTimeType GetMTime ()
Return this object's modified time.

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

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)

vtkTypeBool InvokeEvent (unsigned long event)

vtkTypeBool InvokeEvent (const char *event)

std::string GetObjectDescription () const override
The object description printed in messages and PrintSelf output.

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

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

vtkCommandGetCommand (unsigned long tag)
Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void RemoveObserver (vtkCommand *)
Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void RemoveObservers (unsigned long event, vtkCommand *)
Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void RemoveObservers (const char *event, vtkCommand *)
Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool HasObserver (const char *event, vtkCommand *)
Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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

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

vtkTypeBool InvokeEvent (const char *event, void *callData)
This method invokes an event and return whether the event was aborted or not.

virtual void SetObjectName (const std::string &objectName)
Set/get the name of this object for reporting purposes.

virtual std::string GetObjectName () const
Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
Return the class name as a string.

virtual std::string GetObjectDescription () const
The object description printed in messages and PrintSelf output.

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

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

virtual void Delete ()
Delete a VTK object.

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

void InitializeObjectBase ()

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

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

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

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

void SetReferenceCount (int)
Sets the reference count.

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

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

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

## Protected Member Functions

vtkHull ()=default

~vtkHull () override=default

void ComputePlaneDistances (vtkPointSet *input)

void ClipPolygonsFromPlanes (vtkPoints *points, vtkCellArray *polys, const double *bounds)

void CreateInitialPolygon (double *, int, const double *)

int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called by the superclass.

int FillOutputPortInformation (int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.

Protected Member Functions inherited from vtkPointSetAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const

vtkPointSetAlgorithm ()

~vtkPointSetAlgorithm () override=default

virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
This is called by the superclass.

virtual int ExecuteInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.

virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.

virtual int ComputeInputUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

int FillOutputPortInformation (int port, vtkInformation *info) override
Fill the output port information objects for this algorithm.

int FillInputPortInformation (int port, vtkInformation *info) override
Fill the input port information objects for this algorithm.

virtual int ComputeInputUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
This is called by the superclass.

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const

vtkAlgorithm ()

~vtkAlgorithm () override

bool CheckUpstreamAbort ()
Checks to see if an upstream filter has been aborted.

virtual int FillInputPortInformation (int port, vtkInformation *info)
Fill the input port information objects for this algorithm.

virtual int FillOutputPortInformation (int port, vtkInformation *info)
Fill the output port information objects for this algorithm.

virtual void SetNumberOfInputPorts (int n)
Set the number of input ports used by the algorithm.

virtual void SetNumberOfOutputPorts (int n)
Set the number of output ports provided by the algorithm.

int InputPortIndexInRange (int index, const char *action)

int OutputPortIndexInRange (int index, const char *action)

int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.

virtual vtkExecutiveCreateDefaultExecutive ()
Create a default executive.

void ReportReferences (vtkGarbageCollector *) override

virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
Replace the Nth connection on the given input port.

virtual void SetNumberOfInputConnections (int port, int n)
Set the number of input connections on the given input port.

void SetInputDataInternal (int port, vtkDataObject *input)
These methods are used by subclasses to implement methods to set data objects directly as input.

void AddInputDataInternal (int port, vtkDataObject *input)

int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
Filters that have multiple connections on one port can use this signature.

int GetInputArrayAssociation (int idx, vtkDataObject *input)
Filters that have multiple connections on one port can use this signature.

vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
Filters that have multiple connections on one port can use this signature.

vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
Filters that have multiple connections on one port can use this signature.

vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
Filters that have multiple connections on one port can use this signature.

vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
Filters that have multiple connections on one port can use this signature.

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
Filters that have multiple connections on one port can use this signature.

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
Filters that have multiple connections on one port can use this signature.

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
Filters that have multiple connections on one port can use this signature.

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
Filters that have multiple connections on one port can use this signature.

virtual void SetErrorCode (unsigned long)
The error code contains a possible error that occurred while reading or writing the file.

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.

void InternalReleaseFocus ()
These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
vtkObjectBase ()

virtual ~vtkObjectBase ()

virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void ReportReferences (vtkGarbageCollector *)

virtual void ObjectFinalize ()

vtkObjectBase (const vtkObjectBase &)

void operator= (const vtkObjectBase &)

## Protected Attributes

std::vector< double > Planes

Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime

vtkInformationInformation

double Progress

char * ProgressText

vtkProgressObserverProgressObserver

unsigned long ErrorCode
The error code contains a possible error that occurred while reading or writing the file.

Protected Attributes inherited from vtkObject
bool Debug

vtkTimeStamp MTime

vtkSubjectHelper * SubjectHelper

std::string ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount

vtkWeakPointerBase ** WeakPointers

typedef vtkPointSetAlgorithm Superclass
Standard methods to instantiate, obtain type information, and print information about the class.

static vtkHullNew ()
Standard methods to instantiate, obtain type information, and print information about the class.

static vtkTypeBool IsTypeOf (const char *type)
Standard methods to instantiate, obtain type information, and print information about the class.

static vtkHullSafeDownCast (vtkObjectBase *o)
Standard methods to instantiate, obtain type information, and print information about the class.

virtual vtkTypeBool IsA (const char *type)
Standard methods to instantiate, obtain type information, and print information about the class.

vtkHullNewInstance () const
Standard methods to instantiate, obtain type information, and print information about the class.

void PrintSelf (ostream &os, vtkIndent indent) override
Standard methods to instantiate, obtain type information, and print information about the class.

virtual vtkObjectBaseNewInstanceInternal () const
Standard methods to instantiate, obtain type information, and print information about the class.

Public Types inherited from vtkPointSetAlgorithm
typedef vtkAlgorithm Superclass

Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject Superclass

Static Public Member Functions inherited from vtkPointSetAlgorithm
static vtkPointSetAlgorithmNew ()

static vtkTypeBool IsTypeOf (const char *type)

static vtkPointSetAlgorithmSafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()

static vtkTypeBool IsTypeOf (const char *type)

static vtkAlgorithmSafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
Keys used to specify input port requirements.

static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKeyINPUT_PORT ()

static vtkInformationIntegerKeyINPUT_CONNECTION ()

static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static vtkInformationIntegerKeyABORTED ()

static void SetDefaultExecutivePrototype (vtkExecutive *proto)
If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

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

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

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

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

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

static vtkTypeBool GetGlobalWarningDisplay ()
This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

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

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

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.

Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()

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

static vtkReallocingFunction GetCurrentReallocFunction ()

static vtkFreeingFunction GetCurrentFreeFunction ()

static vtkFreeingFunction GetAlternateFreeFunction ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime

static vtkExecutiveDefaultExecutivePrototype

## Detailed Description

produce an n-sided convex hull

vtkHull is a filter which will produce an n-sided convex hull given a set of n planes. (The convex hull bounds the input vtkPointSet data.) The hull is generated by squeezing the planes towards the input vtkPointSet, until the planes just touch the points. Then, the resulting planes are used to generate a polyhedron (i.e., hull) that is represented by triangles.

The n planes can be defined in a number of ways including 1) manually specifying each plane; 2) choosing the six face planes of the input's bounding box; 3) choosing the eight vertex planes of the input's bounding box; 4) choosing the twelve edge planes of the input's bounding box; and/or 5) using a recursively subdivided octahedron. Note that when specifying planes, the plane normals should point outside of the convex region.

The output of this filter can be used in combination with vtkLODActor to represent a levels-of-detail in the LOD hierarchy. Another use of this class is to manually specify the planes, and then generate the polyhedron from the planes (without squeezing the planes towards the input). The method GenerateHull() is used to do this.

Online Examples:

Tests:
vtkHull (Tests)

Definition at line 74 of file vtkHull.h.

## ◆ Superclass

Standard methods to instantiate, obtain type information, and print information about the class.

Definition at line 83 of file vtkHull.h.

## ◆ vtkHull()

 vtkHull::vtkHull ( )
protecteddefault

## ◆ ~vtkHull()

 vtkHull::~vtkHull ( )
overrideprotecteddefault

## ◆ New()

 static vtkHull * vtkHull::New ( )
static

Standard methods to instantiate, obtain type information, and print information about the class.

## ◆ IsTypeOf()

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

Standard methods to instantiate, obtain type information, and print information about the class.

## ◆ IsA()

 virtual vtkTypeBool vtkHull::IsA ( const char * type )
virtual

Standard methods to instantiate, obtain type information, and print information about the class.

Reimplemented from vtkPointSetAlgorithm.

## ◆ SafeDownCast()

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

Standard methods to instantiate, obtain type information, and print information about the class.

## ◆ NewInstanceInternal()

 virtual vtkObjectBase * vtkHull::NewInstanceInternal ( ) const
protectedvirtual

Standard methods to instantiate, obtain type information, and print information about the class.

Reimplemented from vtkPointSetAlgorithm.

## ◆ NewInstance()

 vtkHull * vtkHull::NewInstance ( ) const

Standard methods to instantiate, obtain type information, and print information about the class.

## ◆ PrintSelf()

 void vtkHull::PrintSelf ( ostream & os, vtkIndent indent )
overridevirtual

Standard methods to instantiate, obtain type information, and print information about the class.

Reimplemented from vtkAlgorithm.

## ◆ RemoveAllPlanes()

 void vtkHull::RemoveAllPlanes ( )

Remove all planes from the current set of planes.

 int vtkHull::AddPlane ( double A, double B, double C )

Add a plane to the current set of planes.

It will be added at the end of the list, and an index that can later be used to set this plane's normal will be returned. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length (but it must have a non-zero length!). If a value 0 > i >= -NumberOfPlanes is returned, then the plane is parallel with a previously inserted plane, and |-i-1| is the index of the plane that was previously inserted. If a value i < -NumberOfPlanes is returned, then the plane normal is zero length.

 int vtkHull::AddPlane ( double plane[3] )

Add a plane to the current set of planes.

It will be added at the end of the list, and an index that can later be used to set this plane's normal will be returned. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length (but it must have a non-zero length!). If a value 0 > i >= -NumberOfPlanes is returned, then the plane is parallel with a previously inserted plane, and |-i-1| is the index of the plane that was previously inserted. If a value i < -NumberOfPlanes is returned, then the plane normal is zero length.

## ◆ SetPlane() [1/4]

 void vtkHull::SetPlane ( int i, double A, double B, double C )

Set the normal values for plane i.

This is a plane that was already added to the current set of planes with AddPlane(), and is now being modified. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length. Note that D is set to zero, except in the case of the method taking a vtkPlanes* argument, where it is set to the D value defined there.

## ◆ SetPlane() [2/4]

 void vtkHull::SetPlane ( int i, double plane[3] )

Set the normal values for plane i.

This is a plane that was already added to the current set of planes with AddPlane(), and is now being modified. The values A, B, C are from the plane equation Ax + By + Cz + D = 0. This vector does not have to have unit length. Note that D is set to zero, except in the case of the method taking a vtkPlanes* argument, where it is set to the D value defined there.

 int vtkHull::AddPlane ( double A, double B, double C, double D )

Variations of AddPlane()/SetPlane() that allow D to be set.

These methods are used when GenerateHull() is used.

 int vtkHull::AddPlane ( double plane[3], double D )

Variations of AddPlane()/SetPlane() that allow D to be set.

These methods are used when GenerateHull() is used.

## ◆ SetPlane() [3/4]

 void vtkHull::SetPlane ( int i, double A, double B, double C, double D )

Variations of AddPlane()/SetPlane() that allow D to be set.

These methods are used when GenerateHull() is used.

## ◆ SetPlane() [4/4]

 void vtkHull::SetPlane ( int i, double plane[3], double D )

Variations of AddPlane()/SetPlane() that allow D to be set.

These methods are used when GenerateHull() is used.

## ◆ SetPlanes()

 void vtkHull::SetPlanes ( vtkPlanes * planes )

Set all the planes at once using a vtkPlanes implicit function.

This also sets the D value, so it can be used with GenerateHull().

## ◆ GetNumberOfPlanes()

 int vtkHull::GetNumberOfPlanes ( )

Get the number of planes in the current set of planes.

Add the 8 planes that represent the vertices of a cube - the combination of the three face planes connecting to a vertex - (1,1,1), (1,1,-1), (1,-1,1), (1,-1,1), (-1,1,1), (-1,1,-1), (-1,-1,1), (-1,-1-1).

Add the 12 planes that represent the edges of a cube - halfway between the two connecting face planes - (1,1,0), (-1,-1,0), (-1,1,0), (1,-1,0), (0,1,1), (0,-1,-1), (0,1,-1), (0,-1,1), (1,0,1), (-1,0,-1), (1,0,-1), (-1,0,1)

Add the six planes that make up the faces of a cube - (1,0,0), (-1, 0, 0), (0,1,0), (0,-1,0), (0,0,1), (0,0,-1)

 void vtkHull::AddRecursiveSpherePlanes ( int level )

Add the planes that represent the normals of the vertices of a polygonal sphere formed by recursively subdividing the triangles in an octahedron.

Each triangle is subdivided by connecting the midpoints of the edges thus forming 4 smaller triangles. The level indicates how many subdivisions to do with a level of 0 used to add the 6 planes from the original octahedron, level 1 will add 18 planes, and so on.

## ◆ GenerateHull() [1/2]

 void vtkHull::GenerateHull ( vtkPolyData * pd, double * bounds )

A special method that is used to generate a polyhedron directly from a set of n planes.

The planes that are supplied by the user are not squeezed towards the input data (in fact the user need not specify an input). To use this method, you must provide an instance of vtkPolyData into which the points and cells defining the polyhedron are placed. You must also provide a bounding box where you expect the resulting polyhedron to lie. This can be a very generous fit, it's only used to create the initial polygons that are eventually clipped.

## ◆ GenerateHull() [2/2]

 void vtkHull::GenerateHull ( vtkPolyData * pd, double xmin, double xmax, double ymin, double ymax, double zmin, double zmax )

A special method that is used to generate a polyhedron directly from a set of n planes.

The planes that are supplied by the user are not squeezed towards the input data (in fact the user need not specify an input). To use this method, you must provide an instance of vtkPolyData into which the points and cells defining the polyhedron are placed. You must also provide a bounding box where you expect the resulting polyhedron to lie. This can be a very generous fit, it's only used to create the initial polygons that are eventually clipped.

## ◆ ComputePlaneDistances()

 void vtkHull::ComputePlaneDistances ( vtkPointSet * input )
protected

## ◆ ClipPolygonsFromPlanes()

 void vtkHull::ClipPolygonsFromPlanes ( vtkPoints * points, vtkCellArray * polys, const double * bounds )
protected

## ◆ CreateInitialPolygon()

 void vtkHull::CreateInitialPolygon ( double * , int , const double * )
protected

## ◆ RequestData()

 int vtkHull::RequestData ( vtkInformation * , vtkInformationVector ** , vtkInformationVector * )
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPointSetAlgorithm.

## ◆ FillOutputPortInformation()

 int vtkHull::FillOutputPortInformation ( int port, vtkInformation * info )
overrideprotectedvirtual

Fill the output port information objects for this algorithm.

This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAlgorithm.

## ◆ Planes

 std::vector vtkHull::Planes
protected

Definition at line 197 of file vtkHull.h.

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