vtk
Class vtkSweptSurface

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkProcessObject
              vtk.vtkSource
                  vtk.vtkImageSource
                      vtk.vtkImageToImageFilter
                          vtk.vtkSweptSurface

All Implemented Interfaces:

java.io.Serializable

public class vtkSweptSurface

extends vtkImageToImageFilter

implements java.io.Serializable

vtkSweptSurface - given a path and input geometry generate an (implicit) representation of a swept surface. vtkSweptSurface is a filter that is used to create a surface defined by moving a part along a path. In this implementation, the path is defined as a list of transformation matrices (vtkTransform), and the part geometry is implicitly defined using a volume (i.e., distance scalars in structured point dataset). The input to the filter is the geometry (i.e., a structured point dataset) and the output is a structured point dataset (i.e., an implicit representation of the swept surface). If you wish to generate a polygonal representation of swept surface you will have to use a contouring filter (e.g., vtkContourFilter). (You may also wish to use vtkDecimate to reduce mesh size.) The swept surface algorithm can be summarized as follows. A geometry (i.e. the input) is swept along a path (list of transforms). At each point on the path the input is re-sampled into a volume using a union operation. (Union means that the minimum scalar value is retained - minimum distance value for example.) At the end, an implicit representation of the swept surface is defined. JavaBean wrapper for vtkSweptSurface object.

Author:

vtk2jbean Automatic JavaBean wrapper for VTK.

See Also:

vtkImplicitModeller, vtkContourFilter, Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

changes

Fields inherited from class vtk.vtkObjectBase

vtkId

Constructor Summary

	vtkSweptSurface()
protected	vtkSweptSurface(int dmy)

Method Summary

void	adjustBoundsOff() Control how the model bounds are computed.
void	adjustBoundsOn() Control how the model bounds are computed.
void	cappingOff() The outer boundary of the sampling volume can be capped (i.e., assigned fill value).
void	cappingOn() The outer boundary of the sampling volume can be capped (i.e., assigned fill value).
int	getAdjustBounds() Control how the model bounds are computed.
double	getAdjustDistance() Specify the amount to grow the model bounds (if the ivar AdjustBounds is set).
double	getAdjustDistanceMaxValue() Specify the amount to grow the model bounds (if the ivar AdjustBounds is set).
double	getAdjustDistanceMinValue() Specify the amount to grow the model bounds (if the ivar AdjustBounds is set).
int	getCapping() The outer boundary of the sampling volume can be capped (i.e., assigned fill value).
java.lang.String	getClassName() Return the class name as a string.
double	getFillValue() Voxels are initialized to this value.
int	getMaximumNumberOfInterpolationSteps() Set/get the maximum number of interpolation steps to take.
double[]	getModelBounds() Define the volume (in world coordinates) in which the sampling is to occur.
int	getMTime() Return this object's modified time.
int	getNumberOfInterpolationSteps() Value specifies/controls interpolation between the nodes (i.e., transforms) defining the path.
int[]	getSampleDimensions() Specify i-j-k dimensions to sample input with.
vtkSweptSurface	getThisSweptSurface()
vtkTransformCollection	getTransforms() Specify a path (i.e., list of transforms) that the input moves along.
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	setAdjustBounds(int id0) Control how the model bounds are computed.
void	setAdjustDistance(double id0) Specify the amount to grow the model bounds (if the ivar AdjustBounds is set).
void	setCapping(int id0) The outer boundary of the sampling volume can be capped (i.e., assigned fill value).
void	setFillValue(double id0) Voxels are initialized to this value.
void	setMaximumNumberOfInterpolationSteps(int id0) Set/get the maximum number of interpolation steps to take.
void	setModelBounds(double[] id0) Define the volume (in world coordinates) in which the sampling is to occur.
void	setModelBounds(double id0, double id1, double id2, double id3, double id4, double id5) Define the volume (in world coordinates) in which the sampling is to occur.
void	setNumberOfInterpolationSteps(int id0) Value specifies/controls interpolation between the nodes (i.e., transforms) defining the path.
void	setSampleDimensions(int[] id0) Specify i-j-k dimensions to sample input with.
void	setSampleDimensions(int id0, int id1, int id2) Specify i-j-k dimensions to sample input with.
void	setTransforms(vtkTransformCollection id0) Specify a path (i.e., list of transforms) that the input moves along.
protected void	VTKCastInit()
void	VTKInit()

