VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkClipHyperOctree Class Reference

clip an hyperoctree with user-specified implicit function or input scalar data More...

#include <vtkClipHyperOctree.h>

Inherits vtkUnstructuredGridAlgorithm.

Collaboration diagram for vtkClipHyperOctree:
[legend]

Public Types

typedef
vtkUnstructuredGridAlgorithm 
Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkClipHyperOctreeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkUnstructuredGrid * GetClippedOutput ()
 
void CreateDefaultLocator ()
 
unsigned long GetMTime ()
 
virtual void SetValue (double)
 
virtual double GetValue ()
 
virtual void SetInsideOut (int)
 
virtual int GetInsideOut ()
 
virtual void InsideOutOn ()
 
virtual void InsideOutOff ()
 
virtual void SetClipFunction (vtkImplicitFunction *)
 
virtual vtkImplicitFunction * GetClipFunction ()
 
virtual void SetGenerateClipScalars (int)
 
virtual int GetGenerateClipScalars ()
 
virtual void GenerateClipScalarsOn ()
 
virtual void GenerateClipScalarsOff ()
 
virtual void SetGenerateClippedOutput (int)
 
virtual int GetGenerateClippedOutput ()
 
virtual void GenerateClippedOutputOn ()
 
virtual void GenerateClippedOutputOff ()
 
void SetLocator (vtkIncrementalPointLocator *locator)
 
virtual
vtkIncrementalPointLocator * 
GetLocator ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkClipHyperOctreeSafeDownCast (vtkObjectBase *o)
 
static vtkClipHyperOctreeNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkClipHyperOctree (vtkImplicitFunction *cf=NULL)
 
 ~vtkClipHyperOctree ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
void ClipNode (vtkHyperOctreeCursor *cursor, int level, double bounds[6])
 

Protected Attributes

vtkImplicitFunction * ClipFunction
 
vtkIncrementalPointLocator * Locator
 
vtkIncrementalPointLocator * Locator2
 
int InsideOut
 
double Value
 
int GenerateClipScalars
 
int GenerateClippedOutput
 
vtkHyperOctree * Input
 
vtkUnstructuredGrid * Output
 
vtkUnstructuredGrid * ClippedOutput
 
vtkUnsignedCharArray * Types [2]
 
vtkIdTypeArray * Locs [2]
 
vtkCellArray * Conn [2]
 
vtkCellData * InCD
 
vtkCellData * OutCD [2]
 
vtkPointData * OutPD [2]
 
vtkOrderedTriangulator * Triangulator
 
vtkHyperOctreeCursor * Sibling
 
vtkDoubleArray * CellScalars
 
vtkTetra * Tetra
 
vtkDoubleArray * TetScalars
 
vtkPoints * Pts
 
vtkPolygon * Polygon
 
vtkIdType CellTypeCounter [65536]
 
vtkIdType TotalCounter
 
vtkIdType TemplateCounter
 
vtkHyperOctreeClipCutPointsGrabberGrabber
 

Detailed Description

clip an hyperoctree with user-specified implicit function or input scalar data

vtkClipHyperOctree is a filter that clips an hyperoctree using either any subclass of vtkImplicitFunction, or the input scalar data. Clipping means that it actually "cuts" through the leaves (cells) of the hyperoctree, returning everything inside of the specified implicit function (or greater than the scalar value) including "pieces" of a cell. (Compare this with vtkExtractGeometry, which pulls out entire, uncut cells.) The output of this filter is an unstructured grid.

To use this filter, you must decide if you will be clipping with an implicit function, or whether you will be using the input scalar data. If you want to clip with an implicit function, you must: 1) define an implicit function 2) set it with the SetClipFunction method 3) apply the GenerateClipScalarsOn method If a ClipFunction is not specified, or GenerateClipScalars is off (the default), then the input's scalar data will be used to clip the polydata.

You can also specify a scalar value, which is used to decide what is inside and outside of the implicit function. You can also reverse the sense of what inside/outside is by setting the InsideOut instance variable. (The clipping algorithm proceeds by computing an implicit function value or using the input scalar data for each point in the dataset. This is compared to the scalar value to determine inside/outside.)

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.

Warning
vtkClipHyperOctree will triangulate all types of 3D cells (i.e., create tetrahedra). This is true even if the cell is not actually cut. This is necessary to preserve compatibility across face neighbors. 2D cells will only be triangulated if the cutting function passes through them.
See Also
vtkImplicitFunction vtkCutter vtkClipVolume vtkClipPolyData
Tests:
vtkClipHyperOctree (Tests)

Definition at line 84 of file vtkClipHyperOctree.h.

Member Typedef Documentation

typedef vtkUnstructuredGridAlgorithm vtkClipHyperOctree::Superclass

Definition at line 87 of file vtkClipHyperOctree.h.

Constructor & Destructor Documentation

vtkClipHyperOctree::vtkClipHyperOctree ( vtkImplicitFunction *  cf = NULL)
protected
vtkClipHyperOctree::~vtkClipHyperOctree ( )
protected

Member Function Documentation

static int vtkClipHyperOctree::IsTypeOf ( const char *  type)
static
virtual int vtkClipHyperOctree::IsA ( const char *  type)
virtual
static vtkClipHyperOctree* vtkClipHyperOctree::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkClipHyperOctree::NewInstanceInternal ( ) const
protectedvirtual
vtkClipHyperOctree* vtkClipHyperOctree::NewInstance ( ) const
void vtkClipHyperOctree::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkClipHyperOctree* vtkClipHyperOctree::New ( )
static

Construct with user-specified implicit function; InsideOut turned off; value set to 0.0; and generate clip scalars turned off.

virtual void vtkClipHyperOctree::SetValue ( double  )
virtual

Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.

virtual double vtkClipHyperOctree::GetValue ( )
virtual

Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars). The default value is 0.0.

virtual void vtkClipHyperOctree::SetInsideOut ( int  )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual int vtkClipHyperOctree::GetInsideOut ( )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkClipHyperOctree::InsideOutOn ( )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkClipHyperOctree::InsideOutOff ( )
virtual

Set/Get the InsideOut flag. When off, a vertex is considered inside the implicit function if its value is greater than the Value ivar. When InsideOutside is turned on, a vertex is considered inside the implicit function if its implicit function value is less than or equal to the Value ivar. InsideOut is off by default.

virtual void vtkClipHyperOctree::SetClipFunction ( vtkImplicitFunction *  )
virtual

Specify the implicit function with which to perform the clipping. If you do not define an implicit function, then the selected input scalar data will be used for clipping.

virtual vtkImplicitFunction* vtkClipHyperOctree::GetClipFunction ( )
virtual

Specify the implicit function with which to perform the clipping. If you do not define an implicit function, then the selected input scalar data will be used for clipping.

virtual void vtkClipHyperOctree::SetGenerateClipScalars ( int  )
virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual int vtkClipHyperOctree::GetGenerateClipScalars ( )
virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipHyperOctree::GenerateClipScalarsOn ( )
virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipHyperOctree::GenerateClipScalarsOff ( )
virtual

If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data. If you enable this flag but do not provide an implicit function an error will be reported.

virtual void vtkClipHyperOctree::SetGenerateClippedOutput ( int  )
virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual int vtkClipHyperOctree::GetGenerateClippedOutput ( )
virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual void vtkClipHyperOctree::GenerateClippedOutputOn ( )
virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

virtual void vtkClipHyperOctree::GenerateClippedOutputOff ( )
virtual

Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.

vtkUnstructuredGrid* vtkClipHyperOctree::GetClippedOutput ( )

Return the Clipped output.

void vtkClipHyperOctree::SetLocator ( vtkIncrementalPointLocator *  locator)

Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.

virtual vtkIncrementalPointLocator* vtkClipHyperOctree::GetLocator ( )
virtual

Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.

void vtkClipHyperOctree::CreateDefaultLocator ( )

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

unsigned long vtkClipHyperOctree::GetMTime ( )

Return the mtime also considering the locator and clip function.

virtual int vtkClipHyperOctree::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
void vtkClipHyperOctree::ClipNode ( vtkHyperOctreeCursor *  cursor,
int  level,
double  bounds[6] 
)
protected

Clip the sub-hierarchy pointed by cursor.

Precondition
cursor_exists: cursor!=0
positive_level: level>=0
virtual int vtkClipHyperOctree::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

Member Data Documentation

vtkImplicitFunction* vtkClipHyperOctree::ClipFunction
protected

Definition at line 171 of file vtkClipHyperOctree.h.

vtkIncrementalPointLocator* vtkClipHyperOctree::Locator
protected

Definition at line 173 of file vtkClipHyperOctree.h.

vtkIncrementalPointLocator* vtkClipHyperOctree::Locator2
protected

Definition at line 174 of file vtkClipHyperOctree.h.

int vtkClipHyperOctree::InsideOut
protected

Definition at line 176 of file vtkClipHyperOctree.h.

double vtkClipHyperOctree::Value
protected

Definition at line 177 of file vtkClipHyperOctree.h.

int vtkClipHyperOctree::GenerateClipScalars
protected

Definition at line 178 of file vtkClipHyperOctree.h.

int vtkClipHyperOctree::GenerateClippedOutput
protected

Definition at line 180 of file vtkClipHyperOctree.h.

vtkHyperOctree* vtkClipHyperOctree::Input
protected

Definition at line 182 of file vtkClipHyperOctree.h.

vtkUnstructuredGrid* vtkClipHyperOctree::Output
protected

Definition at line 183 of file vtkClipHyperOctree.h.

vtkUnstructuredGrid* vtkClipHyperOctree::ClippedOutput
protected

Definition at line 184 of file vtkClipHyperOctree.h.

vtkUnsignedCharArray* vtkClipHyperOctree::Types[2]
protected

Definition at line 186 of file vtkClipHyperOctree.h.

vtkIdTypeArray* vtkClipHyperOctree::Locs[2]
protected

Definition at line 187 of file vtkClipHyperOctree.h.

vtkCellArray* vtkClipHyperOctree::Conn[2]
protected

Definition at line 188 of file vtkClipHyperOctree.h.

vtkCellData* vtkClipHyperOctree::InCD
protected

Definition at line 189 of file vtkClipHyperOctree.h.

vtkCellData* vtkClipHyperOctree::OutCD[2]
protected

Definition at line 190 of file vtkClipHyperOctree.h.

vtkPointData* vtkClipHyperOctree::OutPD[2]
protected

Definition at line 191 of file vtkClipHyperOctree.h.

vtkOrderedTriangulator* vtkClipHyperOctree::Triangulator
protected

Definition at line 192 of file vtkClipHyperOctree.h.

vtkHyperOctreeCursor* vtkClipHyperOctree::Sibling
protected

Definition at line 194 of file vtkClipHyperOctree.h.

vtkDoubleArray* vtkClipHyperOctree::CellScalars
protected

Definition at line 196 of file vtkClipHyperOctree.h.

vtkTetra* vtkClipHyperOctree::Tetra
protected

Definition at line 197 of file vtkClipHyperOctree.h.

vtkDoubleArray* vtkClipHyperOctree::TetScalars
protected

Definition at line 198 of file vtkClipHyperOctree.h.

vtkPoints* vtkClipHyperOctree::Pts
protected

Definition at line 200 of file vtkClipHyperOctree.h.

vtkPolygon* vtkClipHyperOctree::Polygon
protected

Definition at line 201 of file vtkClipHyperOctree.h.

vtkIdType vtkClipHyperOctree::CellTypeCounter[65536]
protected

Definition at line 203 of file vtkClipHyperOctree.h.

vtkIdType vtkClipHyperOctree::TotalCounter
protected

Definition at line 204 of file vtkClipHyperOctree.h.

vtkIdType vtkClipHyperOctree::TemplateCounter
protected

Definition at line 205 of file vtkClipHyperOctree.h.

vtkHyperOctreeClipCutPointsGrabber* vtkClipHyperOctree::Grabber
protected

Definition at line 208 of file vtkClipHyperOctree.h.


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