Generate a superellipsoid. More...

#include <vtkParametricSuperEllipsoid.h>

Inheritance diagram for vtkParametricSuperEllipsoid:

Collaboration diagram for vtkParametricSuperEllipsoid:

Public Types
typedef vtkParametricFunction	Superclass

Public Types inherited from vtkParametricFunction
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkParametricSuperEllipsoid *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

int	GetDimension () override
	Return the parametric dimension of the class. More...

void	Evaluate (double uvw[3], double Pt[3], double Duvw[9]) override
	A superellipsoid. More...

double	EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9]) override
	Calculate a user defined scalar using one or all of uvw, Pt, Duvw. More...


virtual void	SetXRadius (double)
	Set/Get the scaling factor for the x-axis. More...

virtual double	GetXRadius ()
	Set/Get the scaling factor for the x-axis. More...


virtual void	SetYRadius (double)
	Set/Get the scaling factor for the y-axis. More...

virtual double	GetYRadius ()
	Set/Get the scaling factor for the y-axis. More...


virtual void	SetZRadius (double)
	Set/Get the scaling factor for the z-axis. More...

virtual double	GetZRadius ()
	Set/Get the scaling factor for the z-axis. More...


virtual void	SetN1 (double)
	Set/Get the "squareness" parameter in the z axis. More...

virtual double	GetN1 ()
	Set/Get the "squareness" parameter in the z axis. More...


virtual void	SetN2 (double)
	Set/Get the "squareness" parameter in the x-y plane. More...

virtual double	GetN2 ()
	Set/Get the "squareness" parameter in the x-y plane. More...

Public Member Functions inherited from vtkParametricFunction
vtkParametricFunction *	NewInstance () const

virtual void	SetMinimumU (double)
	Set/Get the minimum u-value. More...

virtual double	GetMinimumU ()
	Set/Get the minimum u-value. More...

virtual void	SetMaximumU (double)
	Set/Get the maximum u-value. More...

virtual double	GetMaximumU ()
	Set/Get the maximum u-value. More...

virtual void	SetMinimumV (double)
	Set/Get the minimum v-value. More...

virtual double	GetMinimumV ()
	Set/Get the minimum v-value. More...

virtual void	SetMaximumV (double)
	Set/Get the maximum v-value. More...

virtual double	GetMaximumV ()
	Set/Get the maximum v-value. More...

virtual void	SetMinimumW (double)
	Set/Get the minimum w-value. More...

virtual double	GetMinimumW ()
	Set/Get the minimum w-value. More...

virtual void	SetMaximumW (double)
	Set/Get the maximum w-value. More...

virtual double	GetMaximumW ()
	Set/Get the maximum w-value. More...

virtual void	SetJoinU (int)
	Set/Get the flag which joins the first triangle strip to the last one. More...

virtual int	GetJoinU ()
	Set/Get the flag which joins the first triangle strip to the last one. More...

virtual void	JoinUOn ()
	Set/Get the flag which joins the first triangle strip to the last one. More...

virtual void	JoinUOff ()
	Set/Get the flag which joins the first triangle strip to the last one. More...

virtual void	SetJoinV (int)
	Set/Get the flag which joins the the ends of the triangle strips. More...

virtual int	GetJoinV ()
	Set/Get the flag which joins the the ends of the triangle strips. More...

virtual void	JoinVOn ()
	Set/Get the flag which joins the the ends of the triangle strips. More...

virtual void	JoinVOff ()
	Set/Get the flag which joins the the ends of the triangle strips. More...

virtual void	SetJoinW (int)
	Set/Get the flag which joins the the ends of the triangle strips. More...

virtual int	GetJoinW ()
	Set/Get the flag which joins the the ends of the triangle strips. More...

virtual void	JoinWOn ()
	Set/Get the flag which joins the the ends of the triangle strips. More...

virtual void	JoinWOff ()
	Set/Get the flag which joins the the ends of the triangle strips. More...

virtual void	SetTwistU (int)
	Set/Get the flag which joins the first triangle strip to the last one with a twist. More...

virtual int	GetTwistU ()
	Set/Get the flag which joins the first triangle strip to the last one with a twist. More...

virtual void	TwistUOn ()
	Set/Get the flag which joins the first triangle strip to the last one with a twist. More...

virtual void	TwistUOff ()
	Set/Get the flag which joins the first triangle strip to the last one with a twist. More...

virtual void	SetTwistV (int)
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual int	GetTwistV ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	TwistVOn ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	TwistVOff ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	SetTwistW (int)
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual int	GetTwistW ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	TwistWOn ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	TwistWOff ()
	Set/Get the flag which joins the ends of the triangle strips with a twist. More...

virtual void	SetClockwiseOrdering (int)
	Set/Get the flag which determines the ordering of the the vertices forming the triangle strips. More...

virtual int	GetClockwiseOrdering ()
	Set/Get the flag which determines the ordering of the the vertices forming the triangle strips. More...

virtual void	ClockwiseOrderingOn ()
	Set/Get the flag which determines the ordering of the the vertices forming the triangle strips. More...

virtual void	ClockwiseOrderingOff ()
	Set/Get the flag which determines the ordering of the the vertices forming the triangle strips. More...

virtual void	SetDerivativesAvailable (int)
	Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives). More...

virtual int	GetDerivativesAvailable ()
	Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives). More...

virtual void	DerivativesAvailableOn ()
	Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives). More...

virtual void	DerivativesAvailableOff ()
	Set/Get the flag which determines whether derivatives are available from the parametric function (i.e., whether the Evaluate() method returns valid derivatives). More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkParametricSuperEllipsoid *	SafeDownCast (vtkObjectBase *o)

static vtkParametricSuperEllipsoid *	New ()
	Construct a superellipsoid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 0, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a sphere in this case. More...

Static Public Member Functions inherited from vtkParametricFunction
static int	IsTypeOf (const char *type)

static vtkParametricFunction *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkParametricSuperEllipsoid ()

	~vtkParametricSuperEllipsoid () override

Protected Member Functions inherited from vtkParametricFunction
	vtkParametricFunction ()

	~vtkParametricFunction () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	XRadius

double	YRadius

double	ZRadius

double	N1

double	N2

Protected Attributes inherited from vtkParametricFunction
double	MinimumU

double	MaximumU

double	MinimumV

double	MaximumV

double	MinimumW

double	MaximumW

int	JoinU

int	JoinV

int	JoinW

int	TwistU

int	TwistV

int	TwistW

int	ClockwiseOrdering

int	DerivativesAvailable

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Generate a superellipsoid.

vtkParametricSuperEllipsoid generates a superellipsoid. A superellipsoid is a versatile primitive that is controlled by two parameters n1 and n2. As special cases it can represent a sphere, square box, and closed cylindrical can.

For further information about this surface, please consult the technical description "Parametric surfaces" in http://www.vtk.org/publications in the "VTK Technical Documents" section in the VTk.org web pages.

Also see: http://paulbourke.net/geometry/superellipse/

Warning: Care needs to be taken specifying the bounds correctly. You may need to carefully adjust MinimumU, MinimumV, MaximumU, MaximumV.

Thanks:: Andrew Maclean andre.nosp@m.w.am.nosp@m.aclea.nosp@m.n@gm.nosp@m.ail.c.nosp@m.om for creating and contributing the class.

Tests:: vtkParametricSuperEllipsoid (Tests)

Definition at line 49 of file vtkParametricSuperEllipsoid.h.

Member Typedef Documentation

typedef vtkParametricFunction vtkParametricSuperEllipsoid::Superclass

Definition at line 52 of file vtkParametricSuperEllipsoid.h.

Constructor & Destructor Documentation

vtkParametricSuperEllipsoid::vtkParametricSuperEllipsoid ( )

protected

vtkParametricSuperEllipsoid::~vtkParametricSuperEllipsoid ( )

overrideprotected

Member Function Documentation

static int vtkParametricSuperEllipsoid::IsTypeOf ( const char * type )

static

virtual int vtkParametricSuperEllipsoid::IsA ( const char * name )

virtual

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkParametricFunction.

static vtkParametricSuperEllipsoid* vtkParametricSuperEllipsoid::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkParametricSuperEllipsoid::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkParametricFunction.

vtkParametricSuperEllipsoid* vtkParametricSuperEllipsoid::NewInstance ( ) const

void vtkParametricSuperEllipsoid::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkParametricFunction.

static vtkParametricSuperEllipsoid* vtkParametricSuperEllipsoid::New ( )

static

Construct a superellipsoid with the following parameters: MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV = Pi, JoinU = 1, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 0, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1, ZRadius = 1, a sphere in this case.

int vtkParametricSuperEllipsoid::GetDimension ( )

inlineoverridevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 71 of file vtkParametricSuperEllipsoid.h.

virtual void vtkParametricSuperEllipsoid::SetXRadius ( double )

virtual

Set/Get the scaling factor for the x-axis.

Default is 1.

virtual double vtkParametricSuperEllipsoid::GetXRadius ( )

virtual

Set/Get the scaling factor for the x-axis.

Default is 1.

virtual void vtkParametricSuperEllipsoid::SetYRadius ( double )

virtual

Set/Get the scaling factor for the y-axis.

Default is 1.

virtual double vtkParametricSuperEllipsoid::GetYRadius ( )

virtual

Set/Get the scaling factor for the y-axis.

Default is 1.

virtual void vtkParametricSuperEllipsoid::SetZRadius ( double )

virtual

Set/Get the scaling factor for the z-axis.

Default is 1.

virtual double vtkParametricSuperEllipsoid::GetZRadius ( )

virtual

Set/Get the scaling factor for the z-axis.

Default is 1.

virtual void vtkParametricSuperEllipsoid::SetN1 ( double )

virtual

Set/Get the "squareness" parameter in the z axis.

Default is 1.

virtual double vtkParametricSuperEllipsoid::GetN1 ( )

virtual

Set/Get the "squareness" parameter in the z axis.

Default is 1.

virtual void vtkParametricSuperEllipsoid::SetN2 ( double )

virtual

Set/Get the "squareness" parameter in the x-y plane.

Default is 1.

virtual double vtkParametricSuperEllipsoid::GetN2 ( )

virtual

Set/Get the "squareness" parameter in the x-y plane.

Default is 1.

void vtkParametricSuperEllipsoid::Evaluate	(	double	uvw[3],
		double	Pt[3],
		double	Duvw[9]
	)

overridevirtual

A superellipsoid.

This function performs the mapping $f(u,v) \rightarrow (x,y,x)$ , returning it as Pt. It also returns the partial derivatives Du and Dv. $Pt = (x, y, z), Du = (dx/du, dy/du, dz/du), Dv = (dx/dv, dy/dv, dz/dv)$ . Then the normal is $N = Du X Dv$ .

Implements vtkParametricFunction.

double vtkParametricSuperEllipsoid::EvaluateScalar	(	double	uvw[3],
		double	Pt[3],
		double	Duvw[9]
	)

overridevirtual

Calculate a user defined scalar using one or all of uvw, Pt, Duvw.

uvw are the parameters with Pt being the the cartesian point, Duvw are the derivatives of this point with respect to u, v and w. Pt, Duvw are obtained from Evaluate().

This function is only called if the ScalarMode has the value vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED

If the user does not need to calculate a scalar, then the instantiated function should return zero.

Implements vtkParametricFunction.