Methods inherited from class vtk.vtkImageToImageFilter

bypassOff, bypassOn, getBypass, getInput, getInputMemoryLimit, getNumberOfThreads, getNumberOfThreadsMaxValue, getNumberOfThreadsMinValue, getThisImageToImageFilter, setBypass, setInput, setInputMemoryLimit, setNumberOfThreads, splitExtent, threadedExecute

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

vtkSweptSurface

public vtkSweptSurface()

vtkSweptSurface

protected vtkSweptSurface(int dmy)

Method Detail

getThisSweptSurface

public vtkSweptSurface getThisSweptSurface()

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 vtkImageToImageFilter

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 vtkImageToImageFilter

setSampleDimensions

public void setSampleDimensions(int id0,
                                int id1,
                                int id2)

Specify i-j-k dimensions to sample input with. The higher the resolution the lower the error but the greater the processing time.

setSampleDimensions

public void setSampleDimensions(int[] id0)

Specify i-j-k dimensions to sample input with. The higher the resolution the lower the error but the greater the processing time.

getSampleDimensions

public int[] getSampleDimensions()

Specify i-j-k dimensions to sample input with. The higher the resolution the lower the error but the greater the processing time.

setTransforms

public void setTransforms(vtkTransformCollection id0)

Specify a path (i.e., list of transforms) that the input moves along. At least two transforms must be used to define a path.

getTransforms

public vtkTransformCollection getTransforms()

Specify a path (i.e., list of transforms) that the input moves along. At least two transforms must be used to define a path.

setFillValue

public void setFillValue(double id0)

Voxels are initialized to this value. By default a large doubleing point value is used, since the scalar values are assumed to be a distance function.

getFillValue

public double getFillValue()

Voxels are initialized to this value. By default a large doubleing point value is used, since the scalar values are assumed to be a distance function.

setNumberOfInterpolationSteps

public void setNumberOfInterpolationSteps(int id0)

Value specifies/controls interpolation between the nodes (i.e., transforms) defining the path. A positive value indicates the number of steps to take between transforms (i.e., interpolation is performed). A negative value indicates that no interpolation to be performed, that is, only the points defined at each transform are used (interpolation not performed). A zero value indicates that automatic interpolation is to be performed, that is, interpolation is computed so that potential errors fall below the error bounds defined in the text. By default, automatic computation is performed (Interpolation = 0).

getNumberOfInterpolationSteps

public int getNumberOfInterpolationSteps()

Value specifies/controls interpolation between the nodes (i.e., transforms) defining the path. A positive value indicates the number of steps to take between transforms (i.e., interpolation is performed). A negative value indicates that no interpolation to be performed, that is, only the points defined at each transform are used (interpolation not performed). A zero value indicates that automatic interpolation is to be performed, that is, interpolation is computed so that potential errors fall below the error bounds defined in the text. By default, automatic computation is performed (Interpolation = 0).

setMaximumNumberOfInterpolationSteps

public void setMaximumNumberOfInterpolationSteps(int id0)

Set/get the maximum number of interpolation steps to take. This is useful if you are limited in computation time or just know that the number of computed steps should not exceed a certain value.

getMaximumNumberOfInterpolationSteps

public int getMaximumNumberOfInterpolationSteps()

Set/get the maximum number of interpolation steps to take. This is useful if you are limited in computation time or just know that the number of computed steps should not exceed a certain value.

setCapping

public void setCapping(int id0)

The outer boundary of the sampling volume can be capped (i.e., assigned fill value). This will "close" the implicit model if the geometry approaches close to or passes through the boundary of the volume (i.e., defined by ModelBounds instance variable). Capping turns on/off this capability. By default capping is on.

