VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkParametricConicSpiral Class Reference

Generate conic spiral surfaces that resemble sea-shells. More...

#include <vtkParametricConicSpiral.h>

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

List of all members.

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int GetDimension ()
virtual void Evaluate (double uvw[3], double Pt[3], double Duvw[9])
virtual double EvaluateScalar (double uvw[3], double Pt[3], double Duvw[9])
virtual void SetA (double)
virtual double GetA ()
virtual void SetB (double)
virtual double GetB ()
virtual void SetC (double)
virtual double GetC ()
virtual void SetN (double)
virtual double GetN ()
- Public Member Functions inherited from vtkParametricFunction
virtual void SetMinimumU (double)
virtual double GetMinimumU ()
virtual void SetMaximumU (double)
virtual double GetMaximumU ()
virtual void SetMinimumV (double)
virtual double GetMinimumV ()
virtual void SetMaximumV (double)
virtual double GetMaximumV ()
virtual void SetMinimumW (double)
virtual double GetMinimumW ()
virtual void SetMaximumW (double)
virtual double GetMaximumW ()
virtual void SetJoinU (int)
virtual int GetJoinU ()
virtual void JoinUOn ()
virtual void JoinUOff ()
virtual void SetJoinV (int)
virtual int GetJoinV ()
virtual void JoinVOn ()
virtual void JoinVOff ()
virtual void SetTwistU (int)
virtual int GetTwistU ()
virtual void TwistUOn ()
virtual void TwistUOff ()
virtual void SetTwistV (int)
virtual int GetTwistV ()
virtual void TwistVOn ()
virtual void TwistVOff ()
virtual void SetClockwiseOrdering (int)
virtual int GetClockwiseOrdering ()
virtual void ClockwiseOrderingOn ()
virtual void ClockwiseOrderingOff ()
virtual void SetDerivativesAvailable (int)
virtual int GetDerivativesAvailable ()
virtual void DerivativesAvailableOn ()
virtual void DerivativesAvailableOff ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
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)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkParametricConicSpiralSafeDownCast (vtkObject *o)
static vtkParametricConicSpiralNew ()

Protected Member Functions

 vtkParametricConicSpiral ()
 ~vtkParametricConicSpiral ()
- Protected Member Functions inherited from vtkParametricFunction
 vtkParametricFunction ()
virtual ~vtkParametricFunction ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

double A
double B
double C
double N
- 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
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

Generate conic spiral surfaces that resemble sea-shells.

vtkParametricConicSpiral generates conic spiral surfaces. These can resemble sea shells, or may look like a torus "eating" its own tail.

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

Thanks:
Andrew Maclean a.mac.nosp@m.lean.nosp@m.@cas..nosp@m.edu..nosp@m.au for creating and contributing the class.
Tests:
vtkParametricConicSpiral (Tests)

Definition at line 39 of file vtkParametricConicSpiral.h.


Member Typedef Documentation

Reimplemented from vtkParametricFunction.

Definition at line 42 of file vtkParametricConicSpiral.h.


Constructor & Destructor Documentation

vtkParametricConicSpiral::vtkParametricConicSpiral ( )
protected
vtkParametricConicSpiral::~vtkParametricConicSpiral ( )
protected

Member Function Documentation

virtual const char* vtkParametricConicSpiral::GetClassName ( )
virtual

Reimplemented from vtkParametricFunction.

static int vtkParametricConicSpiral::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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.

virtual int vtkParametricConicSpiral::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 vtkParametricConicSpiral* vtkParametricConicSpiral::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkParametricFunction.

void vtkParametricConicSpiral::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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 vtkParametricConicSpiral* vtkParametricConicSpiral::New ( )
static

Construct a conic spiral surface with the following parameters: MinimumU = 0, MaximumU = 2Pi, MinimumV = 0, MaximumV = 2Pi, JoinU = 0, JoinV = 0, TwistU = 0, TwistV = 0, ClockwiseOrdering = 1, DerivativesAvailable = 1, A = 0.2, B = 1.0, C = 0.1, N = 2.

Reimplemented from vtkObject.

virtual int vtkParametricConicSpiral::GetDimension ( )
inlinevirtual

Return the parametric dimension of the class.

Implements vtkParametricFunction.

Definition at line 52 of file vtkParametricConicSpiral.h.

virtual void vtkParametricConicSpiral::SetA ( double  )
virtual

Set/Get the scale factor. Default = 0.2

virtual double vtkParametricConicSpiral::GetA ( )
virtual

Set/Get the scale factor. Default = 0.2

virtual void vtkParametricConicSpiral::SetB ( double  )
virtual

Set/Get the A function coefficient (see equation below). Default = 1.

virtual double vtkParametricConicSpiral::GetB ( )
virtual

Set/Get the A function coefficient (see equation below). Default = 1.

virtual void vtkParametricConicSpiral::SetC ( double  )
virtual

Set/Get the B function coefficient (see equation below). Default = 0.1.

virtual double vtkParametricConicSpiral::GetC ( )
virtual

Set/Get the B function coefficient (see equation below). Default = 0.1.

virtual void vtkParametricConicSpiral::SetN ( double  )
virtual

Set/Get the C function coefficient (see equation below). Default = 2.

virtual double vtkParametricConicSpiral::GetN ( )
virtual

Set/Get the C function coefficient (see equation below). Default = 2.

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

A conic spiral surface. 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.

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

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.


Member Data Documentation

double vtkParametricConicSpiral::A
protected

Definition at line 101 of file vtkParametricConicSpiral.h.

double vtkParametricConicSpiral::B
protected

Definition at line 102 of file vtkParametricConicSpiral.h.

double vtkParametricConicSpiral::C
protected

Definition at line 103 of file vtkParametricConicSpiral.h.

double vtkParametricConicSpiral::N
protected

Definition at line 104 of file vtkParametricConicSpiral.h.


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