VTK  9.3.20240329
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkHyperTreeGridAxisClip Class Reference

Axis aligned hyper tree grid clip. More...

#include <vtkHyperTreeGridAxisClip.h>

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

Public Types

enum  ClipType { PLANE = 0 , BOX , QUADRIC }
 Methods by which the hyper tree grid input may be clipped: PLANE: Clip with an axis-aligned plane defined by normal and intercept. More...
 
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. More...
 
vtkHyperTreeGridAxisClipNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkMTimeType GetMTime () override
 Override GetMTime because we delegate to a vtkQuadric. More...
 
virtual void SetClipType (int)
 Set/get type of clip. More...
 
virtual int GetClipType ()
 Set/get type of clip. More...
 
void SetClipTypeToPlane ()
 Set/get type of clip. More...
 
void SetClipTypeToBox ()
 Set/get type of clip. More...
 
void SetClipTypeToQuadric ()
 Set/get type of clip. More...
 
virtual void SetPlaneNormalAxis (int)
 Set/get normal axis of clipping plane: 0=X, 1=Y, 2=Z. More...
 
virtual int GetPlaneNormalAxis ()
 Set/get normal axis of clipping plane: 0=X, 1=Y, 2=Z. More...
 
virtual void SetPlanePosition (double)
 Set/get position of clipping plane: intercept along normal axis. More...
 
virtual double GetPlanePosition ()
 Set/get position of clipping plane: intercept along normal axis. More...
 
virtual void SetBounds (double, double, double, double, double, double)
 Set/get bounds of clipping box. More...
 
virtual void SetBounds (double[6])
 Set/get bounds of clipping box. More...
 
virtual double * GetBounds ()
 Set/get bounds of clipping box. More...
 
virtual void GetBounds (double data[6])
 Set/get bounds of clipping box. More...
 
void GetMinimumBounds (double[3])
 Set/get bounds of clipping box. More...
 
void GetMaximumBounds (double[3])
 Set/get bounds of clipping box. More...
 
virtual void SetInsideOut (bool)
 Set/Get the InsideOut flag, in the case of clip by hyperplane. More...
 
virtual bool GetInsideOut ()
 Set/Get the InsideOut flag, in the case of clip by hyperplane. More...
 
virtual void InsideOutOn ()
 Set/Get the InsideOut flag, in the case of clip by hyperplane. More...
 
virtual void InsideOutOff ()
 Set/Get the InsideOut flag, in the case of clip by hyperplane. More...
 
virtual void SetQuadric (vtkQuadric *)
 Set/Get the clipping quadric function. More...
 
virtual vtkQuadricGetQuadric ()
 Set/Get the clipping quadric function. More...
 
void SetQuadricCoefficients (double a, double b, double c, double d, double e, double f, double g, double h, double i, double j)
 Helpers to set/get the 10 coefficients of the quadric function. More...
 
void SetQuadricCoefficients (double[10])
 Helpers to set/get the 10 coefficients of the quadric function. More...
 
void GetQuadricCoefficients (double[10])
 Helpers to set/get the 10 coefficients of the quadric function. More...
 
double * GetQuadricCoefficients ()
 Helpers to set/get the 10 coefficients of the quadric function. More...
 
- Public Member Functions inherited from vtkHyperTreeGridAlgorithm
vtkHyperTreeGridAlgorithmNewInstance () const
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 See vtkAlgorithm for details. More...
 
vtkDataObjectGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataObjectGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
virtual void SetOutput (vtkDataObject *)
 Get the output data object for a port on this algorithm. More...
 
vtkHyperTreeGridGetHyperTreeGridOutput ()
 Get the output as a hyper tree grid. More...
 
vtkHyperTreeGridGetHyperTreeGridOutput (int)
 Get the output as a hyper tree grid. More...
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as a polygonal dataset. More...
 
vtkPolyDataGetPolyDataOutput (int)
 Get the output as a polygonal dataset. More...
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as an unstructured grid. More...
 
vtkUnstructuredGridGetUnstructuredGridOutput (int)
 Get the output as an unstructured grid. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
bool CheckAbort ()
 Checks to see if this filter should abort. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
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). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual 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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
bool UsesGarbageCollector () const override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm. More...
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm. More...
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports. More...
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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. More...
 
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. More...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
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. More...
 
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. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
- 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...
 
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. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- 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...
 
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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkHyperTreeGridAxisClipNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHyperTreeGridAxisClipSafeDownCast (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. More...
 
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. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- 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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkHyperTreeGridAxisClip ()
 
 ~vtkHyperTreeGridAxisClip () override
 
int FillOutputPortInformation (int, vtkInformation *) override
 Define default input and output port types. More...
 
bool IsClipped (vtkHyperTreeGridNonOrientedGeometryCursor *)
 Decide whether the cell is clipped out. More...
 
int ProcessTrees (vtkHyperTreeGrid *, vtkDataObject *) override
 Main routine to generate hyper tree grid clip. More...
 
void RecursivelyProcessTree (vtkHyperTreeGridNonOrientedGeometryCursor *inCursor, vtkHyperTreeGridNonOrientedCursor *outCursor)
 Recursively descend into tree down to leaves. More...
 
- Protected Member Functions inherited from vtkHyperTreeGridAlgorithm
 vtkHyperTreeGridAlgorithm ()
 
 ~vtkHyperTreeGridAlgorithm () override
 
int RequestDataObject (vtkInformation *, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 see vtkAlgorithm for details More...
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
int FillInputPortInformation (int, vtkInformation *) override
 Define default input and output port types. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
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. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
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. More...
 
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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int ClipType
 Type of clip to be performed. More...
 
int PlaneNormalAxis
 Direction of clipping plane normal. More...
 
double PlanePosition
 Intercept of clipping plane along normal. More...
 
double PlanePositionRealUse
 
double Bounds [6]
 Bounds of axis-aligned clipping box. More...
 
vtkQuadricQuadric
 Coefficients of axis-aligned quadric. More...
 
bool InsideOut
 Decide what is inside versus what is out. More...
 
vtkBitArrayInMask
 Output material mask constructed by this filter. More...
 
vtkBitArrayOutMask
 
vtkIdType CurrentId
 Keep track of current index in output hyper tree grid. More...
 
- Protected Attributes inherited from vtkHyperTreeGridAlgorithm
vtkDataSetAttributesInData
 Reference to input and output data. More...
 
vtkDataSetAttributesOutData
 Reference to input and output data. More...
 
bool AppropriateOutput
 If set, the output object will have the same type as the input object. More...
 
- 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. More...
 
- 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
 

Additional Inherited Members

- 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

Axis aligned hyper tree grid clip.

Clip an hyper tree grid along an axis aligned plane or box and output a hyper tree grid with same dimensionality. This filter also allows for reversal of the direction of what is inside versus what is outside by setting the InsideOut instance variable.

See also
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 Jacques-Bernard Lekien, 2018 This work was supported by Commissariat a l'Energie Atomique CEA, DAM, DIF, F-91297 Arpajon, France.
Tests:
vtkHyperTreeGridAxisClip (Tests)

Definition at line 38 of file vtkHyperTreeGridAxisClip.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkHyperTreeGridAxisClip.h.

Member Enumeration Documentation

◆ ClipType

Methods by which the hyper tree grid input may be clipped: PLANE: Clip with an axis-aligned plane defined by normal and intercept.

BOX: Clip with an axis-aligned rectangular prism defined by its extremal coordinates. QUADRIC: Clip with an axis-aligned quadric defined by its coefficients.

Enumerator
PLANE 
BOX 
QUADRIC 

Definition at line 51 of file vtkHyperTreeGridAxisClip.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeGridAxisClip()

vtkHyperTreeGridAxisClip::vtkHyperTreeGridAxisClip ( )
protected

◆ ~vtkHyperTreeGridAxisClip()

vtkHyperTreeGridAxisClip::~vtkHyperTreeGridAxisClip ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkHyperTreeGridAxisClip* vtkHyperTreeGridAxisClip::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkHyperTreeGridAxisClip::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 vtkHyperTreeGridAxisClip* vtkHyperTreeGridAxisClip::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkHyperTreeGridAxisClip::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkHyperTreeGridAlgorithm.

◆ NewInstance()

vtkHyperTreeGridAxisClip* vtkHyperTreeGridAxisClip::NewInstance ( ) const

◆ PrintSelf()

void vtkHyperTreeGridAxisClip::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.

◆ SetClipType()

virtual void vtkHyperTreeGridAxisClip::SetClipType ( int  )
virtual

Set/get type of clip.

Default value is 0 (plane clip).

◆ GetClipType()

virtual int vtkHyperTreeGridAxisClip::GetClipType ( )
virtual

Set/get type of clip.

Default value is 0 (plane clip).

◆ SetClipTypeToPlane()

void vtkHyperTreeGridAxisClip::SetClipTypeToPlane ( )
inline

Set/get type of clip.

Default value is 0 (plane clip).

Definition at line 65 of file vtkHyperTreeGridAxisClip.h.

◆ SetClipTypeToBox()

void vtkHyperTreeGridAxisClip::SetClipTypeToBox ( )
inline

Set/get type of clip.

Default value is 0 (plane clip).

Definition at line 66 of file vtkHyperTreeGridAxisClip.h.

◆ SetClipTypeToQuadric()

void vtkHyperTreeGridAxisClip::SetClipTypeToQuadric ( )
inline

Set/get type of clip.

Default value is 0 (plane clip).

Definition at line 67 of file vtkHyperTreeGridAxisClip.h.

◆ SetPlaneNormalAxis()

virtual void vtkHyperTreeGridAxisClip::SetPlaneNormalAxis ( int  )
virtual

Set/get normal axis of clipping plane: 0=X, 1=Y, 2=Z.

Default value is 0 (X-axis normal).

◆ GetPlaneNormalAxis()

virtual int vtkHyperTreeGridAxisClip::GetPlaneNormalAxis ( )
virtual

Set/get normal axis of clipping plane: 0=X, 1=Y, 2=Z.

Default value is 0 (X-axis normal).

◆ SetPlanePosition()

virtual void vtkHyperTreeGridAxisClip::SetPlanePosition ( double  )
virtual

Set/get position of clipping plane: intercept along normal axis.

Default value is 0.0.

◆ GetPlanePosition()

virtual double vtkHyperTreeGridAxisClip::GetPlanePosition ( )
virtual

Set/get position of clipping plane: intercept along normal axis.

Default value is 0.0.

◆ SetBounds() [1/2]

virtual void vtkHyperTreeGridAxisClip::SetBounds ( double  ,
double  ,
double  ,
double  ,
double  ,
double   
)
virtual

Set/get bounds of clipping box.

◆ SetBounds() [2/2]

virtual void vtkHyperTreeGridAxisClip::SetBounds ( double  [6])
virtual

Set/get bounds of clipping box.

◆ GetBounds() [1/2]

virtual double* vtkHyperTreeGridAxisClip::GetBounds ( )
virtual

Set/get bounds of clipping box.

◆ GetBounds() [2/2]

virtual void vtkHyperTreeGridAxisClip::GetBounds ( double  data[6])
virtual

Set/get bounds of clipping box.

◆ GetMinimumBounds()

void vtkHyperTreeGridAxisClip::GetMinimumBounds ( double  [3])

Set/get bounds of clipping box.

◆ GetMaximumBounds()

void vtkHyperTreeGridAxisClip::GetMaximumBounds ( double  [3])

Set/get bounds of clipping box.

◆ SetInsideOut()

virtual void vtkHyperTreeGridAxisClip::SetInsideOut ( bool  )
virtual

Set/Get the InsideOut flag, in the case of clip by hyperplane.

When off, a cell is clipped out when its origin is above said plane intercept along the considered direction, inside otherwise. When on, a cell is clipped out when its origin + size is below said said plane intercept along the considered direction.

◆ GetInsideOut()

virtual bool vtkHyperTreeGridAxisClip::GetInsideOut ( )
virtual

Set/Get the InsideOut flag, in the case of clip by hyperplane.

When off, a cell is clipped out when its origin is above said plane intercept along the considered direction, inside otherwise. When on, a cell is clipped out when its origin + size is below said said plane intercept along the considered direction.

◆ InsideOutOn()

virtual void vtkHyperTreeGridAxisClip::InsideOutOn ( )
virtual

Set/Get the InsideOut flag, in the case of clip by hyperplane.

When off, a cell is clipped out when its origin is above said plane intercept along the considered direction, inside otherwise. When on, a cell is clipped out when its origin + size is below said said plane intercept along the considered direction.

◆ InsideOutOff()

virtual void vtkHyperTreeGridAxisClip::InsideOutOff ( )
virtual

Set/Get the InsideOut flag, in the case of clip by hyperplane.

When off, a cell is clipped out when its origin is above said plane intercept along the considered direction, inside otherwise. When on, a cell is clipped out when its origin + size is below said said plane intercept along the considered direction.

◆ SetQuadric()

virtual void vtkHyperTreeGridAxisClip::SetQuadric ( vtkQuadric )
virtual

Set/Get the clipping quadric function.

◆ GetQuadric()

virtual vtkQuadric* vtkHyperTreeGridAxisClip::GetQuadric ( )
virtual

Set/Get the clipping quadric function.

◆ SetQuadricCoefficients() [1/2]

void vtkHyperTreeGridAxisClip::SetQuadricCoefficients ( double  a,
double  b,
double  c,
double  d,
double  e,
double  f,
double  g,
double  h,
double  i,
double  j 
)
inline

Helpers to set/get the 10 coefficients of the quadric function.

Definition at line 123 of file vtkHyperTreeGridAxisClip.h.

◆ SetQuadricCoefficients() [2/2]

void vtkHyperTreeGridAxisClip::SetQuadricCoefficients ( double  [10])

Helpers to set/get the 10 coefficients of the quadric function.

◆ GetQuadricCoefficients() [1/2]

void vtkHyperTreeGridAxisClip::GetQuadricCoefficients ( double  [10])

Helpers to set/get the 10 coefficients of the quadric function.

◆ GetQuadricCoefficients() [2/2]

double* vtkHyperTreeGridAxisClip::GetQuadricCoefficients ( )

Helpers to set/get the 10 coefficients of the quadric function.

◆ GetMTime()

vtkMTimeType vtkHyperTreeGridAxisClip::GetMTime ( )
overridevirtual

Override GetMTime because we delegate to a vtkQuadric.

Reimplemented from vtkObject.

◆ FillOutputPortInformation()

int vtkHyperTreeGridAxisClip::FillOutputPortInformation ( int  ,
vtkInformation  
)
overrideprotectedvirtual

Define default input and output port types.

Reimplemented from vtkHyperTreeGridAlgorithm.

◆ IsClipped()

bool vtkHyperTreeGridAxisClip::IsClipped ( vtkHyperTreeGridNonOrientedGeometryCursor )
protected

Decide whether the cell is clipped out.

◆ ProcessTrees()

int vtkHyperTreeGridAxisClip::ProcessTrees ( vtkHyperTreeGrid ,
vtkDataObject  
)
overrideprotectedvirtual

Main routine to generate hyper tree grid clip.

Implements vtkHyperTreeGridAlgorithm.

◆ RecursivelyProcessTree()

void vtkHyperTreeGridAxisClip::RecursivelyProcessTree ( vtkHyperTreeGridNonOrientedGeometryCursor inCursor,
vtkHyperTreeGridNonOrientedCursor outCursor 
)
protected

Recursively descend into tree down to leaves.

Member Data Documentation

◆ ClipType

Type of clip to be performed.

Definition at line 165 of file vtkHyperTreeGridAxisClip.h.

◆ PlaneNormalAxis

int vtkHyperTreeGridAxisClip::PlaneNormalAxis
protected

Direction of clipping plane normal.

Definition at line 170 of file vtkHyperTreeGridAxisClip.h.

◆ PlanePosition

double vtkHyperTreeGridAxisClip::PlanePosition
protected

Intercept of clipping plane along normal.

Definition at line 175 of file vtkHyperTreeGridAxisClip.h.

◆ PlanePositionRealUse

double vtkHyperTreeGridAxisClip::PlanePositionRealUse
protected

Definition at line 176 of file vtkHyperTreeGridAxisClip.h.

◆ Bounds

double vtkHyperTreeGridAxisClip::Bounds[6]
protected

Bounds of axis-aligned clipping box.

Definition at line 181 of file vtkHyperTreeGridAxisClip.h.

◆ Quadric

vtkQuadric* vtkHyperTreeGridAxisClip::Quadric
protected

Coefficients of axis-aligned quadric.

Definition at line 186 of file vtkHyperTreeGridAxisClip.h.

◆ InsideOut

bool vtkHyperTreeGridAxisClip::InsideOut
protected

Decide what is inside versus what is out.

Definition at line 191 of file vtkHyperTreeGridAxisClip.h.

◆ InMask

vtkBitArray* vtkHyperTreeGridAxisClip::InMask
protected

Output material mask constructed by this filter.

Definition at line 196 of file vtkHyperTreeGridAxisClip.h.

◆ OutMask

vtkBitArray* vtkHyperTreeGridAxisClip::OutMask
protected

Definition at line 197 of file vtkHyperTreeGridAxisClip.h.

◆ CurrentId

vtkIdType vtkHyperTreeGridAxisClip::CurrentId
protected

Keep track of current index in output hyper tree grid.

Definition at line 202 of file vtkHyperTreeGridAxisClip.h.


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