vtkContourValues Class Reference

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

#include <vtkContourValues.h>

Inheritance diagram for vtkContourValues:

Collaboration diagram for vtkContourValues:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkContourValues *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
void	SetValue (int i, double value)
	Set the ith contour value. More...
double	GetValue (int i)
	Get the ith contour value. More...
double *	GetValues ()
	Return a pointer to a list of contour values. More...
void	GetValues (double *contourValues)
	Fill a supplied list with contour values. More...
void	SetNumberOfContours (const int number)
	Set the number of contours to place into the list. More...
int	GetNumberOfContours ()
	Return the number of contours in the. More...
void	GenerateValues (int numContours, double range[2])
	Generate numContours equally spaced contour values between specified range. More...
void	GenerateValues (int numContours, double rangeStart, double rangeEnd)
	Generate numContours equally spaced contour values between specified range. More...
void	DeepCopy (vtkContourValues *other)
	Copy contours. More...
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on. More...
virtual void	DebugOff ()
	Turn debugging output off. More...
bool	GetDebug ()
	Get the value of the debug flag. More...
void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...
virtual void	Modified ()
	Update the modification time for this object. More...
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
virtual void	Delete ()
	Delete a VTK object. More...
virtual void	FastDelete ()
	Delete a reference to this object. More...
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream. More...
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkContourValues *	New ()
	Construct object with a single contour value at 0.0. More...
static vtkTypeBool	IsTypeOf (const char *type)
static vtkContourValues *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkContourValues ()
	~vtkContourValues () override
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkDoubleArray *	Contours
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Online Examples:

RayCastIsosurface

Definition at line 54 of file vtkContourValues.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkContourValues::Superclass

Definition at line 62 of file vtkContourValues.h.

Constructor & Destructor Documentation

vtkContourValues()

vtkContourValues::vtkContourValues ( )

protected

~vtkContourValues()

vtkContourValues::~vtkContourValues ( )

overrideprotected

Member Function Documentation

New()

static vtkContourValues * vtkContourValues::New ( )

static

Construct object with a single contour value at 0.0.

IsTypeOf()

static vtkTypeBool vtkContourValues::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool 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 vtkObjectBase.

SafeDownCast()

static vtkContourValues * vtkContourValues::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkContourValues::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkContourValues * vtkContourValues::NewInstance

(

)

const

PrintSelf()

void vtkContourValues::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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.

SetValue()

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

Set the ith contour value.

GetValue()

double vtkContourValues::GetValue

(

int

i

)

Get the ith contour value.

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

GetValues() [1/2]

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.

GetValues() [2/2]

void vtkContourValues::GetValues

(

double *

contourValues

)

Fill a supplied list with contour values.

Make sure you've allocated memory of size GetNumberOfContours().

SetNumberOfContours()

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.

GetNumberOfContours()

int vtkContourValues::GetNumberOfContours

(

)

Return the number of contours in the.

GenerateValues() [1/2]

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.

GenerateValues() [2/2]

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.

DeepCopy()

void vtkContourValues::DeepCopy

(

vtkContourValues *

other

)

Copy contours.

Member Data Documentation

Contours

vtkDoubleArray* vtkContourValues::Contours

protected

Definition at line 121 of file vtkContourValues.h.

---

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

• Common/Misc/vtkContourValues.h