vtkCylinder Class Reference

#include <vtkCylinder.h>

Inheritance diagram for vtkCylinder:

[legend]Collaboration diagram for vtkCylinder:

[legend]List of all members.

Detailed Description

implicit function for a cylinder

vtkCylinder computes the implicit function and function gradient for a cylinder. vtkCylinder is a concrete implementation of vtkImplicitFunction. Cylinder is centered at Center and axes of rotation is along the y-axis. (Use the superclass' vtkImplicitFunction transformation matrix if necessary to reposition.)

Warning:: The cylinder is infinite in extent. To truncate the cylinder use the vtkImplicitBoolean in combination with clipping planes.

Created by:

Schroeder, Will

CVS contributions (if > 5%):

Schroeder, Will (58%)
Martin, Ken (21%)
Lorensen, Bill (11%)
Kelly, Ann (6%)

CVS logs (CVSweb):

.cxx (/Filtering/vtkCylinder.cxx)
.h (/Filtering/vtkCylinder.h)

Tests:: vtkCylinder (Tests)

Definition at line 50 of file vtkCylinder.h.

Public Types

typedef vtkImplicitFunction Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

void EvaluateGradient (double x[3], double g[3])

double EvaluateFunction (double x[3])

double EvaluateFunction (double x, double y, double z)

virtual void SetRadius (double)

virtual double GetRadius ()

virtual void SetCenter (double, double, double)

virtual void SetCenter (double[3])

virtual double * GetCenter ()

virtual void GetCenter (double data[3])

Static Public Member Functions

int IsTypeOf (const char *type)

vtkCylinder * SafeDownCast (vtkObject *o)

vtkCylinder * New ()

Protected Member Functions

vtkCylinder ()

~vtkCylinder ()

Protected Attributes

double Radius

double Center [3]

Member Typedef Documentation

typedef vtkImplicitFunction vtkCylinder::Superclass

Reimplemented from vtkImplicitFunction.
Definition at line 53 of file vtkCylinder.h.

Constructor & Destructor Documentation

vtkCylinder::vtkCylinder ( ) [protected]

vtkCylinder::~vtkCylinder ( ) [inline, protected]

Definition at line 82 of file vtkCylinder.h.

Member Function Documentation

virtual const char* vtkCylinder::GetClassName ( ) [virtual]

Reimplemented from vtkImplicitFunction.

int vtkCylinder::IsTypeOf ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImplicitFunction.

virtual int vtkCylinder::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkImplicitFunction.

vtkCylinder* vtkCylinder::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkImplicitFunction.

void vtkCylinder::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 vtkImplicitFunction.

vtkCylinder* vtkCylinder::New ( ) [static]

Construct cylinder radius of 0.5.
Reimplemented from vtkObject.

double vtkCylinder::EvaluateFunction ( double x[3] ) [virtual]

Evaluate cylinder equation F(x,y,z) = (x-x0)^2 + (z-z0)^2 - R^2.
Implements vtkImplicitFunction.

double vtkCylinder::EvaluateFunction ( double x,

double y,

double z

) [inline]

Evaluate cylinder equation F(x,y,z) = (x-x0)^2 + (z-z0)^2 - R^2.
Reimplemented from vtkImplicitFunction.
Definition at line 62 of file vtkCylinder.h.
References vtkImplicitFunction::EvaluateFunction().

void vtkCylinder::EvaluateGradient ( double x[3],

double g[3]

) [virtual]

Evaluate cylinder function gradient.
Implements vtkImplicitFunction.

virtual void vtkCylinder::SetRadius ( double ) [virtual]

Set/Get cylinder radius.

virtual double vtkCylinder::GetRadius ( ) [virtual]

Set/Get cylinder radius.

virtual void vtkCylinder::SetCenter ( double ,

double ,

double

) [virtual]

Set/Get cylinder center

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

Set/Get cylinder center

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

Set/Get cylinder center

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

Set/Get cylinder center

Member Data Documentation

double vtkCylinder::Radius [protected]

Definition at line 84 of file vtkCylinder.h.

double vtkCylinder::Center[3] [protected]

Definition at line 85 of file vtkCylinder.h.

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

dox/Filtering/vtkCylinder.h


Public Types
typedef vtkImplicitFunction	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	EvaluateGradient (double x[3], double g[3])

double	EvaluateFunction (double x[3])
double	EvaluateFunction (double x, double y, double z)

virtual void	SetRadius (double)
virtual double	GetRadius ()

virtual void	SetCenter (double, double, double)
virtual void	SetCenter (double[3])
virtual double *	GetCenter ()
virtual void	GetCenter (double data[3])
Static Public Member Functions
int	IsTypeOf (const char *type)
vtkCylinder *	SafeDownCast (vtkObject *o)
vtkCylinder *	New ()
Protected Member Functions
	vtkCylinder ()
	~vtkCylinder ()
Protected Attributes
double	Radius
double	Center [3]