vtk
Class vtkClipDataSet

java.lang.Object
  extended byvtk.vtkObjectBase
      extended byvtk.vtkObject
          extended byvtk.vtkProcessObject
              extended byvtk.vtkSource
                  extended byvtk.vtkUnstructuredGridSource
                      extended byvtk.vtkDataSetToUnstructuredGridFilter
                          extended byvtk.vtkClipDataSet
All Implemented Interfaces:
java.io.Serializable

public class vtkClipDataSet
extends vtkDataSetToUnstructuredGridFilter
implements java.io.Serializable

vtkClipDataSet - clip any dataset with user-specified implicit function or input scalar data. vtkClipDataSet is a filter that any type of dataset using either any subclass of vtkImplicitFunction, or the input scalar data. Clipping means that it actually "cuts" through the cells of the dataset, 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. JavaBean wrapper for vtkClipDataSet object.

Author:
vtk2jbean Automatic JavaBean wrapper for VTK.
See Also:
vtkImplicitFunction, vtkCutter, vtkClipVolume, Serialized Form

Field Summary
protected  java.beans.PropertyChangeSupport changes
           
 
Fields inherited from class vtk.vtkObjectBase
vtkId
 
Constructor Summary
  vtkClipDataSet()
           
protected vtkClipDataSet(int dmy)
           
 
Method Summary
 void createDefaultLocator()
          Create default locator.
 void generateClippedOutputOff()
          Control whether a second output is generated.
 void generateClippedOutputOn()
          Control whether a second output is generated.
 void generateClipScalarsOff()
          If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
 void generateClipScalarsOn()
          If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
 java.lang.String getClassName()
          Return the class name as a string.
 vtkImplicitFunction getClipFunction()
           
 vtkUnstructuredGrid getClippedOutput()
          Return the Clipped output.
 int getGenerateClippedOutput()
          Control whether a second output is generated.
 int getGenerateClipScalars()
          If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
 java.lang.String getInputScalarsSelection()
          If you want to clip by an arbitrary array, then set its name here.
 int getInsideOut()
          Set/Get the InsideOut flag.
 vtkPointLocator getLocator()
          Specify a spatial locator for merging points.
 double getMergeTolerance()
          Set the tolerance for merging clip intersection points that are near the vertices of cells.
 double getMergeToleranceMaxValue()
          Set the tolerance for merging clip intersection points that are near the vertices of cells.
 double getMergeToleranceMinValue()
          Set the tolerance for merging clip intersection points that are near the vertices of cells.
 int getMTime()
          Return the mtime also considering the locator and clip function.
 int getNumberOfOutputs()
          Return the Clipped output.
 vtkClipDataSet getThisClipDataSet()
           
 double getValue()
          Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars).
 void insideOutOff()
          Set/Get the InsideOut flag.
 void insideOutOn()
          Set/Get the InsideOut flag.
 int isA(java.lang.String id0)
          Return 1 if this class is the same type of (or a subclass of) the named class.
 void selectInputScalars(java.lang.String id0)
           
 void setClipFunction(vtkImplicitFunction id0)
           
 void setGenerateClippedOutput(int id0)
          Control whether a second output is generated.
 void setGenerateClipScalars(int id0)
          If this flag is enabled, then the output scalar values will be interpolated from the implicit function values, and not the input scalar data.
 void setInsideOut(int id0)
          Set/Get the InsideOut flag.
 void setLocator(vtkPointLocator id0)
          Specify a spatial locator for merging points.
 void setMergeTolerance(double id0)
          Set the tolerance for merging clip intersection points that are near the vertices of cells.
 void setValue(double id0)
          Set the clipping value of the implicit function (if clipping with implicit function) or scalar value (if clipping with scalars).
protected  void VTKCastInit()
           
 void VTKInit()
           
 
Methods inherited from class vtk.vtkDataSetToUnstructuredGridFilter
getInput, getThisDataSetToUnstructuredGridFilter, setInput
 
Methods inherited from class vtk.vtkUnstructuredGridSource
getOutput, getOutput, getThisUnstructuredGridSource, setOutput
 
Methods inherited from class vtk.vtkSource
computeInputUpdateExtents, getOutputIndex, getReleaseDataFlag, getThisSource, inRegisterLoop, propagateUpdateExtent, releaseDataFlagOff, releaseDataFlagOn, setReleaseDataFlag, triggerAsynchronousUpdate, unRegister, unRegisterAllOutputs, update, updateData, updateInformation, updateWholeExtent
 
Methods inherited from class vtk.vtkProcessObject
abortExecuteOff, abortExecuteOn, getAbortExecute, getErrorCode, getNumberOfInputs, getProgress, getProgressMaxValue, getProgressMinValue, getProgressText, getThisProcessObject, removeAllInputs, setAbortExecute, setProgress, setProgressText, squeezeInputArray, updateProgress
 
Methods inherited from class vtk.vtkObject
AddObserver, breakOnError, debugOff, debugOn, getDebug, getGlobalWarningDisplay, getThisObject, globalWarningDisplayOff, globalWarningDisplayOn, hasObserver, hasObserver, invokeEvent, invokeEvent, modified, Print, PrintRevisions, register, removeObserver, removeObservers, removeObservers, setDebug, setGlobalWarningDisplay
 
Methods inherited from class vtk.vtkObjectBase
addPropertyChangeListener, finalize, getReferenceCount, getThisObjectBase, isTypeOf, removePropertyChangeListener, setReferenceCount, VTKDelete
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

changes

protected java.beans.PropertyChangeSupport changes
Constructor Detail

vtkClipDataSet

public vtkClipDataSet()

vtkClipDataSet

protected vtkClipDataSet(int dmy)
Method Detail

getThisClipDataSet

public vtkClipDataSet getThisClipDataSet()

getClassName

public java.lang.String getClassName()
Description copied from class: vtkObjectBase
Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:
getClassName in class vtkDataSetToUnstructuredGridFilter

isA

public int isA(java.lang.String id0)
Description copied from class: vtkObjectBase
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 vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:
isA in class vtkDataSetToUnstructuredGridFilter

setValue

public void setValue(double id0)
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.


getValue

public double getValue()
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.


setInsideOut

public void setInsideOut(int id0)
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.


getInsideOut

public int getInsideOut()
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.


insideOutOn

public void insideOutOn()
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.


insideOutOff

public void insideOutOff()
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.


setClipFunction

public void setClipFunction(vtkImplicitFunction id0)

getClipFunction

public vtkImplicitFunction getClipFunction()

setGenerateClipScalars

public void setGenerateClipScalars(int id0)
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.


getGenerateClipScalars

public int getGenerateClipScalars()
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.


generateClipScalarsOn

public void generateClipScalarsOn()
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.


generateClipScalarsOff

public void generateClipScalarsOff()
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.


setGenerateClippedOutput

public void setGenerateClippedOutput(int id0)
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.


getGenerateClippedOutput

public int getGenerateClippedOutput()
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.


generateClippedOutputOn

public void generateClippedOutputOn()
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.


generateClippedOutputOff

public void generateClippedOutputOff()
Control whether a second output is generated. The second output contains the polygonal data that's been clipped away.


setMergeTolerance

public void setMergeTolerance(double id0)
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.


getMergeToleranceMinValue

public double getMergeToleranceMinValue()
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.


getMergeToleranceMaxValue

public double getMergeToleranceMaxValue()
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.


getMergeTolerance

public double getMergeTolerance()
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.


getClippedOutput

public vtkUnstructuredGrid getClippedOutput()
Return the Clipped output.


getNumberOfOutputs

public int getNumberOfOutputs()
Return the Clipped output.

Overrides:
getNumberOfOutputs in class vtkSource

setLocator

public void setLocator(vtkPointLocator id0)
Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.


getLocator

public vtkPointLocator getLocator()
Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.


createDefaultLocator

public void createDefaultLocator()
Create default locator. Used to create one when none is specified. The locator is used to merge coincident points.


getMTime

public int getMTime()
Return the mtime also considering the locator and clip function.

Overrides:
getMTime in class vtkObject

getInputScalarsSelection

public java.lang.String getInputScalarsSelection()
If you want to clip by an arbitrary array, then set its name here. By default this in NULL and the filter will use the active scalar array.


selectInputScalars

public void selectInputScalars(java.lang.String id0)

VTKInit

public void VTKInit()
Overrides:
VTKInit in class vtkObject

VTKCastInit

protected void VTKCastInit()
Overrides:
VTKCastInit in class vtkDataSetToUnstructuredGridFilter


Copyright © 2004 Sydney ViSLAB. All Rights Reserved.