---

vtkContourValues Class Reference

helper object to manage setting and generating contour values. More...

#include <vtkContourValues.h>

Inheritance diagram for vtkContourValues:

[legend]Collaboration diagram for vtkContourValues:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetValue (int i, float value)
float	GetValue (int i)
float *	GetValues ()
void	GetValues (float *contourValues)
void	SetNumberOfContours (const int number)
int	GetNumberOfContours ()
void	GenerateValues (int numContours, float range[2])
void	GenerateValues (int numContours, float rangeStart, float rangeEnd)
Static Public Methods
vtkContourValues *	New ()
int	IsTypeOf (const char *type)
vtkContourValues *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkContourValues ()
	~vtkContourValues ()
	vtkContourValues (const vtkContourValues &)
void	operator= (const vtkContourValues &)
Protected Attributes
vtkFloatArray *	Contours

---

Detailed Description

helper object to manage setting and generating contour values.

Date:

2000/12/10 20:08:07

Revision:

1.16

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 61 of file vtkContourValues.h.

---

Constructor & Destructor Documentation

vtkContourValues::vtkContourValues (    )  [protected]

vtkContourValues::~vtkContourValues (    )  [protected]

vtkContourValues::vtkContourValues (  const vtkContourValues &    )  [inline, protected]

Definition at line 105 of file vtkContourValues.h.

---

Member Function Documentation

vtkContourValues* vtkContourValues::New (    )  [static]

Construct object with a single contour value at 0.0. Reimplemented from vtkObject.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject.

int vtkContourValues::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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject.

virtual int vtkContourValues::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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkObject.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. 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, float    value )

Set the ith contour value. Referenced by vtkMarchingSquares::SetValue(), vtkMarchingCubes::SetValue(), vtkMarchingContourFilter::SetValue(), vtkImageMarchingCubes::SetValue(), vtkContourGrid::SetValue(), and vtkContourFilter::SetValue().

float vtkContourValues::GetValue (  int    i )

Get the ith contour value. The return value will be clamped if the index i is out of range. Referenced by vtkMarchingSquares::GetValue(), vtkMarchingCubes::GetValue(), vtkMarchingContourFilter::GetValue(), vtkImageMarchingCubes::GetValue(), vtkContourGrid::GetValue(), and vtkContourFilter::GetValue().

float* 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. Referenced by vtkMarchingSquares::GetValues(), vtkMarchingCubes::GetValues(), vtkMarchingContourFilter::GetValues(), vtkImageMarchingCubes::GetValues(), vtkContourGrid::GetValues(), and vtkContourFilter::GetValues().

void vtkContourValues::GetValues (  float *    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. Referenced by vtkMarchingSquares::SetNumberOfContours(), vtkMarchingCubes::SetNumberOfContours(), vtkMarchingContourFilter::SetNumberOfContours(), vtkImageMarchingCubes::SetNumberOfContours(), vtkContourGrid::SetNumberOfContours(), and vtkContourFilter::SetNumberOfContours().

int vtkContourValues::GetNumberOfContours (    )

Return the number of contours in the Referenced by vtkMarchingSquares::GetNumberOfContours(), vtkMarchingCubes::GetNumberOfContours(), vtkMarchingContourFilter::GetNumberOfContours(), vtkImageMarchingCubes::GetNumberOfContours(), vtkContourGrid::GetNumberOfContours(), and vtkContourFilter::GetNumberOfContours().

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

Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values. Referenced by vtkMarchingSquares::GenerateValues(), vtkMarchingCubes::GenerateValues(), vtkMarchingContourFilter::GenerateValues(), vtkImageMarchingCubes::GenerateValues(), vtkContourGrid::GenerateValues(), and vtkContourFilter::GenerateValues().

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

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

void vtkContourValues::operator= (  const vtkContourValues &    )  [inline, protected]

Definition at line 106 of file vtkContourValues.h.

---

Member Data Documentation

vtkFloatArray* vtkContourValues::Contours [protected]

Definition at line 108 of file vtkContourValues.h.

---

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

• common/vtkContourValues.h

---