vtk
Class vtkSampleFunction

java.lang.Object
  extended byvtk.vtkObjectBase
      extended byvtk.vtkObject
          extended byvtk.vtkProcessObject
              extended byvtk.vtkSource
                  extended byvtk.vtkImageSource
                      extended byvtk.vtkSampleFunction
All Implemented Interfaces:
java.io.Serializable

public class vtkSampleFunction
extends vtkImageSource
implements java.io.Serializable

vtkSampleFunction - sample an implicit function over a structured point set. vtkSampleFunction is a source object that evaluates an implicit function and normals at each point in a vtkStructuredPoints. The user can specify the sample dimensions and location in space to perform the sampling. To create closed surfaces (in conjunction with the vtkContourFilter), capping can be turned on to set a particular value on the boundaries of the sample space. JavaBean wrapper for vtkSampleFunction object.

Author:
vtk2jbean Automatic JavaBean wrapper for VTK.
See Also:
Serialized Form

Field Summary
protected  java.beans.PropertyChangeSupport changes
           
 
Fields inherited from class vtk.vtkObjectBase
vtkId
 
Constructor Summary
  vtkSampleFunction()
           
protected vtkSampleFunction(int dmy)
           
 
Method Summary
 void cappingOff()
          Turn on/off capping.
 void cappingOn()
          Turn on/off capping.
 void computeNormalsOff()
          Turn on/off the computation of normals.
 void computeNormalsOn()
          Turn on/off the computation of normals.
 int getCapping()
          Turn on/off capping.
 double getCapValue()
          Set the cap value.
 java.lang.String getClassName()
          Return the class name as a string.
 int getComputeNormals()
          Turn on/off the computation of normals.
 vtkImplicitFunction getImplicitFunction()
          Specify the implicit function to use to generate data.
 double[] getModelBounds()
          Specify the region in space over which the sampling occurs.
 int getMTime()
          Return the MTime also considering the implicit function.
 int getOutputScalarType()
          Set what type of scalar data this source should generate.
 int[] getSampleDimensions()
          Specify the dimensions of the data on which to sample.
 vtkSampleFunction getThisSampleFunction()
           
 int isA(java.lang.String id0)
          Return 1 if this class is the same type of (or a subclass of) the named class.
 void setCapping(int id0)
          Turn on/off capping.
 void setCapValue(double id0)
          Set the cap value.
 void setComputeNormals(int id0)
          Turn on/off the computation of normals.
 void setImplicitFunction(vtkImplicitFunction id0)
          Specify the implicit function to use to generate data.
 void setModelBounds(double[] id0)
          Specify the region in space over which the sampling occurs.
 void setModelBounds(double id0, double id1, double id2, double id3, double id4, double id5)
          Specify the region in space over which the sampling occurs.
 void setOutputScalarType(int id0)
          Set what type of scalar data this source should generate.
 void setOutputScalarTypeToChar()
          Set what type of scalar data this source should generate.
 void setOutputScalarTypeToDouble()
          Set what type of scalar data this source should generate.
 void setOutputScalarTypeToFloat()
          Set what type of scalar data this source should generate.
 void setOutputScalarTypeToInt()
          Set what type of scalar data this source should generate.
 void setOutputScalarTypeToLong()
          Set what type of scalar data this source should generate.
 void setOutputScalarTypeToShort()
          Set what type of scalar data this source should generate.
 void setOutputScalarTypeToUnsignedChar()
          Control the type of the scalars object by explicitly providing a scalar object.
 void setOutputScalarTypeToUnsignedInt()
          Set what type of scalar data this source should generate.
 void setOutputScalarTypeToUnsignedLong()
          Set what type of scalar data this source should generate.
 void setOutputScalarTypeToUnsignedShort()
          Set what type of scalar data this source should generate.
 void setSampleDimensions(int[] id0)
          Specify the dimensions of the data on which to sample.
 void setSampleDimensions(int id0, int id1, int id2)
          Specify the dimensions of the data on which to sample.
 void setScalars(vtkDataArray id0)
          Control the type of the scalars object by explicitly providing a scalar object.
protected  void VTKCastInit()
           
 void VTKInit()
           
 
Methods inherited from class vtk.vtkImageSource
getOutput, getOutput, getThisImageSource, setOutput
 
Methods inherited from class vtk.vtkSource
computeInputUpdateExtents, getNumberOfOutputs, 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

vtkSampleFunction

public vtkSampleFunction()

vtkSampleFunction

protected vtkSampleFunction(int dmy)
Method Detail

getThisSampleFunction

public vtkSampleFunction getThisSampleFunction()

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 vtkImageSource

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 vtkImageSource

setImplicitFunction

public void setImplicitFunction(vtkImplicitFunction id0)
Specify the implicit function to use to generate data.


getImplicitFunction

public vtkImplicitFunction getImplicitFunction()
Specify the implicit function to use to generate data.


setOutputScalarType

public void setOutputScalarType(int id0)
Set what type of scalar data this source should generate.


getOutputScalarType

public int getOutputScalarType()
Set what type of scalar data this source should generate.


setOutputScalarTypeToDouble

public void setOutputScalarTypeToDouble()
Set what type of scalar data this source should generate.


setOutputScalarTypeToFloat

public void setOutputScalarTypeToFloat()
Set what type of scalar data this source should generate.


setOutputScalarTypeToLong

public void setOutputScalarTypeToLong()
Set what type of scalar data this source should generate.


setOutputScalarTypeToUnsignedLong

public void setOutputScalarTypeToUnsignedLong()
Set what type of scalar data this source should generate.


setOutputScalarTypeToInt

public void setOutputScalarTypeToInt()
Set what type of scalar data this source should generate.


setOutputScalarTypeToUnsignedInt

public void setOutputScalarTypeToUnsignedInt()
Set what type of scalar data this source should generate.


setOutputScalarTypeToShort

public void setOutputScalarTypeToShort()
Set what type of scalar data this source should generate.


setOutputScalarTypeToUnsignedShort

public void setOutputScalarTypeToUnsignedShort()
Set what type of scalar data this source should generate.


setOutputScalarTypeToChar

public void setOutputScalarTypeToChar()
Set what type of scalar data this source should generate.


setOutputScalarTypeToUnsignedChar

public void setOutputScalarTypeToUnsignedChar()
Control the type of the scalars object by explicitly providing a scalar object. THIS IS DEPRECATED, although it still works!!! Please use SetOutputScalarType instead.


setScalars

public void setScalars(vtkDataArray id0)
Control the type of the scalars object by explicitly providing a scalar object. THIS IS DEPRECATED, although it still works!!! Please use SetOutputScalarType instead.


setSampleDimensions

public void setSampleDimensions(int id0,
                                int id1,
                                int id2)
Specify the dimensions of the data on which to sample.


setSampleDimensions

public void setSampleDimensions(int[] id0)
Specify the dimensions of the data on which to sample.


getSampleDimensions

public int[] getSampleDimensions()
Specify the dimensions of the data on which to sample.


setModelBounds

public void setModelBounds(double id0,
                           double id1,
                           double id2,
                           double id3,
                           double id4,
                           double id5)
Specify the region in space over which the sampling occurs. The bounds is specified as (xMin,xMax, yMin,yMax, zMin,zMax).


setModelBounds

public void setModelBounds(double[] id0)
Specify the region in space over which the sampling occurs. The bounds is specified as (xMin,xMax, yMin,yMax, zMin,zMax).


getModelBounds

public double[] getModelBounds()
Specify the region in space over which the sampling occurs. The bounds is specified as (xMin,xMax, yMin,yMax, zMin,zMax).


setCapping

public void setCapping(int id0)
Turn on/off capping. If capping is on, then the outer boundaries of the structured point set are set to cap value. This can be used to insure surfaces are closed.


getCapping

public int getCapping()
Turn on/off capping. If capping is on, then the outer boundaries of the structured point set are set to cap value. This can be used to insure surfaces are closed.


cappingOn

public void cappingOn()
Turn on/off capping. If capping is on, then the outer boundaries of the structured point set are set to cap value. This can be used to insure surfaces are closed.


cappingOff

public void cappingOff()
Turn on/off capping. If capping is on, then the outer boundaries of the structured point set are set to cap value. This can be used to insure surfaces are closed.


setCapValue

public void setCapValue(double id0)
Set the cap value.


getCapValue

public double getCapValue()
Set the cap value.


setComputeNormals

public void setComputeNormals(int id0)
Turn on/off the computation of normals.


getComputeNormals

public int getComputeNormals()
Turn on/off the computation of normals.


computeNormalsOn

public void computeNormalsOn()
Turn on/off the computation of normals.


computeNormalsOff

public void computeNormalsOff()
Turn on/off the computation of normals.


getMTime

public int getMTime()
Return the MTime also considering the implicit function.

Overrides:
getMTime in class vtkObject

VTKInit

public void VTKInit()
Overrides:
VTKInit in class vtkObject

VTKCastInit

protected void VTKCastInit()
Overrides:
VTKCastInit in class vtkImageSource


Copyright © 2004 Sydney ViSLAB. All Rights Reserved.