VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkParametricSuperEllipsoid Class Reference

Generate a superellipsoid. More...

#include <vtkParametricSuperEllipsoid.h>

Inheritance diagram for vtkParametricSuperEllipsoid:
[legend]
Collaboration diagram for vtkParametricSuperEllipsoid:
[legend]

Public Types

typedef vtkParametricFunction Superclass
 
- Public Types inherited from vtkParametricFunction
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkParametricSuperEllipsoidNewInstance () 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...
 
virtual void SetXRadius (double)
 Set/Get the scaling factor for the x-axis. More...
 
virtual double GetXRadius ()
 
virtual void SetYRadius (double)
 Set/Get the scaling factor for the y-axis. More...
 
virtual double GetYRadius ()
 
virtual void SetZRadius (double)
 Set/Get the scaling factor for the z-axis. More...
 
virtual double GetZRadius ()
 
virtual void SetN1 (double)
 Set/Get the "squareness" parameter in the z axis. More...
 
virtual double GetN1 ()
 
virtual void SetN2 (double)
 Set/Get the "squareness" parameter in the x-y plane. More...
 
virtual double GetN2 ()
 
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...
 
- Public Member Functions inherited from vtkParametricFunction
vtkParametricFunctionNewInstance () const
 
virtual void SetMinimumU (double)
 Set/Get the minimum u-value. More...
 
virtual double GetMinimumU ()
 
virtual void SetMaximumU (double)
 Set/Get the maximum u-value. More...
 
virtual double GetMaximumU ()
 
virtual void SetMinimumV (double)
 Set/Get the minimum v-value. More...
 
virtual double GetMinimumV ()
 
virtual void SetMaximumV (double)
 Set/Get the maximum v-value. More...
 
virtual double GetMaximumV ()
 
virtual void SetMinimumW (double)
 Set/Get the minimum w-value. More...
 
virtual double GetMinimumW ()
 
virtual void SetMaximumW (double)
 Set/Get the maximum w-value. More...
 
virtual double GetMaximumW ()
 
virtual void SetJoinU (vtkTypeBool)
 Set/Get the flag which joins the first triangle strip to the last one. More...
 
virtual vtkTypeBool GetJoinU ()
 
virtual void JoinUOn ()
 
virtual void JoinUOff ()
 
virtual void SetJoinV (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips. More...
 
virtual vtkTypeBool GetJoinV ()
 
virtual void JoinVOn ()
 
virtual void JoinVOff ()
 
virtual void SetJoinW (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips. More...
 
virtual vtkTypeBool GetJoinW ()
 
virtual void JoinWOn ()
 
virtual void JoinWOff ()
 
virtual void SetTwistU (vtkTypeBool)
 Set/Get the flag which joins the first triangle strip to the last one with a twist. More...
 
virtual vtkTypeBool GetTwistU ()
 
virtual void TwistUOn ()
 
virtual void TwistUOff ()
 
virtual void SetTwistV (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips with a twist. More...
 
virtual vtkTypeBool GetTwistV ()
 
virtual void TwistVOn ()
 
virtual void TwistVOff ()
 
virtual void SetTwistW (vtkTypeBool)
 Set/Get the flag which joins the ends of the triangle strips with a twist. More...
 
virtual vtkTypeBool GetTwistW ()
 
virtual void TwistWOn ()
 
virtual void TwistWOff ()
 
virtual void SetClockwiseOrdering (vtkTypeBool)
 Set/Get the flag which determines the ordering of the vertices forming the triangle strips. More...
 
virtual vtkTypeBool GetClockwiseOrdering ()
 
virtual void ClockwiseOrderingOn ()
 
virtual void ClockwiseOrderingOff ()
 
virtual void SetDerivativesAvailable (vtkTypeBool)
 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 vtkTypeBool GetDerivativesAvailable ()
 
virtual void DerivativesAvailableOn ()
 
virtual void DerivativesAvailableOff ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkParametricSuperEllipsoidSafeDownCast (vtkObjectBase *o)
 
static vtkParametricSuperEllipsoidNew ()
 Construct a superellipsoid with the following parameters: MinimumU = -Pi, MaximumU = Pi, MinimumV = -Pi/2, MaximumV = Pi/2, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 0, 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkParametricFunctionSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- 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
 
vtkTypeBool JoinU
 
vtkTypeBool JoinV
 
vtkTypeBool JoinW
 
vtkTypeBool TwistU
 
vtkTypeBool TwistV
 
vtkTypeBool TwistW
 
vtkTypeBool ClockwiseOrdering
 
vtkTypeBool DerivativesAvailable
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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.

Definition at line 46 of file vtkParametricSuperEllipsoid.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file vtkParametricSuperEllipsoid.h.

Constructor & Destructor Documentation

◆ vtkParametricSuperEllipsoid()

vtkParametricSuperEllipsoid::vtkParametricSuperEllipsoid ( )
protected

◆ ~vtkParametricSuperEllipsoid()

vtkParametricSuperEllipsoid::~vtkParametricSuperEllipsoid ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkParametricSuperEllipsoid::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkParametricFunction.

◆ NewInstance()

vtkParametricSuperEllipsoid* vtkParametricSuperEllipsoid::NewInstance ( ) const

◆ PrintSelf()

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.

◆ New()

static vtkParametricSuperEllipsoid* vtkParametricSuperEllipsoid::New ( )
static

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

◆ GetDimension()

int vtkParametricSuperEllipsoid::GetDimension ( )
inlineoverridevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 69 of file vtkParametricSuperEllipsoid.h.

◆ SetXRadius()

virtual void vtkParametricSuperEllipsoid::SetXRadius ( double  )
virtual

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

Default is 1.

◆ GetXRadius()

virtual double vtkParametricSuperEllipsoid::GetXRadius ( )
virtual

◆ SetYRadius()

virtual void vtkParametricSuperEllipsoid::SetYRadius ( double  )
virtual

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

Default is 1.

◆ GetYRadius()

virtual double vtkParametricSuperEllipsoid::GetYRadius ( )
virtual

◆ SetZRadius()

virtual void vtkParametricSuperEllipsoid::SetZRadius ( double  )
virtual

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

Default is 1.

◆ GetZRadius()

virtual double vtkParametricSuperEllipsoid::GetZRadius ( )
virtual

◆ SetN1()

virtual void vtkParametricSuperEllipsoid::SetN1 ( double  )
virtual

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

Default is 1.

◆ GetN1()

virtual double vtkParametricSuperEllipsoid::GetN1 ( )
virtual

◆ SetN2()

virtual void vtkParametricSuperEllipsoid::SetN2 ( double  )
virtual

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

Default is 1.

◆ GetN2()

virtual double vtkParametricSuperEllipsoid::GetN2 ( )
virtual

◆ Evaluate()

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.

◆ EvaluateScalar()

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

Member Data Documentation

◆ XRadius

double vtkParametricSuperEllipsoid::XRadius
protected

Definition at line 141 of file vtkParametricSuperEllipsoid.h.

◆ YRadius

double vtkParametricSuperEllipsoid::YRadius
protected

Definition at line 142 of file vtkParametricSuperEllipsoid.h.

◆ ZRadius

double vtkParametricSuperEllipsoid::ZRadius
protected

Definition at line 143 of file vtkParametricSuperEllipsoid.h.

◆ N1

double vtkParametricSuperEllipsoid::N1
protected

Definition at line 144 of file vtkParametricSuperEllipsoid.h.

◆ N2

double vtkParametricSuperEllipsoid::N2
protected

Definition at line 145 of file vtkParametricSuperEllipsoid.h.


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