VTK  9.3.20240808
vtkHyperTreeGridPlaneCutter Class Reference

cut an hyper tree grid volume with a plane and generate a polygonal cut surface. More...

#include <vtkHyperTreeGridPlaneCutter.h>

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

## Public Types

typedef vtkHyperTreeGridAlgorithm Superclass

Public Types inherited from vtkHyperTreeGridAlgorithm
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

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

vtkHyperTreeGridPlaneCutterNewInstance () const

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

void SetPlane (double a, double b, double c, double d)
Specify the plane with its [a,b,c,d] Cartesian coefficients: a*x + b*y + c*z = d.

virtual double * GetPlane ()
Specify the plane with its [a,b,c,d] Cartesian coefficients: a*x + b*y + c*z = d.

virtual void GetPlane (double &, double &, double &, double &)
Specify the plane with its [a,b,c,d] Cartesian coefficients: a*x + b*y + c*z = d.

virtual void GetPlane (double[4])
Specify the plane with its [a,b,c,d] Cartesian coefficients: a*x + b*y + c*z = d.

virtual int GetAxisAlignment ()
Returns 0 if plane's normal is aligned with X axis, 1 if it is aligned with Y axis, 2 if it is aligned with Z axis.

bool IsPlaneOrthogonalToXAxis ()
Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

bool IsPlaneOrthogonalToYAxis ()
Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

bool IsPlaneOrthogonalToZAxis ()
Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

virtual void SetDual (int)
Set/Get whether output mesh should be computed on dual grid.

virtual int GetDual ()
Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

virtual void DualOn ()
Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

virtual void DualOff ()
Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

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

vtkHyperTreeGridAlgorithmNewInstance () const

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

vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
See vtkAlgorithm for details.

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

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

virtual void SetOutput (vtkDataObject *)
Get the output data object for a port on this algorithm.

vtkHyperTreeGridGetHyperTreeGridOutput ()
Get the output as a hyper tree grid.

vtkHyperTreeGridGetHyperTreeGridOutput (int)
Get the output as a hyper tree grid.

vtkPolyDataGetPolyDataOutput ()
Get the output as a polygonal dataset.

vtkPolyDataGetPolyDataOutput (int)
Get the output as a polygonal dataset.

vtkUnstructuredGridGetUnstructuredGridOutput ()
Get the output as an unstructured grid.

vtkUnstructuredGridGetUnstructuredGridOutput (int)
Get the output as an unstructured grid.

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

void SetInputData (int, vtkDataObject *)
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.

## Static Public Member Functions

static vtkHyperTreeGridPlaneCutterNew ()

static vtkTypeBool IsTypeOf (const char *type)

static vtkHyperTreeGridPlaneCutterSafeDownCast (vtkObjectBase *o)

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

static vtkHyperTreeGridAlgorithmSafeDownCast (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.

## Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const

vtkHyperTreeGridPlaneCutter ()

~vtkHyperTreeGridPlaneCutter () override

virtual void Reset ()
Resets every attributes to a minimal state needed for the algorithm to execute.

int FillOutputPortInformation (int, vtkInformation *) override
For this algorithm the output is a vtkPolyData instance.

int ProcessTrees (vtkHyperTreeGrid *, vtkDataObject *) override
Top-level routine to generate plane cut.

void RecursivelyProcessTreePrimal (vtkHyperTreeGridNonOrientedGeometryCursor *)
Recursively descend into tree down to leaves, cutting primal cells.

bool RecursivelyPreProcessTree (vtkHyperTreeGridNonOrientedGeometryCursor *)
Recursively decide whether cell is intersected by plane.

void RecursivelyProcessTreeDual (vtkHyperTreeGridNonOrientedMooreSuperCursor *)
Recursively descend into tree down to leaves, cutting dual cells.

bool CheckIntersection (double[8][3], double[8])
Check if a cursor is intersected by a plane.

bool CheckIntersection (double[8][3])

void PlaneCut (int, int, double[8][3], int &, double[][3])
Compute the intersection between an edge and a plane.

void ReorderCutPoints (int, double[][3])
Reorder cut points following the perimeter of the cut.

Protected Member Functions inherited from vtkHyperTreeGridAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const

vtkHyperTreeGridAlgorithm ()

~vtkHyperTreeGridAlgorithm () override

int RequestDataObject (vtkInformation *, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
see vtkAlgorithm for details

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

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

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

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

virtual int ProcessTrees (vtkHyperTreeGrid *, vtkDataObject *)=0
Main routine to process individual trees in the grid This is pure virtual method to be implemented by concrete algorithms.

int FillInputPortInformation (int, vtkInformation *) override
Define default input and output port types.

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

double Plane [4]
Storage for the plane cutter parameters.

int Dual
Decide whether output mesh should be a computed on dual grid.

vtkBitArraySelectedCells
Storage for pre-selected cells to be processed in dual mode.

vtkPointsPoints
Storage for points of output unstructured mesh.

vtkCellArrayCells
Storage for cells of output unstructured mesh.

vtkIdListLeaves
Storage for dual vertex indices.

vtkPointsCenters
Storage for dual vertices at center of primal cells.

vtkCutterCutter
Cutter to be used on dual cells.

int AxisAlignment
Flag computed at plane creation to know whether it is aligned with x, y or z axis.

Protected Attributes inherited from vtkHyperTreeGridAlgorithm
vtkDataSetAttributesInData
Reference to input and output data.

vtkDataSetAttributesOutData
Reference to input and output data.

bool AppropriateOutput
If set, the output object will have the same type as the input object.

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

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

cut an hyper tree grid volume with a plane and generate a polygonal cut surface.

vtkHyperTreeGridPlaneCutter is a filter that takes as input an hyper tree grid and a single plane and generates the polygonal data intersection surface. This cut is computed at the leaf cells of the hyper tree. It is left as an option to decide whether the cut should be computed over the original AMR mesh or over its dual; in the latter case, perfect connectivity (i.e., mesh conformity in the FE sense) is achieved at the cost of interpolation to the dual of the input AMR mesh, and therefore of missing intersection plane pieces near the primal boundary.

vtkHyperTreeGrid vtkHyperTreeGridAlgorithm
Thanks:
This class was written by Philippe Pebay on a idea of Guenole Harel and Jacques-Bernard Lekien, 2016 This class was modified by Rogeli Grima Torres, 2016 This class was modified by Jacques-Bernard Lekien, 2018 This work was supported by Commissariat a l'Energie Atomique CEA, DAM, DIF, F-91297 Arpajon, France.
Tests:
vtkHyperTreeGridPlaneCutter (Tests)

Definition at line 45 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ Superclass

Definition at line 49 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ vtkHyperTreeGridPlaneCutter()

 vtkHyperTreeGridPlaneCutter::vtkHyperTreeGridPlaneCutter ( )
protected

## ◆ ~vtkHyperTreeGridPlaneCutter()

 vtkHyperTreeGridPlaneCutter::~vtkHyperTreeGridPlaneCutter ( )
overrideprotected

## ◆ New()

 static vtkHyperTreeGridPlaneCutter * vtkHyperTreeGridPlaneCutter::New ( )
static

## ◆ IsTypeOf()

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

## ◆ IsA()

 virtual vtkTypeBool vtkHyperTreeGridPlaneCutter::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 vtkHyperTreeGridAlgorithm.

## ◆ SafeDownCast()

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

## ◆ NewInstanceInternal()

 virtual vtkObjectBase * vtkHyperTreeGridPlaneCutter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkHyperTreeGridAlgorithm.

## ◆ NewInstance()

 vtkHyperTreeGridPlaneCutter * vtkHyperTreeGridPlaneCutter::NewInstance ( ) const

## ◆ PrintSelf()

 void vtkHyperTreeGridPlaneCutter::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 vtkHyperTreeGridAlgorithm.

## ◆ SetPlane()

 void vtkHyperTreeGridPlaneCutter::SetPlane ( double a, double b, double c, double d )

Specify the plane with its [a,b,c,d] Cartesian coefficients: a*x + b*y + c*z = d.

## ◆ GetPlane() [1/3]

 virtual double * vtkHyperTreeGridPlaneCutter::GetPlane ( )
virtual

Specify the plane with its [a,b,c,d] Cartesian coefficients: a*x + b*y + c*z = d.

## ◆ GetPlane() [2/3]

 virtual void vtkHyperTreeGridPlaneCutter::GetPlane ( double & , double & , double & , double & )
virtual

Specify the plane with its [a,b,c,d] Cartesian coefficients: a*x + b*y + c*z = d.

## ◆ GetPlane() [3/3]

 virtual void vtkHyperTreeGridPlaneCutter::GetPlane ( double [4] )
virtual

Specify the plane with its [a,b,c,d] Cartesian coefficients: a*x + b*y + c*z = d.

## ◆ GetAxisAlignment()

 virtual int vtkHyperTreeGridPlaneCutter::GetAxisAlignment ( )
virtual

Returns 0 if plane's normal is aligned with X axis, 1 if it is aligned with Y axis, 2 if it is aligned with Z axis.

Returns -1 if not aligned with any principal axis.

## ◆ IsPlaneOrthogonalToXAxis()

 bool vtkHyperTreeGridPlaneCutter::IsPlaneOrthogonalToXAxis ( )
inline

Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

Definition at line 73 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ IsPlaneOrthogonalToYAxis()

 bool vtkHyperTreeGridPlaneCutter::IsPlaneOrthogonalToYAxis ( )
inline

Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

Definition at line 74 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ IsPlaneOrthogonalToZAxis()

 bool vtkHyperTreeGridPlaneCutter::IsPlaneOrthogonalToZAxis ( )
inline

Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

Definition at line 75 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ SetDual()

 virtual void vtkHyperTreeGridPlaneCutter::SetDual ( int )
virtual

Set/Get whether output mesh should be computed on dual grid.

## ◆ GetDual()

 virtual int vtkHyperTreeGridPlaneCutter::GetDual ( )
virtual

Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

## ◆ DualOn()

 virtual void vtkHyperTreeGridPlaneCutter::DualOn ( )
virtual

Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

## ◆ DualOff()

 virtual void vtkHyperTreeGridPlaneCutter::DualOff ( )
virtual

Returns true if plane's normal is aligned with the corresponding axis, false elsewise.

## ◆ Reset()

 virtual void vtkHyperTreeGridPlaneCutter::Reset ( )
protectedvirtual

Resets every attributes to a minimal state needed for the algorithm to execute.

## ◆ FillOutputPortInformation()

 int vtkHyperTreeGridPlaneCutter::FillOutputPortInformation ( int , vtkInformation * )
overrideprotectedvirtual

For this algorithm the output is a vtkPolyData instance.

Reimplemented from vtkHyperTreeGridAlgorithm.

## ◆ ProcessTrees()

 int vtkHyperTreeGridPlaneCutter::ProcessTrees ( vtkHyperTreeGrid * , vtkDataObject * )
overrideprotectedvirtual

Top-level routine to generate plane cut.

Implements vtkHyperTreeGridAlgorithm.

## ◆ RecursivelyProcessTreePrimal()

 void vtkHyperTreeGridPlaneCutter::RecursivelyProcessTreePrimal ( vtkHyperTreeGridNonOrientedGeometryCursor * )
protected

Recursively descend into tree down to leaves, cutting primal cells.

## ◆ RecursivelyPreProcessTree()

 bool vtkHyperTreeGridPlaneCutter::RecursivelyPreProcessTree ( vtkHyperTreeGridNonOrientedGeometryCursor * )
protected

Recursively decide whether cell is intersected by plane.

## ◆ RecursivelyProcessTreeDual()

 void vtkHyperTreeGridPlaneCutter::RecursivelyProcessTreeDual ( vtkHyperTreeGridNonOrientedMooreSuperCursor * )
protected

Recursively descend into tree down to leaves, cutting dual cells.

## ◆ CheckIntersection() [1/2]

 bool vtkHyperTreeGridPlaneCutter::CheckIntersection ( double [8][3], double [8] )
protected

Check if a cursor is intersected by a plane.

## ◆ CheckIntersection() [2/2]

 bool vtkHyperTreeGridPlaneCutter::CheckIntersection ( double [8][3] )
protected

## ◆ PlaneCut()

 void vtkHyperTreeGridPlaneCutter::PlaneCut ( int , int , double [8][3], int & , double [][3] )
protected

Compute the intersection between an edge and a plane.

## ◆ ReorderCutPoints()

 void vtkHyperTreeGridPlaneCutter::ReorderCutPoints ( int , double [][3] )
protected

Reorder cut points following the perimeter of the cut.

## ◆ Plane

 double vtkHyperTreeGridPlaneCutter::Plane[4]
protected

Storage for the plane cutter parameters.

Definition at line 143 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ Dual

 int vtkHyperTreeGridPlaneCutter::Dual
protected

Decide whether output mesh should be a computed on dual grid.

Definition at line 148 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ SelectedCells

 vtkBitArray* vtkHyperTreeGridPlaneCutter::SelectedCells
protected

Storage for pre-selected cells to be processed in dual mode.

Definition at line 153 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ Points

 vtkPoints* vtkHyperTreeGridPlaneCutter::Points
protected

Storage for points of output unstructured mesh.

Definition at line 158 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ Cells

 vtkCellArray* vtkHyperTreeGridPlaneCutter::Cells
protected

Storage for cells of output unstructured mesh.

Definition at line 163 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ Leaves

 vtkIdList* vtkHyperTreeGridPlaneCutter::Leaves
protected

Storage for dual vertex indices.

Definition at line 168 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ Centers

 vtkPoints* vtkHyperTreeGridPlaneCutter::Centers
protected

Storage for dual vertices at center of primal cells.

Definition at line 173 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ Cutter

 vtkCutter* vtkHyperTreeGridPlaneCutter::Cutter
protected

Cutter to be used on dual cells.

Definition at line 178 of file vtkHyperTreeGridPlaneCutter.h.

protected

Definition at line 183 of file vtkHyperTreeGridPlaneCutter.h.

## ◆ AxisAlignment

 int vtkHyperTreeGridPlaneCutter::AxisAlignment
protected

Flag computed at plane creation to know whether it is aligned with x, y or z axis.

Definition at line 188 of file vtkHyperTreeGridPlaneCutter.h.

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