vtkConeSource Class Reference

#include <vtkConeSource.h>

Inheritance diagram for vtkConeSource:

Inheritance graph
[legend]
Collaboration diagram for vtkConeSource:

Collaboration graph
[legend]

List of all members.


Detailed Description

generate polygonal cone

vtkConeSource creates a cone centered at a specified point and pointing in a specified direction. (By default, the center is the origin and the direction is the x-axis.) Depending upon the resolution of this object, different representations are created. If resolution=0 a line is created; if resolution=1, a single triangle is created; if resolution=2, two crossed triangles are created. For resolution > 2, a 3D cone (with resolution number of sides) is created. It also is possible to control whether the bottom of the cone is capped with a (resolution-sided) polygon, and to specify the height and radius of the cone.

Examples:
vtkConeSource (Examples)
Tests:
vtkConeSource (Tests)

Definition at line 42 of file vtkConeSource.h.


Public Types

typedef vtkPolyDataAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetHeight (double)
virtual double GetHeight ()
virtual void SetRadius (double)
virtual double GetRadius ()
virtual void SetResolution (int)
virtual int GetResolution ()
virtual void SetCenter (double, double, double)
virtual void SetCenter (double[3])
virtual double * GetCenter ()
virtual void GetCenter (double data[3])
virtual void SetDirection (double, double, double)
virtual void SetDirection (double[3])
virtual double * GetDirection ()
virtual void GetDirection (double data[3])
void SetAngle (double angle)
double GetAngle ()
virtual void SetCapping (int)
virtual int GetCapping ()
virtual void CappingOn ()
virtual void CappingOff ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkConeSourceSafeDownCast (vtkObject *o)
static vtkConeSourceNew ()

Protected Member Functions

 vtkConeSource (int res=6)
 ~vtkConeSource ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

double Height
double Radius
int Resolution
int Capping
double Center [3]
double Direction [3]

Member Typedef Documentation

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 45 of file vtkConeSource.h.


Constructor & Destructor Documentation

vtkConeSource::vtkConeSource ( int  res = 6  )  [protected]

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

Definition at line 106 of file vtkConeSource.h.


Member Function Documentation

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

Reimplemented from vtkPolyDataAlgorithm.

static int vtkConeSource::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 vtkPolyDataAlgorithm.

virtual int vtkConeSource::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 vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

void vtkConeSource::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 vtkPolyDataAlgorithm.

static vtkConeSource* vtkConeSource::New (  )  [static]

Construct with default resolution 6, height 1.0, radius 0.5, and capping on. The cone is centered at the origin and points down the x-axis.

Reimplemented from vtkPolyDataAlgorithm.

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

Set the height of the cone. This is the height along the cone in its specified direction.

virtual double vtkConeSource::GetHeight (  )  [virtual]

Set the height of the cone. This is the height along the cone in its specified direction.

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

Set the base radius of the cone.

virtual double vtkConeSource::GetRadius (  )  [virtual]

Set the base radius of the cone.

virtual void vtkConeSource::SetResolution ( int   )  [virtual]

Set the number of facets used to represent the cone.

virtual int vtkConeSource::GetResolution (  )  [virtual]

Set the number of facets used to represent the cone.

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

Set the center of the cone. It is located at the middle of the axis of the cone. Warning: this is not the center of the base of the cone! The default is 0,0,0.

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

Set the center of the cone. It is located at the middle of the axis of the cone. Warning: this is not the center of the base of the cone! The default is 0,0,0.

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

Set the center of the cone. It is located at the middle of the axis of the cone. Warning: this is not the center of the base of the cone! The default is 0,0,0.

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

Set the center of the cone. It is located at the middle of the axis of the cone. Warning: this is not the center of the base of the cone! The default is 0,0,0.

virtual void vtkConeSource::SetDirection ( double  ,
double  ,
double   
) [virtual]

Set the orientation vector of the cone. The vector does not have to be normalized. The direction goes from the center of the base toward the apex. The default is (1,0,0).

virtual void vtkConeSource::SetDirection ( double  [3]  )  [virtual]

Set the orientation vector of the cone. The vector does not have to be normalized. The direction goes from the center of the base toward the apex. The default is (1,0,0).

virtual double* vtkConeSource::GetDirection (  )  [virtual]

Set the orientation vector of the cone. The vector does not have to be normalized. The direction goes from the center of the base toward the apex. The default is (1,0,0).

virtual void vtkConeSource::GetDirection ( double  data[3]  )  [virtual]

Set the orientation vector of the cone. The vector does not have to be normalized. The direction goes from the center of the base toward the apex. The default is (1,0,0).

void vtkConeSource::SetAngle ( double  angle  ) 

Set the angle of the cone. This is the angle between the axis of the cone and a generatrix. Warning: this is not the aperture! The aperture is twice this angle. As a side effect, the angle plus height sets the base radius of the cone. Angle is expressed in degrees.

double vtkConeSource::GetAngle (  ) 

Set the angle of the cone. This is the angle between the axis of the cone and a generatrix. Warning: this is not the aperture! The aperture is twice this angle. As a side effect, the angle plus height sets the base radius of the cone. Angle is expressed in degrees.

virtual void vtkConeSource::SetCapping ( int   )  [virtual]

Turn on/off whether to cap the base of the cone with a polygon.

virtual int vtkConeSource::GetCapping (  )  [virtual]

Turn on/off whether to cap the base of the cone with a polygon.

virtual void vtkConeSource::CappingOn (  )  [virtual]

Turn on/off whether to cap the base of the cone with a polygon.

virtual void vtkConeSource::CappingOff (  )  [virtual]

Turn on/off whether to cap the base of the cone with a polygon.

virtual int vtkConeSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

int vtkConeSource::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

double vtkConeSource::Height [protected]

Definition at line 111 of file vtkConeSource.h.

double vtkConeSource::Radius [protected]

Definition at line 112 of file vtkConeSource.h.

int vtkConeSource::Resolution [protected]

Definition at line 113 of file vtkConeSource.h.

int vtkConeSource::Capping [protected]

Definition at line 114 of file vtkConeSource.h.

double vtkConeSource::Center[3] [protected]

Definition at line 115 of file vtkConeSource.h.

double vtkConeSource::Direction[3] [protected]

Definition at line 116 of file vtkConeSource.h.


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

Generated on Wed Aug 24 11:32:01 2011 for VTK by  doxygen 1.5.6