vtk
Class vtkSuperquadric

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkImplicitFunction
              vtk.vtkSuperquadric

All Implemented Interfaces:

java.io.Serializable

public class vtkSuperquadric

extends vtkImplicitFunction

implements java.io.Serializable

vtkSuperquadric - implicit function for a Superquadric. vtkSuperquadric computes the implicit function and function gradient for a superquadric. vtkSuperquadric is a concrete implementation of vtkImplicitFunction. The superquadric is centered at Center and axes of rotation is along the y-axis. (Use the superclass' vtkImplicitFunction transformation matrix if necessary to reposition.) Roundness parameters (PhiRoundness and ThetaRoundness) control the shape of the superquadric. The Toroidal boolean controls whether a toroidal superquadric is produced. If so, the Thickness parameter controls the thickness of the toroid: 0 is the thinnest allowable toroid, and 1 has a minimum sized hole. The Scale parameters allow the superquadric to be scaled in x, y, and z (normal vectors are correctly generated in any case). The Size parameter controls size of the superquadric. This code is based on "Rigid physically based superquadrics", A. H. Barr, in "Graphics Gems III", David Kirk, ed., Academic Press, 1992. JavaBean wrapper for vtkSuperquadric 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

	vtkSuperquadric()
protected	vtkSuperquadric(int dmy)

Method Summary

double	evaluateFunction(double[] id0) Evaluate function at position x-y-z and return value.
double	evaluateFunction(double id0, double id1, double id2) Evaluate function at position x-y-z and return value.
void	evaluateGradient(double[] id0, double[] id1) Evaluate function gradient at position x-y-z and pass back vector.
double[]	getCenter() Set the center of the superquadric.
java.lang.String	getClassName() Return the class name as a string.
double	getPhiRoundness() Set/Get Superquadric north/south roundness.
double[]	getScale() Set the scale factors of the superquadric.
double	getSize() Set/Get Superquadric isotropic size.
double	getThetaRoundness() Set/Get Superquadric east/west roundness.
double	getThickness() Set/Get Superquadric ring thickness (toroids only).
double	getThicknessMaxValue() Set/Get Superquadric ring thickness (toroids only).
double	getThicknessMinValue() Set/Get Superquadric ring thickness (toroids only).
vtkSuperquadric	getThisSuperquadric()
int	getToroidal() Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	setCenter(double[] id0) Set the center of the superquadric.
void	setCenter(double id0, double id1, double id2) Set the center of the superquadric.
void	setPhiRoundness(double id0) Set/Get Superquadric north/south roundness.
void	setScale(double[] id0) Set the scale factors of the superquadric.
void	setScale(double id0, double id1, double id2) Set the scale factors of the superquadric.
void	setSize(double id0) Set/Get Superquadric isotropic size.
void	setThetaRoundness(double id0) Set/Get Superquadric east/west roundness.
void	setThickness(double id0) Set/Get Superquadric ring thickness (toroids only).
void	setToroidal(int id0) Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
void	toroidalOff() Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
void	toroidalOn() Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
protected void	VTKCastInit()
void	VTKInit()

Methods inherited from class vtk.vtkImplicitFunction

functionGradient, functionGradient, functionGradient, functionValue, functionValue, getMTime, getThisImplicitFunction, getTransform, setTransform

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, unRegister

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

vtkSuperquadric

public vtkSuperquadric()

vtkSuperquadric

protected vtkSuperquadric(int dmy)

Method Detail

getThisSuperquadric

public vtkSuperquadric getThisSuperquadric()

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 vtkImplicitFunction

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 vtkImplicitFunction

evaluateFunction

public double evaluateFunction(double[] id0)

Description copied from class: vtkImplicitFunction

Evaluate function at position x-y-z and return value. You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Overrides:

evaluateFunction in class vtkImplicitFunction

evaluateFunction

public double evaluateFunction(double id0,
                               double id1,
                               double id2)

Description copied from class: vtkImplicitFunction

Evaluate function at position x-y-z and return value. You should generally not call this method directly, you should use FunctionValue() instead. This method must be implemented by any derived class.

Overrides:

evaluateFunction in class vtkImplicitFunction

evaluateGradient

public void evaluateGradient(double[] id0,
                             double[] id1)

Description copied from class: vtkImplicitFunction

Evaluate function gradient at position x-y-z and pass back vector. You should generally not call this method directly, you should use FunctionGradient() instead. This method must be implemented by any derived class.

Overrides:

evaluateGradient in class vtkImplicitFunction

setCenter

public void setCenter(double id0,
                      double id1,
                      double id2)

Set the center of the superquadric. Default is 0,0,0.

setCenter

public void setCenter(double[] id0)

Set the center of the superquadric. Default is 0,0,0.

getCenter

public double[] getCenter()

Set the center of the superquadric. Default is 0,0,0.

setScale

public void setScale(double id0,
                     double id1,
                     double id2)

Set the scale factors of the superquadric. Default is 1,1,1.

setScale

public void setScale(double[] id0)

Set the scale factors of the superquadric. Default is 1,1,1.

getScale

public double[] getScale()

Set the scale factors of the superquadric. Default is 1,1,1.

getThickness

public double getThickness()

Set/Get Superquadric ring thickness (toroids only). Changing thickness maintains the outside diameter of the toroid.

setThickness

public void setThickness(double id0)

Set/Get Superquadric ring thickness (toroids only). Changing thickness maintains the outside diameter of the toroid.

getThicknessMinValue

public double getThicknessMinValue()

Set/Get Superquadric ring thickness (toroids only). Changing thickness maintains the outside diameter of the toroid.

getThicknessMaxValue

public double getThicknessMaxValue()

Set/Get Superquadric ring thickness (toroids only). Changing thickness maintains the outside diameter of the toroid.

getPhiRoundness

public double getPhiRoundness()

Set/Get Superquadric north/south roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.

setPhiRoundness

public void setPhiRoundness(double id0)

Set/Get Superquadric north/south roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.

getThetaRoundness

public double getThetaRoundness()

Set/Get Superquadric east/west roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.

setThetaRoundness

public void setThetaRoundness(double id0)

Set/Get Superquadric east/west roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.

setSize

public void setSize(double id0)

Set/Get Superquadric isotropic size.

getSize

public double getSize()

Set/Get Superquadric isotropic size.

toroidalOn

public void toroidalOn()

Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).

toroidalOff

public void toroidalOff()

Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).

getToroidal

public int getToroidal()

Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).

setToroidal

public void setToroidal(int id0)

Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).

VTKInit

public void VTKInit()

Overrides:

VTKInit in class vtkObject

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkImplicitFunction