ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkSuperquadric Class Reference

vtkSuperquadric - implicit function for a Superquadric More...

Inheritance diagram for Kitware.VTK.vtkSuperquadric:
[legend]
Collaboration diagram for Kitware.VTK.vtkSuperquadric:
[legend]

List of all members.

Public Member Functions

 vtkSuperquadric (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkSuperquadric ()
 Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.
override double EvaluateFunction (IntPtr x)
 ImplicitFunction interface.
new double EvaluateFunction (double x, double y, double z)
 ImplicitFunction interface.
override void EvaluateGradient (IntPtr x, IntPtr g)
 ImplicitFunction interface.
virtual double[] GetCenter ()
 Set the center of the superquadric. Default is 0,0,0.
virtual void GetCenter (IntPtr data)
 Set the center of the superquadric. Default is 0,0,0.
virtual double GetPhiRoundness ()
 Set/Get Superquadric north/south roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.
virtual double[] GetScale ()
 Set the scale factors of the superquadric. Default is 1,1,1.
virtual void GetScale (IntPtr data)
 Set the scale factors of the superquadric. Default is 1,1,1.
virtual double GetSize ()
 Set/Get Superquadric isotropic size.
virtual double GetThetaRoundness ()
 Set/Get Superquadric east/west roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.
virtual double GetThickness ()
 Set/Get Superquadric ring thickness (toroids only). Changing thickness maintains the outside diameter of the toroid.
virtual double GetThicknessMaxValue ()
 Set/Get Superquadric ring thickness (toroids only). Changing thickness maintains the outside diameter of the toroid.
virtual double GetThicknessMinValue ()
 Set/Get Superquadric ring thickness (toroids only). Changing thickness maintains the outside diameter of the toroid.
virtual int GetToroidal ()
 Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
override int IsA (string type)
 Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.
new vtkSuperquadric NewInstance ()
 Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.
virtual void SetCenter (double _arg1, double _arg2, double _arg3)
 Set the center of the superquadric. Default is 0,0,0.
virtual void SetCenter (IntPtr _arg)
 Set the center of the superquadric. Default is 0,0,0.
void SetPhiRoundness (double e)
 Set/Get Superquadric north/south roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.
virtual void SetScale (double _arg1, double _arg2, double _arg3)
 Set the scale factors of the superquadric. Default is 1,1,1.
virtual void SetScale (IntPtr _arg)
 Set the scale factors of the superquadric. Default is 1,1,1.
virtual void SetSize (double _arg)
 Set/Get Superquadric isotropic size.
void SetThetaRoundness (double e)
 Set/Get Superquadric east/west roundness. Values range from 0 (rectangular) to 1 (circular) to higher orders.
virtual void SetThickness (double _arg)
 Set/Get Superquadric ring thickness (toroids only). Changing thickness maintains the outside diameter of the toroid.
virtual void SetToroidal (int _arg)
 Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
virtual void ToroidalOff ()
 Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
virtual void ToroidalOn ()
 Set/Get whether or not the superquadric is toroidal (1) or ellipsoidal (0).
- Public Member Functions inherited from Kitware.VTK.vtkImplicitFunction
 vtkImplicitFunction (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkImplicitFunction ()
 *Undocumented Block
void FunctionGradient (IntPtr x, IntPtr g)
 Evaluate function gradient at position x-y-z and pass back vector. Point x[3] is transformed through transform (if provided).
double[] FunctionGradient (IntPtr x)
 Evaluate function gradient at position x-y-z and pass back vector. Point x[3] is transformed through transform (if provided).
double[] FunctionGradient (double x, double y, double z)
 Evaluate function gradient at position x-y-z and pass back vector. Point x[3] is transformed through transform (if provided).
double FunctionValue (IntPtr x)
 Evaluate function at position x-y-z and return value. Point x[3] is transformed through transform (if provided).
double FunctionValue (double x, double y, double z)
 Evaluate function at position x-y-z and return value. Point x[3] is transformed through transform (if provided).
override uint GetMTime ()
 Overload standard modified time function. If Transform is modified, then this object is modified as well.
virtual vtkAbstractTransform GetTransform ()
 Set/Get a transformation to apply to input points before executing the implicit function.
virtual void SetTransform (vtkAbstractTransform arg0)
 Set/Get a transformation to apply to input points before executing the implicit function.
virtual void SetTransform (IntPtr elements)
 Set/Get a transformation to apply to input points before executing the implicit function.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkSuperquadric New ()
 Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.
static new int IsTypeOf (string type)
 Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.
static new vtkSuperquadric SafeDownCast (vtkObjectBase o)
 Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkSuperquadric"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkImplicitFunction
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "15vtkSuperquadric"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkImplicitFunction
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions

static vtkSuperquadric ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSuperquadric - implicit function for a Superquadric

Description 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.

Caveats The Size and Thickness parameters control coefficients of superquadric generation, and may do not exactly describe the size of the superquadric.


Constructor & Destructor Documentation

static Kitware.VTK.vtkSuperquadric.vtkSuperquadric ( )
staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkSuperquadric.vtkSuperquadric ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkSuperquadric.vtkSuperquadric ( )

Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.


Member Function Documentation

override void Kitware.VTK.vtkSuperquadric.Dispose ( bool  disposing)
protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

override double Kitware.VTK.vtkSuperquadric.EvaluateFunction ( IntPtr  x)
virtual

ImplicitFunction interface.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

new double Kitware.VTK.vtkSuperquadric.EvaluateFunction ( double  x,
double  y,
double  z 
)

ImplicitFunction interface.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

override void Kitware.VTK.vtkSuperquadric.EvaluateGradient ( IntPtr  x,
IntPtr  g 
)
virtual

ImplicitFunction interface.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

virtual double [] Kitware.VTK.vtkSuperquadric.GetCenter ( )
virtual

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

virtual void Kitware.VTK.vtkSuperquadric.GetCenter ( IntPtr  data)
virtual

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

virtual double Kitware.VTK.vtkSuperquadric.GetPhiRoundness ( )
virtual

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

virtual double [] Kitware.VTK.vtkSuperquadric.GetScale ( )
virtual

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

virtual void Kitware.VTK.vtkSuperquadric.GetScale ( IntPtr  data)
virtual

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

virtual double Kitware.VTK.vtkSuperquadric.GetSize ( )
virtual

Set/Get Superquadric isotropic size.

virtual double Kitware.VTK.vtkSuperquadric.GetThetaRoundness ( )
virtual

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

virtual double Kitware.VTK.vtkSuperquadric.GetThickness ( )
virtual

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

virtual double Kitware.VTK.vtkSuperquadric.GetThicknessMaxValue ( )
virtual

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

virtual double Kitware.VTK.vtkSuperquadric.GetThicknessMinValue ( )
virtual

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

virtual int Kitware.VTK.vtkSuperquadric.GetToroidal ( )
virtual

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

override int Kitware.VTK.vtkSuperquadric.IsA ( string  type)
virtual

Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

static new int Kitware.VTK.vtkSuperquadric.IsTypeOf ( string  type)
static

Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

static new vtkSuperquadric Kitware.VTK.vtkSuperquadric.New ( )
static

Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.

Reimplemented from Kitware.VTK.vtkObject.

new vtkSuperquadric Kitware.VTK.vtkSuperquadric.NewInstance ( )

Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

static new vtkSuperquadric Kitware.VTK.vtkSuperquadric.SafeDownCast ( vtkObjectBase  o)
static

Description Construct with superquadric radius of 0.5, toroidal off, center at 0.0, scale (1,1,1), size 0.5, phi roundness 1.0, and theta roundness 0.0.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkSuperquadric.SetCenter ( double  _arg1,
double  _arg2,
double  _arg3 
)
virtual

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

virtual void Kitware.VTK.vtkSuperquadric.SetCenter ( IntPtr  _arg)
virtual

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

void Kitware.VTK.vtkSuperquadric.SetPhiRoundness ( double  e)

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

virtual void Kitware.VTK.vtkSuperquadric.SetScale ( double  _arg1,
double  _arg2,
double  _arg3 
)
virtual

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

virtual void Kitware.VTK.vtkSuperquadric.SetScale ( IntPtr  _arg)
virtual

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

virtual void Kitware.VTK.vtkSuperquadric.SetSize ( double  _arg)
virtual

Set/Get Superquadric isotropic size.

void Kitware.VTK.vtkSuperquadric.SetThetaRoundness ( double  e)

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

virtual void Kitware.VTK.vtkSuperquadric.SetThickness ( double  _arg)
virtual

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

virtual void Kitware.VTK.vtkSuperquadric.SetToroidal ( int  _arg)
virtual

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

virtual void Kitware.VTK.vtkSuperquadric.ToroidalOff ( )
virtual

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

virtual void Kitware.VTK.vtkSuperquadric.ToroidalOn ( )
virtual

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


Member Data Documentation

new readonly string Kitware.VTK.vtkSuperquadric.MRClassNameKey = "15vtkSuperquadric"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImplicitFunction.

new const string Kitware.VTK.vtkSuperquadric.MRFullTypeName = "Kitware.VTK.vtkSuperquadric"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImplicitFunction.


The documentation for this class was generated from the following file: