vtk
Class vtkPiecewiseFunction

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkDataObject
              vtk.vtkPiecewiseFunction

All Implemented Interfaces:

java.io.Serializable

public class vtkPiecewiseFunction

extends vtkDataObject

implements java.io.Serializable

vtkPiecewiseFunction - Defines a 1D piecewise function.. Defines a piecewise linear function mapping. Used for transfer functions in volume rendering. JavaBean wrapper for vtkPiecewiseFunction 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

	vtkPiecewiseFunction()
protected	vtkPiecewiseFunction(int dmy)

Method Summary

int	addPoint(double id0, double id1) Add/Remove points to/from the function.
void	addSegment(double id0, double id1, double id2, double id3) Add a line segment to the function.
void	clampingOff() When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified.
void	clampingOn() When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified.
void	deepCopy(vtkDataObject id0) Shallow and Deep copy.
int	getClamping() When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified.
java.lang.String	getClassName() Return the class name as a string.
int	getDataObjectType() Return what type of dataset this is.
double	getFirstNonZeroValue() Returns the first point location which precedes a non-zero segment of the function.
int	getMTime() Get the mtime of this object - override to consider the mtime of the source as well.
double[]	getRange() Returns the min and max point locations of the function.
int	getSize() Get the number of points used to specify the function
vtkPiecewiseFunction	getThisPiecewiseFunction()
java.lang.String	getType() Return the type of function: Function Types: 0 : Constant (No change in slope between end points) 1 : NonDecreasing (Always increasing or zero slope) 2 : NonIncreasing (Always decreasing or zero slope) 3 : Varied (Contains both decreasing and increasing slopes)
double	getValue(double id0) Returns the value of the function at the specified location using the specified interpolation.
void	initialize()
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	removeAllPoints() Removes all points from the function.
int	removePoint(double id0) Add/Remove points to/from the function.
void	setClamping(int id0) When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified.
void	shallowCopy(vtkDataObject id0) Shallow and Deep copy.
protected void	VTKCastInit()
void	VTKInit()

Methods inherited from class vtk.vtkDataObject

addConsumer, copyInformation, copyTypeSpecificInformation, dataHasBeenGenerated, getActualMemorySize, getConsumer, getDataReleased, getEstimatedMemorySize, getExtentTranslator, getExtentType, getFieldData, getGlobalReleaseDataFlag, getLocality, getMaximumNumberOfPieces, getNetReferenceCount, getNumberOfConsumers, getPipelineMTime, getReleaseDataFlag, getRequestExactExtent, getSource, getThisDataObject, getUpdateExtent, getUpdateGhostLevel, getUpdateNumberOfPieces, getUpdatePiece, getUpdateTime, getWholeExtent, globalReleaseDataFlagOff, globalReleaseDataFlagOn, isConsumer, prepareForNewData, propagateUpdateExtent, releaseData, releaseDataFlagOff, releaseDataFlagOn, removeConsumer, requestExactExtentOff, requestExactExtentOn, setExtentTranslator, setFieldData, setGlobalReleaseDataFlag, setLocality, setMaximumNumberOfPieces, setPipelineMTime, setReleaseDataFlag, setRequestExactExtent, setSource, setUpdateExtent, setUpdateExtent, setUpdateExtent, setUpdateExtent, setUpdateExtentToWholeExtent, setUpdateGhostLevel, setUpdateNumberOfPieces, setUpdatePiece, setWholeExtent, setWholeExtent, shouldIReleaseData, triggerAsynchronousUpdate, unRegister, update, updateData, updateInformation

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

vtkPiecewiseFunction

public vtkPiecewiseFunction()

vtkPiecewiseFunction

protected vtkPiecewiseFunction(int dmy)

Method Detail

getThisPiecewiseFunction

public vtkPiecewiseFunction getThisPiecewiseFunction()

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 vtkDataObject

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 vtkDataObject

initialize

public void initialize()

Overrides:

initialize in class vtkDataObject

deepCopy

public void deepCopy(vtkDataObject id0)

Description copied from class: vtkDataObject

Shallow and Deep copy. These copy the data, but not any of the pipeline connections.

Overrides:

deepCopy in class vtkDataObject

shallowCopy

public void shallowCopy(vtkDataObject id0)

Description copied from class: vtkDataObject

Shallow and Deep copy. These copy the data, but not any of the pipeline connections.

Overrides:

shallowCopy in class vtkDataObject

getDataObjectType

public int getDataObjectType()

Return what type of dataset this is.

Overrides:

getDataObjectType in class vtkDataObject

getSize

public int getSize()

Get the number of points used to specify the function

addPoint

public int addPoint(double id0,
                    double id1)

Add/Remove points to/from the function. If a duplicate point is added then the function value is changed at that location. Return the index of the point (0 based), or -1 on error.

removePoint

public int removePoint(double id0)

Add/Remove points to/from the function. If a duplicate point is added then the function value is changed at that location. Return the index of the point (0 based), or -1 on error.

removeAllPoints

public void removeAllPoints()

Removes all points from the function.

addSegment

public void addSegment(double id0,
                       double id1,
                       double id2,
                       double id3)

Add a line segment to the function. All points defined between the two points specified are removed from the function.

getValue

public double getValue(double id0)

Returns the value of the function at the specified location using the specified interpolation. Returns zero if the specified location is outside the min and max points of the function.

getRange

public double[] getRange()

Returns the min and max point locations of the function.

setClamping

public void setClamping(int id0)

When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified. When zero range clamping is On, GetValue() returns the value at the value at the lowest point for a request below all points specified and returns the value at the highest point for a request above all points specified. On is the default.

getClamping

public int getClamping()

When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified. When zero range clamping is On, GetValue() returns the value at the value at the lowest point for a request below all points specified and returns the value at the highest point for a request above all points specified. On is the default.

clampingOn

public void clampingOn()

When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified. When zero range clamping is On, GetValue() returns the value at the value at the lowest point for a request below all points specified and returns the value at the highest point for a request above all points specified. On is the default.

clampingOff

public void clampingOff()

When zero range clamping is Off, GetValue() returns 0.0 when a value is requested outside of the points specified. When zero range clamping is On, GetValue() returns the value at the value at the lowest point for a request below all points specified and returns the value at the highest point for a request above all points specified. On is the default.

getType

public java.lang.String getType()

Return the type of function: Function Types: 0 : Constant (No change in slope between end points) 1 : NonDecreasing (Always increasing or zero slope) 2 : NonIncreasing (Always decreasing or zero slope) 3 : Varied (Contains both decreasing and increasing slopes)

getMTime

public int getMTime()

Get the mtime of this object - override to consider the mtime of the source as well.

Overrides:

getMTime in class vtkDataObject

getFirstNonZeroValue

public double getFirstNonZeroValue()

Returns the first point location which precedes a non-zero segment of the function. Note that the value at this point may be zero.

VTKInit

public void VTKInit()

Overrides:

VTKInit in class vtkDataObject

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkDataObject