vtkContourValues Class Reference

#include <vtkContourValues.h>

Inheritance diagram for vtkContourValues:

Inheritance graph
[legend]
Collaboration diagram for vtkContourValues:

Collaboration graph
[legend]

List of all members.


Detailed Description

helper object to manage setting and generating contour values

vtkContourValues is a general class to manage the creation, generation, and retrieval of contour values. This class serves as a helper class for contouring classes, or those classes operating on lists of contour values.

See also:
vtkContourFilter

Definition at line 33 of file vtkContourValues.h.


Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetValue (int i, double value)
double GetValue (int i)
double * GetValues ()
void GetValues (double *contourValues)
void SetNumberOfContours (const int number)
int GetNumberOfContours ()
void GenerateValues (int numContours, double range[2])
void GenerateValues (int numContours, double rangeStart, double rangeEnd)

Static Public Member Functions

static vtkContourValuesNew ()
static int IsTypeOf (const char *type)
static vtkContourValuesSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkContourValues ()
 ~vtkContourValues ()

Protected Attributes

vtkDoubleArrayContours

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 39 of file vtkContourValues.h.


Constructor & Destructor Documentation

vtkContourValues::vtkContourValues (  )  [protected]

vtkContourValues::~vtkContourValues (  )  [protected]


Member Function Documentation

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

Construct object with a single contour value at 0.0.

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

static int vtkContourValues::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 vtkObject.

virtual int vtkContourValues::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 vtkObject.

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

Reimplemented from vtkObject.

void vtkContourValues::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 vtkObject.

void vtkContourValues::SetValue ( int  i,
double  value 
)

Set the ith contour value.

double vtkContourValues::GetValue ( int  i  ) 

Get the ith contour value. The return value will be clamped if the index i is out of range.

double* vtkContourValues::GetValues (  ) 

Return a pointer to a list of contour values. The contents of the list will be garbage if the number of contours <= 0.

void vtkContourValues::GetValues ( double *  contourValues  ) 

Fill a supplied list with contour values. Make sure you've allocated memory of size GetNumberOfContours().

void vtkContourValues::SetNumberOfContours ( const int  number  ) 

Set the number of contours to place into the list. You only really need to use this method to reduce list size. The method SetValue() will automatically increase list size as needed.

int vtkContourValues::GetNumberOfContours (  ) 

Return the number of contours in the

void vtkContourValues::GenerateValues ( int  numContours,
double  range[2] 
)

Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.

void vtkContourValues::GenerateValues ( int  numContours,
double  rangeStart,
double  rangeEnd 
)

Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.


Member Data Documentation

Definition at line 78 of file vtkContourValues.h.


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

Generated on Mon Sep 27 18:20:51 2010 for VTK by  doxygen 1.5.6