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

clip an unstructured grid More...

#include <vtkBoxClipDataSet.h>

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

Public Types

typedef vtkUnstructuredGridAlgorithm Superclass
 
- Public Types inherited from vtkUnstructuredGridAlgorithm
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 int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkBoxClipDataSetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void CreateDefaultLocator ()
 Create default locator. More...
 
vtkMTimeType GetMTime () override
 Return the mtime also considering the locator. More...
 
void MinEdgeF (const unsigned int *id_v, const vtkIdType *cellIds, unsigned int *edgF)
 
void PyramidToTetra (const vtkIdType *pyramId, const vtkIdType *cellIds, vtkCellArray *newCellArray)
 
void WedgeToTetra (const vtkIdType *wedgeId, const vtkIdType *cellIds, vtkCellArray *newCellArray)
 
void CellGrid (vtkIdType typeobj, vtkIdType npts, const vtkIdType *cellIds, vtkCellArray *newCellArray)
 
void CreateTetra (vtkIdType npts, const vtkIdType *cellIds, vtkCellArray *newCellArray)
 
void ClipBox (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray *tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD)
 
void ClipHexahedron (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray *tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD)
 
void ClipBoxInOut (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray **tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD)
 
void ClipHexahedronInOut (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray **tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD)
 
void ClipBox2D (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray *tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD)
 
void ClipBoxInOut2D (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray **tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD)
 
void ClipHexahedron2D (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray *tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD)
 
void ClipHexahedronInOut2D (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray **tets, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD)
 
void ClipBox1D (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray *lines, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD)
 
void ClipBoxInOut1D (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray **lines, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD)
 
void ClipHexahedron1D (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray *lines, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD)
 
void ClipHexahedronInOut1D (vtkPoints *newPoints, vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray **lines, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD)
 
void ClipBox0D (vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD)
 
void ClipBoxInOut0D (vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray **verts, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD)
 
void ClipHexahedron0D (vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData *outCD)
 
void ClipHexahedronInOut0D (vtkGenericCell *cell, vtkIncrementalPointLocator *locator, vtkCellArray **verts, vtkPointData *inPD, vtkPointData *outPD, vtkCellData *inCD, vtkIdType cellId, vtkCellData **outCD)
 
void SetBoxClip (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
 Specify the Box with which to perform the clipping. More...
 
void SetBoxClip (const double *n0, const double *o0, const double *n1, const double *o1, const double *n2, const double *o2, const double *n3, const double *o3, const double *n4, const double *o4, const double *n5, const double *o5)
 Specify the Box with which to perform the clipping. More...
 
virtual void SetGenerateClipScalars (int)
 If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data. More...
 
virtual int GetGenerateClipScalars ()
 If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data. More...
 
virtual void GenerateClipScalarsOn ()
 If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data. More...
 
virtual void GenerateClipScalarsOff ()
 If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data. More...
 
virtual void SetGenerateClippedOutput (int)
 Control whether a second output is generated. More...
 
virtual int GetGenerateClippedOutput ()
 Control whether a second output is generated. More...
 
virtual void GenerateClippedOutputOn ()
 Control whether a second output is generated. More...
 
virtual void GenerateClippedOutputOff ()
 Control whether a second output is generated. More...
 
vtkUnstructuredGridGetClippedOutput ()
 Set the tolerance for merging clip intersection points that are near the vertices of cells. More...
 
virtual int GetNumberOfOutputs ()
 Set the tolerance for merging clip intersection points that are near the vertices of cells. More...
 
void SetLocator (vtkIncrementalPointLocator *locator)
 Specify a spatial locator for merging points. More...
 
virtual vtkIncrementalPointLocatorGetLocator ()
 Specify a spatial locator for merging points. More...
 
virtual unsigned int GetOrientation ()
 Tells if clipping happens with a box parallel with coordinate axis (0) or with an hexahedral box (1). More...
 
virtual void SetOrientation (unsigned int)
 Tells if clipping happens with a box parallel with coordinate axis (0) or with an hexahedral box (1). More...
 
- Public Member Functions inherited from vtkUnstructuredGridAlgorithm
vtkUnstructuredGridAlgorithmNewInstance () const
 
int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetInput ()
 
vtkUnstructuredGridGetUnstructuredGridInput (int port)
 
vtkUnstructuredGridGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkUnstructuredGridGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
virtual void SetOutput (vtkDataObject *d)
 Get the output data object for a port on this algorithm. 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
 
int 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...
 
int 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 UpdateProgress (double amount)
 Update the progress of the process object. 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 int 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 int 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]=0)
 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]=0)
 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...
 