getCapping

public int getCapping()

The outer boundary of the sampling volume can be capped (i.e., assigned fill value). This will "close" the implicit model if the geometry approaches close to or passes through the boundary of the volume (i.e., defined by ModelBounds instance variable). Capping turns on/off this capability. By default capping is on.

cappingOn

public void cappingOn()

The outer boundary of the sampling volume can be capped (i.e., assigned fill value). This will "close" the implicit model if the geometry approaches close to or passes through the boundary of the volume (i.e., defined by ModelBounds instance variable). Capping turns on/off this capability. By default capping is on.

cappingOff

public void cappingOff()

The outer boundary of the sampling volume can be capped (i.e., assigned fill value). This will "close" the implicit model if the geometry approaches close to or passes through the boundary of the volume (i.e., defined by ModelBounds instance variable). Capping turns on/off this capability. By default capping is on.

setModelBounds

public void setModelBounds(double[] id0)

Define the volume (in world coordinates) in which the sampling is to occur. Make sure that the volume is large enough to accommodate the motion of the geometry along the path. If the model bounds are set to all zero values, the model bounds will be computed automatically from the input geometry and path.

getModelBounds

public double[] getModelBounds()

Define the volume (in world coordinates) in which the sampling is to occur. Make sure that the volume is large enough to accommodate the motion of the geometry along the path. If the model bounds are set to all zero values, the model bounds will be computed automatically from the input geometry and path.

setModelBounds

public void setModelBounds(double id0,
                           double id1,
                           double id2,
                           double id3,
                           double id4,
                           double id5)

Define the volume (in world coordinates) in which the sampling is to occur. Make sure that the volume is large enough to accommodate the motion of the geometry along the path. If the model bounds are set to all zero values, the model bounds will be computed automatically from the input geometry and path.

setAdjustBounds

public void setAdjustBounds(int id0)

Control how the model bounds are computed. If the ivar AdjustBounds is set, then the bounds specified (or computed automatically) is modified by the fraction given by AdjustDistance. This means that the model bounds is expanded in each of the x-y-z directions.

getAdjustBounds

public int getAdjustBounds()

Control how the model bounds are computed. If the ivar AdjustBounds is set, then the bounds specified (or computed automatically) is modified by the fraction given by AdjustDistance. This means that the model bounds is expanded in each of the x-y-z directions.

adjustBoundsOn

public void adjustBoundsOn()

Control how the model bounds are computed. If the ivar AdjustBounds is set, then the bounds specified (or computed automatically) is modified by the fraction given by AdjustDistance. This means that the model bounds is expanded in each of the x-y-z directions.

adjustBoundsOff

public void adjustBoundsOff()

Control how the model bounds are computed. If the ivar AdjustBounds is set, then the bounds specified (or computed automatically) is modified by the fraction given by AdjustDistance. This means that the model bounds is expanded in each of the x-y-z directions.

setAdjustDistance

public void setAdjustDistance(double id0)

Specify the amount to grow the model bounds (if the ivar AdjustBounds is set). The value is a fraction of the maximum length of the sides of the box specified by the model bounds.

getAdjustDistanceMinValue

public double getAdjustDistanceMinValue()

Specify the amount to grow the model bounds (if the ivar AdjustBounds is set). The value is a fraction of the maximum length of the sides of the box specified by the model bounds.

getAdjustDistanceMaxValue

public double getAdjustDistanceMaxValue()

Specify the amount to grow the model bounds (if the ivar AdjustBounds is set). The value is a fraction of the maximum length of the sides of the box specified by the model bounds.

getAdjustDistance

public double getAdjustDistance()

Specify the amount to grow the model bounds (if the ivar AdjustBounds is set). The value is a fraction of the maximum length of the sides of the box specified by the model bounds.

getMTime

public int getMTime()

Description copied from class: vtkObject

Return this object's modified time.

Overrides:

getMTime in class vtkObject

VTKInit

public void VTKInit()

Overrides:

VTKInit in class vtkObject

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkImageToImageFilter