vtkSpiralShellSource Class Reference

#include <vtkSpiralShellSource.h>

Inheritance diagram for vtkSpiralShellSource:

[legend]Collaboration diagram for vtkSpiralShellSource:

[legend]List of all members.

---

Detailed Description

Creates a spiral shell surface centered at the origin.

Author:

Sean McInerney

Version:

Revision

1.4

Date:

Date

2004/08/10 07:37:22

Note:

Based on "Mathematical Shells" by Paul Bourke.

See also:

vtkPolyDataSource

Definition at line 43 of file vtkSpiralShellSource.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkSpiralShellSource, vtkPolyDataSource)
void	PrintSelf (ostream &, vtkIndent)
virtual void	SetCenter (double, double, double)
	Set/Get the center (Default is 0,0,0).
virtual void	SetCenter (double[3])
	Set/Get the center (Default is 0,0,0).
virtual double *	GetCenter ()
	Set/Get the center (Default is 0,0,0).
virtual void	GetCenter (double data[3])
	Set/Get the center (Default is 0,0,0).
virtual void	SetThetaResolution (int)
	Set/Get the Theta resolution (Default is 24).
virtual int	GetThetaResolution ()
	Set/Get the Theta resolution (Default is 24).
virtual void	SetPhiResolution (int)
	Set/Get the Phi resolution (Default is 36).
virtual int	GetPhiResolution ()
	Set/Get the Phi resolution (Default is 36).
virtual void	SetNumberOfSpirals (double)
	Set/Get the number of spirals (Default is 2.0).
virtual double	GetNumberOfSpirals ()
	Set/Get the number of spirals (Default is 2.0).
virtual void	SetFinalRadius (double)
	Set/Get the final shell radius (Default is 0.25).
virtual double	GetFinalRadius ()
	Set/Get the final shell radius (Default is 0.25).
virtual void	SetInnerRadius (double)
	Set/Get the inner shell radius (Default is 0.125).
virtual double	GetInnerRadius ()
	Set/Get the inner shell radius (Default is 0.125).
virtual void	SetHeight (double)
	Set/Get the height (Default is 1.0).
virtual double	GetHeight ()
	Set/Get the height (Default is 1.0).
virtual void	SetTriangulate (int)
	Toggle triangulation of output mesh.
virtual int	GetTriangulate ()
	Toggle triangulation of output mesh.
virtual void	TriangulateOn ()
	Toggle triangulation of output mesh.
virtual void	TriangulateOff ()
	Toggle triangulation of output mesh.
virtual void	SetFlipX (int)
	Flip X coordinate values.
virtual int	GetFlipX ()
	Flip X coordinate values.
virtual void	FlipXOn ()
	Flip X coordinate values.
virtual void	FlipXOff ()
	Flip X coordinate values.
virtual void	SetFlipY (int)
	Flip Y coordinate values.
virtual int	GetFlipY ()
	Flip Y coordinate values.
virtual void	FlipYOn ()
	Flip Y coordinate values.
virtual void	FlipYOff ()
	Flip Y coordinate values.
virtual void	SetFlipZ (int)
	Flip Z coordinate values.
virtual int	GetFlipZ ()
	Flip Z coordinate values.
virtual void	FlipZOn ()
	Flip Z coordinate values.
virtual void	FlipZOff ()
	Flip Z coordinate values.
virtual void	SetGenerateNormals (int)
	Toggle generation of vertex normals.
virtual int	GetGenerateNormals ()
	Toggle generation of vertex normals.
virtual void	GenerateNormalsOn ()
	Toggle generation of vertex normals.
virtual void	GenerateNormalsOff ()
	Toggle generation of vertex normals.
virtual void	SetRetainScalars (int)
	Retain scalar magnitude when generating vertex normals.
virtual int	GetRetainScalars ()
	Retain scalar magnitude when generating vertex normals.
virtual void	RetainScalarsOn ()
	Retain scalar magnitude when generating vertex normals.
virtual void	RetainScalarsOff ()
	Retain scalar magnitude when generating vertex normals.
virtual void	SetGenerateTCoords (int)
	Toggle generation of 2D texture coordinates by mapping dataset points.
virtual int	GetGenerateTCoords ()
	Toggle generation of 2D texture coordinates by mapping dataset points.
virtual void	GenerateTCoordsOn ()
	Toggle generation of 2D texture coordinates by mapping dataset points.
virtual void	GenerateTCoordsOff ()
	Toggle generation of 2D texture coordinates by mapping dataset points.
virtual void	SetPreventSeam (int)
	Control how texture coordinates are generated.
virtual int	GetPreventSeam ()
	Control how texture coordinates are generated.
virtual void	PreventSeamOn ()
	Control how texture coordinates are generated.
virtual void	PreventSeamOff ()
	Control how texture coordinates are generated.
Static Public Member Functions
vtkSpiralShellSource *	New (void)
Protected Member Functions
	vtkSpiralShellSource (void)
	~vtkSpiralShellSource ()
void	ExecuteData (vtkDataObject *)
	Execute method that should be used by subclasses of vtkSource.
Protected Attributes
double	Center [3]
int	ThetaResolution
int	PhiResolution
double	NumberOfSpirals
double	FinalRadius
double	InnerRadius
double	Height
int	Triangulate
int	FlipX
int	FlipY
int	FlipZ
int	GenerateNormals
int	RetainScalars
int	GenerateTCoords
int	PreventSeam

---

Constructor & Destructor Documentation

vtkSpiralShellSource::vtkSpiralShellSource (  void   )  [protected]

vtkSpiralShellSource::~vtkSpiralShellSource (   )  [protected]

---

Member Function Documentation

void vtkSpiralShellSource::ExecuteData (  vtkDataObject *   )  [protected, virtual]

Execute method that should be used by subclasses of vtkSource. Reimplemented from vtkSource.

virtual void vtkSpiralShellSource::FlipXOff (   )  [virtual]

Flip X coordinate values.

virtual void vtkSpiralShellSource::FlipXOn (   )  [virtual]

Flip X coordinate values.

virtual void vtkSpiralShellSource::FlipYOff (   )  [virtual]

Flip Y coordinate values.

virtual void vtkSpiralShellSource::FlipYOn (   )  [virtual]

Flip Y coordinate values.

virtual void vtkSpiralShellSource::FlipZOff (   )  [virtual]

Flip Z coordinate values.

virtual void vtkSpiralShellSource::FlipZOn (   )  [virtual]

Flip Z coordinate values.

virtual void vtkSpiralShellSource::GenerateNormalsOff (   )  [virtual]

Toggle generation of vertex normals.

virtual void vtkSpiralShellSource::GenerateNormalsOn (   )  [virtual]

Toggle generation of vertex normals.

virtual void vtkSpiralShellSource::GenerateTCoordsOff (   )  [virtual]

Toggle generation of 2D texture coordinates by mapping dataset points.

virtual void vtkSpiralShellSource::GenerateTCoordsOn (   )  [virtual]

Toggle generation of 2D texture coordinates by mapping dataset points.

virtual void vtkSpiralShellSource::GetCenter (  double  data[3]  )  [virtual]

Set/Get the center (Default is 0,0,0).

virtual double* vtkSpiralShellSource::GetCenter (   )  [virtual]

Set/Get the center (Default is 0,0,0).

virtual double vtkSpiralShellSource::GetFinalRadius (   )  [virtual]

Set/Get the final shell radius (Default is 0.25).

virtual int vtkSpiralShellSource::GetFlipX (   )  [virtual]

Flip X coordinate values.

virtual int vtkSpiralShellSource::GetFlipY (   )  [virtual]

Flip Y coordinate values.

virtual int vtkSpiralShellSource::GetFlipZ (   )  [virtual]

Flip Z coordinate values.

virtual int vtkSpiralShellSource::GetGenerateNormals (   )  [virtual]

Toggle generation of vertex normals.

virtual int vtkSpiralShellSource::GetGenerateTCoords (   )  [virtual]

Toggle generation of 2D texture coordinates by mapping dataset points.

virtual double vtkSpiralShellSource::GetHeight (   )  [virtual]

Set/Get the height (Default is 1.0).

virtual double vtkSpiralShellSource::GetInnerRadius (   )  [virtual]

Set/Get the inner shell radius (Default is 0.125).

virtual double vtkSpiralShellSource::GetNumberOfSpirals (   )  [virtual]

Set/Get the number of spirals (Default is 2.0).

virtual int vtkSpiralShellSource::GetPhiResolution (   )  [virtual]

Set/Get the Phi resolution (Default is 36).

virtual int vtkSpiralShellSource::GetPreventSeam (   )  [virtual]

Control how texture coordinates are generated. If PreventSeam is set, the S-coord. ranges from 0->1 and 1->0 corresponding to theta angle variation between 0->180 and 180->0 degrees. Otherwise, the S-coord. ranges from 0->1 between 0->360 degrees.

virtual int vtkSpiralShellSource::GetRetainScalars (   )  [virtual]

Retain scalar magnitude when generating vertex normals.

virtual int vtkSpiralShellSource::GetThetaResolution (   )  [virtual]

Set/Get the Theta resolution (Default is 24).

virtual int vtkSpiralShellSource::GetTriangulate (   )  [virtual]

Toggle triangulation of output mesh. By default, quadrilaterals are generated everywhere except at the pole.

vtkSpiralShellSource* vtkSpiralShellSource::New (  void   )  [static]

Reimplemented from vtkObject.

virtual void vtkSpiralShellSource::PreventSeamOff (   )  [virtual]

Control how texture coordinates are generated. If PreventSeam is set, the S-coord. ranges from 0->1 and 1->0 corresponding to theta angle variation between 0->180 and 180->0 degrees. Otherwise, the S-coord. ranges from 0->1 between 0->360 degrees.

virtual void vtkSpiralShellSource::PreventSeamOn (   )  [virtual]

Control how texture coordinates are generated. If PreventSeam is set, the S-coord. ranges from 0->1 and 1->0 corresponding to theta angle variation between 0->180 and 180->0 degrees. Otherwise, the S-coord. ranges from 0->1 between 0->360 degrees.

void vtkSpiralShellSource::PrintSelf (  ostream &  , vtkIndent  )  [virtual]

Reimplemented from vtkPolyDataSource.

virtual void vtkSpiralShellSource::RetainScalarsOff (   )  [virtual]

Retain scalar magnitude when generating vertex normals.

virtual void vtkSpiralShellSource::RetainScalarsOn (   )  [virtual]

Retain scalar magnitude when generating vertex normals.

virtual void vtkSpiralShellSource::SetCenter (  double  [3]  )  [virtual]

Set/Get the center (Default is 0,0,0).

virtual void vtkSpiralShellSource::SetCenter (  double  , double  , double  )  [virtual]

Set/Get the center (Default is 0,0,0).

virtual void vtkSpiralShellSource::SetFinalRadius (  double   )  [virtual]

Set/Get the final shell radius (Default is 0.25).

virtual void vtkSpiralShellSource::SetFlipX (  int   )  [virtual]

Flip X coordinate values.

virtual void vtkSpiralShellSource::SetFlipY (  int   )  [virtual]

Flip Y coordinate values.

virtual void vtkSpiralShellSource::SetFlipZ (  int   )  [virtual]

Flip Z coordinate values.

virtual void vtkSpiralShellSource::SetGenerateNormals (  int   )  [virtual]

Toggle generation of vertex normals.

virtual void vtkSpiralShellSource::SetGenerateTCoords (  int   )  [virtual]

Toggle generation of 2D texture coordinates by mapping dataset points.

virtual void vtkSpiralShellSource::SetHeight (  double   )  [virtual]

Set/Get the height (Default is 1.0).

virtual void vtkSpiralShellSource::SetInnerRadius (  double   )  [virtual]

Set/Get the inner shell radius (Default is 0.125).

virtual void vtkSpiralShellSource::SetNumberOfSpirals (  double   )  [virtual]

Set/Get the number of spirals (Default is 2.0).

virtual void vtkSpiralShellSource::SetPhiResolution (  int   )  [virtual]

Set/Get the Phi resolution (Default is 36).

virtual void vtkSpiralShellSource::SetPreventSeam (  int   )  [virtual]

Control how texture coordinates are generated. If PreventSeam is set, the S-coord. ranges from 0->1 and 1->0 corresponding to theta angle variation between 0->180 and 180->0 degrees. Otherwise, the S-coord. ranges from 0->1 between 0->360 degrees.

virtual void vtkSpiralShellSource::SetRetainScalars (  int   )  [virtual]

Retain scalar magnitude when generating vertex normals.

virtual void vtkSpiralShellSource::SetThetaResolution (  int   )  [virtual]

Set/Get the Theta resolution (Default is 24).

virtual void vtkSpiralShellSource::SetTriangulate (  int   )  [virtual]

Toggle triangulation of output mesh. By default, quadrilaterals are generated everywhere except at the pole.

virtual void vtkSpiralShellSource::TriangulateOff (   )  [virtual]

Toggle triangulation of output mesh. By default, quadrilaterals are generated everywhere except at the pole.

virtual void vtkSpiralShellSource::TriangulateOn (   )  [virtual]

Toggle triangulation of output mesh. By default, quadrilaterals are generated everywhere except at the pole.

vtkSpiralShellSource::vtkTypeRevisionMacro (  vtkSpiralShellSource  , vtkPolyDataSource  )

---

Member Data Documentation

double vtkSpiralShellSource::Center[3] [protected]

Definition at line 162 of file vtkSpiralShellSource.h.

double vtkSpiralShellSource::FinalRadius [protected]

Definition at line 166 of file vtkSpiralShellSource.h.

int vtkSpiralShellSource::FlipX [protected]

Definition at line 170 of file vtkSpiralShellSource.h.

int vtkSpiralShellSource::FlipY [protected]

Definition at line 171 of file vtkSpiralShellSource.h.

int vtkSpiralShellSource::FlipZ [protected]

Definition at line 172 of file vtkSpiralShellSource.h.

int vtkSpiralShellSource::GenerateNormals [protected]

Definition at line 173 of file vtkSpiralShellSource.h.

int vtkSpiralShellSource::GenerateTCoords [protected]

Definition at line 175 of file vtkSpiralShellSource.h.

double vtkSpiralShellSource::Height [protected]

Definition at line 168 of file vtkSpiralShellSource.h.

double vtkSpiralShellSource::InnerRadius [protected]

Definition at line 167 of file vtkSpiralShellSource.h.

double vtkSpiralShellSource::NumberOfSpirals [protected]

Definition at line 165 of file vtkSpiralShellSource.h.

int vtkSpiralShellSource::PhiResolution [protected]

Definition at line 164 of file vtkSpiralShellSource.h.

int vtkSpiralShellSource::PreventSeam [protected]

Definition at line 176 of file vtkSpiralShellSource.h.

int vtkSpiralShellSource::RetainScalars [protected]

Definition at line 174 of file vtkSpiralShellSource.h.

int vtkSpiralShellSource::ThetaResolution [protected]

Definition at line 163 of file vtkSpiralShellSource.h.

int vtkSpiralShellSource::Triangulate [protected]

Definition at line 169 of file vtkSpiralShellSource.h.

---

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

• vtkSpiralShellSource.h

---