int SetUpdateExtentToWholeExtent (int port)
 If the whole output extent is required, this method can be called to set the output update extent to the whole extent. More...
 
int SetUpdateExtentToWholeExtent ()
 Convenience function equivalent to SetUpdateExtentToWholeExtent(0) This method assumes that the whole extent is known (that UpdateInformation has been called). More...
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 Set the output update extent in terms of piece and ghost levels. More...
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 Convenience function equivalent to SetUpdateExtent(0, piece, numPieces, ghostLevel) More...
 
void SetUpdateExtent (int port, int extent[6])
 Set the output update extent for data objects that use 3D extents. More...
 
void SetUpdateExtent (int extent[6])
 Convenience function equivalent to SetUpdateExtent(0, extent) 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...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (int)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual int 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 void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 Set/Get the execution progress of a process object. 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 (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int 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...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (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...
 
- 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 ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. 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 int IsTypeOf (const char *type)
 
static vtkBoxClipDataSetSafeDownCast (vtkObjectBase *o)
 
static vtkBoxClipDataSetNew ()
 Constructor of the clipping box. More...
 
static void InterpolateEdge (vtkDataSetAttributes *attributes, vtkIdType toId, vtkIdType fromId1, vtkIdType fromId2, double t)
 
- Static Public Member Functions inherited from vtkUnstructuredGridAlgorithm
static vtkUnstructuredGridAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkUnstructuredGridAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int 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 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 (int 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 int 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkBoxClipDataSet ()
 
 ~vtkBoxClipDataSet () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkUnstructuredGridAlgorithm
 vtkUnstructuredGridAlgorithm ()
 
 ~vtkUnstructuredGridAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
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 assocition 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=NULL)
 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 ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkIncrementalPointLocatorLocator
 
int GenerateClipScalars
 
int GenerateClippedOutput
 
double BoundBoxClip [3][2]
 
unsigned int Orientation
 
double PlaneNormal [6][3]
 
double PlanePoint [6][3]
 
- Protected Attributes inherited from vtkAlgorithm
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
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

clip an unstructured grid

Clipping means that is actually 'cuts' through the cells of the dataset, returning tetrahedral cells inside of the box. The output of this filter is an unstructured grid.

This filter can be configured to compute a second output. The second output is the part of the cell that is clipped away. Set the GenerateClippedData boolean on if you wish to access this output data.

The vtkBoxClipDataSet will triangulate all types of 3D cells (i.e, create tetrahedra). This is necessary to preserve compatibility across face neighbors.

To use this filter,you can decide if you will be clipping with a box or a hexahedral box. 1) Set orientation if(SetOrientation(0)): box (parallel with coordinate axis) SetBoxClip(xmin,xmax,ymin,ymax,zmin,zmax) if(SetOrientation(1)): hexahedral box (Default) SetBoxClip(n[0],o[0],n[1],o[1],n[2],o[2],n[3],o[3],n[4],o[4],n[5],o[5]) PlaneNormal[] normal of each plane PlanePoint[] point on the plane 2) Apply the GenerateClipScalarsOn() 3) Execute clipping Update();

Tests:
vtkBoxClipDataSet (Tests)

Definition at line 68 of file vtkBoxClipDataSet.h.

Member Typedef Documentation

Definition at line 71 of file vtkBoxClipDataSet.h.

Constructor & Destructor Documentation

vtkBoxClipDataSet::vtkBoxClipDataSet ( )
protected
vtkBoxClipDataSet::~vtkBoxClipDataSet ( )
overrideprotected

Member Function Documentation

static int vtkBoxClipDataSet::IsTypeOf ( const char *  type)
static
virtual int vtkBoxClipDataSet::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 vtkUnstructuredGridAlgorithm.

static vtkBoxClipDataSet* vtkBoxClipDataSet::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkBoxClipDataSet::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkUnstructuredGridAlgorithm.

vtkBoxClipDataSet* vtkBoxClipDataSet::NewInstance ( ) const
void vtkBoxClipDataSet::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 vtkUnstructuredGridAlgorithm.

static vtkBoxClipDataSet* vtkBoxClipDataSet::New ( )
static

Constructor of the clipping box.

The initial box is (0,1,0,1,0,1). The hexahedral box and the parallel box parameters are set to match this box.

void vtkBoxClipDataSet::SetBoxClip ( double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
)

Specify the Box with which to perform the clipping.

If the box is not parallel to axis, you need to especify normal vector of each plane and a point on the plane.

void vtkBoxClipDataSet::SetBoxClip ( const double n0,
const double o0,
const double n1,
const double o1,
const double n2,
const double o2,
const double n3,
const double o3,
const double n4,
const double o4,
const double n5,
const double o5 
)

Specify the Box with which to perform the clipping.

If the box is not parallel to axis, you need to especify normal vector of each plane and a point on the plane.

virtual void vtkBoxClipDataSet::SetGenerateClipScalars ( int  )
virtual

If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data.

virtual int vtkBoxClipDataSet::GetGenerateClipScalars ( )
virtual

If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data.

virtual void vtkBoxClipDataSet::GenerateClipScalarsOn ( )
virtual

If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data.

virtual void vtkBoxClipDataSet::GenerateClipScalarsOff ( )
virtual

If this flag is enabled, then the output scalar values will be interpolated, and not the input scalar data.

virtual void vtkBoxClipDataSet::SetGenerateClippedOutput ( int  )
virtual

Control whether a second output is generated.

The second output contains the polygonal data that's been clipped away.

virtual int vtkBoxClipDataSet::GetGenerateClippedOutput ( )
virtual

Control whether a second output is generated.

The second output contains the polygonal data that's been clipped away.

virtual void vtkBoxClipDataSet::GenerateClippedOutputOn ( )
virtual

Control whether a second output is generated.

The second output contains the polygonal data that's been clipped away.

virtual void vtkBoxClipDataSet::GenerateClippedOutputOff ( )
virtual

Control whether a second output is generated.

The second output contains the polygonal data that's been clipped away.

vtkUnstructuredGrid* vtkBoxClipDataSet::GetClippedOutput ( )

Set the tolerance for merging clip intersection points that are near the vertices of cells.

This tolerance is used to prevent the generation of degenerate primitives. Note that only 3D cells actually use this instance variable. vtkSetClampMacro(MergeTolerance,double,0.0001,0.25); vtkGetMacro(MergeTolerance,double); Return the Clipped output.

virtual int vtkBoxClipDataSet::GetNumberOfOutputs ( )
virtual

Set the tolerance for merging clip intersection points that are near the vertices of cells.

This tolerance is used to prevent the generation of degenerate primitives. Note that only 3D cells actually use this instance variable. vtkSetClampMacro(MergeTolerance,double,0.0001,0.25); vtkGetMacro(MergeTolerance,double); Return the Clipped output.

void vtkBoxClipDataSet::SetLocator ( vtkIncrementalPointLocator locator)

Specify a spatial locator for merging points.

By default, an instance of vtkMergePoints is used.

virtual vtkIncrementalPointLocator* vtkBoxClipDataSet::GetLocator ( )
virtual

Specify a spatial locator for merging points.

By default, an instance of vtkMergePoints is used.

void vtkBoxClipDataSet::CreateDefaultLocator ( )

Create default locator.

Used to create one when none is specified. The locator is used to merge coincident points.

vtkMTimeType vtkBoxClipDataSet::GetMTime ( )
overridevirtual

Return the mtime also considering the locator.

Reimplemented from vtkObject.

virtual unsigned int vtkBoxClipDataSet::GetOrientation ( )
virtual

Tells if clipping happens with a box parallel with coordinate axis (0) or with an hexahedral box (1).

Initial value is 1.

virtual void vtkBoxClipDataSet::SetOrientation ( unsigned  int)
virtual

Tells if clipping happens with a box parallel with coordinate axis (0) or with an hexahedral box (1).

Initial value is 1.

static void vtkBoxClipDataSet::InterpolateEdge ( vtkDataSetAttributes attributes,
vtkIdType  toId,
vtkIdType  fromId1,
vtkIdType  fromId2,
double  t 
)
static
void vtkBoxClipDataSet::MinEdgeF ( const unsigned int id_v,
const vtkIdType cellIds,
unsigned int edgF 
)
void vtkBoxClipDataSet::PyramidToTetra ( const vtkIdType pyramId,
const vtkIdType cellIds,
vtkCellArray newCellArray 
)
void vtkBoxClipDataSet::WedgeToTetra ( const vtkIdType wedgeId,
const vtkIdType cellIds,
vtkCellArray newCellArray 
)
void vtkBoxClipDataSet::CellGrid ( vtkIdType  typeobj,
vtkIdType  npts,
const vtkIdType cellIds,
vtkCellArray newCellArray 
)
void vtkBoxClipDataSet::CreateTetra ( vtkIdType  npts,
const vtkIdType cellIds,
vtkCellArray newCellArray 
)
void vtkBoxClipDataSet::ClipBox ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray tets,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData outCD 
)
void vtkBoxClipDataSet::ClipHexahedron ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray tets,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData outCD 
)
void vtkBoxClipDataSet::ClipBoxInOut ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray **  tets,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData **  outCD 
)
void vtkBoxClipDataSet::ClipHexahedronInOut ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray **  tets,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData **  outCD 
)
void vtkBoxClipDataSet::ClipBox2D ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray tets,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData outCD 
)
void vtkBoxClipDataSet::ClipBoxInOut2D ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray **  tets,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData **  outCD 
)
void vtkBoxClipDataSet::ClipHexahedron2D ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray tets,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData outCD 
)
void vtkBoxClipDataSet::ClipHexahedronInOut2D ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray **  tets,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData **  outCD 
)
void vtkBoxClipDataSet::ClipBox1D ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray lines,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData outCD 
)
void vtkBoxClipDataSet::ClipBoxInOut1D ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray **  lines,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData **  outCD 
)
void vtkBoxClipDataSet::ClipHexahedron1D ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray lines,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData outCD 
)
void vtkBoxClipDataSet::ClipHexahedronInOut1D ( vtkPoints newPoints,
vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray **  lines,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData **  outCD 
)
void vtkBoxClipDataSet::ClipBox0D ( vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray verts,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData outCD 
)
void vtkBoxClipDataSet::ClipBoxInOut0D ( vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray **  verts,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData **  outCD 
)
void vtkBoxClipDataSet::ClipHexahedron0D ( vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray verts,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData outCD 
)
void vtkBoxClipDataSet::ClipHexahedronInOut0D ( vtkGenericCell cell,
vtkIncrementalPointLocator locator,
vtkCellArray **  verts,
vtkPointData inPD,
vtkPointData outPD,
vtkCellData inCD,
vtkIdType  cellId,
vtkCellData **  outCD 
)
int vtkBoxClipDataSet::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkUnstructuredGridAlgorithm.

int vtkBoxClipDataSet::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Fill the input port information objects for this algorithm.

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

Reimplemented from vtkUnstructuredGridAlgorithm.

Member Data Documentation

vtkIncrementalPointLocator* vtkBoxClipDataSet::Locator
protected

Definition at line 263 of file vtkBoxClipDataSet.h.

int vtkBoxClipDataSet::GenerateClipScalars
protected

Definition at line 264 of file vtkBoxClipDataSet.h.

int vtkBoxClipDataSet::GenerateClippedOutput
protected

Definition at line 266 of file vtkBoxClipDataSet.h.

double vtkBoxClipDataSet::BoundBoxClip[3][2]
protected

Definition at line 270 of file vtkBoxClipDataSet.h.

unsigned int vtkBoxClipDataSet::Orientation
protected

Definition at line 271 of file vtkBoxClipDataSet.h.

double vtkBoxClipDataSet::PlaneNormal[6][3]
protected

Definition at line 272 of file vtkBoxClipDataSet.h.

double vtkBoxClipDataSet::PlanePoint[6][3]
protected

Definition at line 273 of file vtkBoxClipDataSet.h.


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