vtkObject Class Reference

#include <vtkObject.h>

Inherited by vtkAbstractArray, vtkAbstractPicker, vtkAbstractTransform, vtkAdjacentVertexIterator, vtkAlgorithm, vtkAlgorithmOutput, vtkAmoebaMinimizer, vtkAnimationCue, vtkArrayIterator, vtkAssemblyNode, vtkBase64Utilities, vtkBSPCuts, vtkBSPIntersections, vtkByteSwap, vtkCamera, vtkCameraInterpolator, vtkCell, vtkCellArray, vtkCellLinks, vtkCellTypes, vtkCollection, vtkCollectionIterator, vtkCommunicator, vtkCompositeDataIterator, vtkCompositer, vtkContourLineInterpolator, vtkContourValues, vtkCoordinate, vtkCriticalSection, vtkCuller, vtkDataArraySelection, vtkDataCompressor, vtkDataObject, vtkDataObjectTypes, vtkDataRepresentation, vtkDebugLeaks, vtkDirectionEncoder, vtkDirectory, vtkDSPFilterDefinition, vtkDSPFilterGroup, vtkDynamicLoader, vtkEdgeListIterator, vtkEdgeSubdivisionCriterion, vtkEdgeTable, vtkEncodedGradientEstimator, vtkEncodedGradientShader, vtkEvent, vtkEventQtSlotConnect, vtkExecutive, vtkExodusIICache, vtkExodusIIReaderPrivate, vtkExodusModel, vtkExporter, vtkExtentSplitter, vtkExtentTranslator, vtkFastNumericConversion, vtkFieldData, vtkFixedPointRayCastImage, vtkFixedPointVolumeRayCastHelper, vtkFreeTypeUtilities, vtkFunctionParser, vtkFunctionSet, vtkGarbageCollector, vtkGenericAdaptorCell, vtkGenericAttribute, vtkGenericAttributeCollection, vtkGenericCellIterator, vtkGenericCellTessellator, vtkGenericEdgeTable, vtkGenericPointIterator, vtkGenericSubdivisionErrorMetric, vtkGenericVertexAttributeMapping, vtkGlobFileNames, vtkGraphEdge, vtkGraphicsFactory, vtkGraphLayoutStrategy, vtkHeap, vtkHyperOctreeCursor, vtkHyperOctreePointsGrabber, vtkIdList, vtkImageConnector, vtkImageOrthoPlanes, vtkImageReader2Factory, vtkImageViewer, vtkImageViewer2, vtkImagingFactory, vtkImplicitFunction, vtkImporter, vtkInEdgeIterator, vtkInformation, vtkInformationIterator, vtkInformationVector, vtkInitialValueProblemSolver, vtkInputStream, vtkInstantiator, vtkInteractorObserver, vtkKdNode, vtkLight, vtkLightKit, vtkLocator, vtkMaterialLibrary, vtkMath, vtkMatrix4x4, vtkMedicalImageProperties, vtkMergeCells, vtkMINCImageAttributes, vtkModelMetadata, vtkMPIEventLog, vtkMPIGroup, vtkMultiProcessController, vtkMultiThreader, vtkMutexLock, vtkObjectFactory, vtkObserverMediator, vtkOpenGLExtensionManager, vtkOrderedTriangulator, vtkOutEdgeIterator, vtkOutputStream, vtkOutputWindow, vtkOverrideInformation, vtkPainter, vtkPainterDeviceAdapter, vtkParallelRenderManager, vtkParametricFunction, vtkPipelineSize, vtkPointPlacer, vtkPoints, vtkPolynomialSolversUnivariate, vtkPriorityQueue, vtkProcessGroup, vtkProcessStatistics, vtkProp, vtkProperty, vtkProperty2D, vtkQtInitialization, vtkQtTimePointUtility, vtkQuaternionInterpolator, vtkRayCastImageDisplayHelper, vtkReferenceCount, vtkRenderWindowInteractor, vtkRowQuery, vtkScalarsToColors, vtkScalarTree, vtkScenePicker, vtkShader, vtkShaderCodeLibrary, vtkShaderDeviceAdapter, vtkShaderProgram, vtkSliceCubes, vtkSocket, vtkSortDataArray, vtkSortDataArray, vtkSortFileNames, vtkSpline, vtkSQLDatabase, vtkSQLDatabaseSchema, vtkStreamingTessellator, vtkStructuredData, vtkStructuredVisibilityConstraint, vtkSubGroup, vtkTensor, vtkTesting, vtkTextProperty, vtkThreadMessager, vtkTimePointUtility, vtkTimerLog, vtkTransformInterpolator, vtkTreeDFSIterator, vtkTreeMapLayoutStrategy, vtkTreeMapViewer, vtkTupleInterpolator, vtkUnstructuredGridVolumeRayCastFunction, vtkUnstructuredGridVolumeRayCastIterator, vtkUnstructuredGridVolumeRayIntegrator, vtkVersion, vtkVertexListIterator, vtkView, vtkViewport, vtkViewTheme, vtkVisibilitySort, vtkVisibleCellSelector, vtkVoidArray, vtkVolumeProperty, vtkVolumeRayCastFunction, vtkVolumeRenderingFactory, vtkWidgetCallbackMapper, vtkWidgetEvent, vtkWidgetEventTranslator, vtkWidgetSet, vtkWindow, vtkX3DExporterJavaHelper, vtkXMLDataElement, vtkXMLMaterial, vtkXMLMaterialReader, vtkXMLParser, vtkXMLShader, and vtkXMLUtilities.

Collaboration diagram for vtkObject:

[legend]

List of all members.

Detailed Description

abstract base class for most VTK objects

vtkObject is the base class for most objects in the visualization toolkit. vtkObject provides methods for tracking modification time, debugging, printing, and event callbacks. Most objects created within the VTK framework should be a subclass of vtkObject or one of its children. The few exceptions tend to be very small helper classes that usually never get instantiated or situations where multiple inheritance gets in the way. vtkObject also performs reference counting: objects that are reference counted exist as long as another object uses them. Once the last reference to a reference counted object is removed, the object will spontaneously destruct.

Warning:: Note: in VTK objects should always be created with the New() method and deleted with the Delete() method. VTK objects cannot be allocated off the stack (i.e., automatic objects) because the constructor is a protected method.

See also:: vtkCommand vtkTimeStamp

Events:: vtkCommand::ModifiedEvent vtkCommand::DeleteEvent

Examples:: vtkObject (Examples)

Tests:: vtkObject (Tests)

Definition at line 59 of file vtkObject.h.


Public Types
typedef vtkObjectBase	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
virtual void	PrintSelf (ostream &os, vtkIndent indent)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char event, void callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char event, vtkCommand )
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char event, vtkCommand )
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObject *o)
static vtkObject *	New ()
static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Protected Member Functions
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Attributes
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper

Member Typedef Documentation

typedef vtkObjectBase vtkObject::Superclass

Definition at line 62 of file vtkObject.h.

Constructor & Destructor Documentation

vtkObject::vtkObject ( ) [protected]

virtual vtkObject::~vtkObject ( ) [protected, virtual]

Member Function Documentation

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

static int vtkObject::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

virtual int vtkObject::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

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

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObjectBase.

virtual void vtkObject::DebugOn ( ) [virtual]

Turn debugging output on.

Reimplemented in vtkImageOpenClose3D.

virtual void vtkObject::DebugOff ( ) [virtual]

Turn debugging output off.

Reimplemented in vtkImageOpenClose3D.

unsigned char vtkObject::GetDebug ( )

Get the value of the debug flag.

void vtkObject::SetDebug ( unsigned char debugFlag )

Set the value of the debug flag. A non-zero value turns debugging on.

static void vtkObject::BreakOnError ( ) [static]

This method is called when vtkErrorMacro executes. It allows the debugger to break on error.

virtual void vtkObject::Modified ( ) [virtual]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.

Reimplemented in vtkImageOpenClose3D, vtkLightKit, and vtkLODActor.

virtual unsigned long vtkObject::GetMTime ( ) [virtual]

Return this object's modified time.

Reimplemented in vtkAbstractTransform, vtkAssemblyNode, vtkAssemblyPath, vtkAssemblyPaths, vtkGeneralTransform, vtkImplicitFunction, vtkMatrixToHomogeneousTransform, vtkMatrixToLinearTransform, vtkPerspectiveTransform, vtkTransform, vtkAbstractMapper, vtkActor2D, vtkDataObject, vtkDataSet, vtkFieldData, vtkGenericAttributeCollection, vtkGenericDataSet, vtkGraph, vtkImplicitBoolean, vtkImplicitDataSet, vtkImplicitSelectionLoop, vtkImplicitSum, vtkImplicitVolume, vtkImplicitWindowFunction, vtkPointSet, vtkPropAssembly, vtkSelection, vtkSpline, vtkTrivialProducer, vtkGenericClip, vtkGenericContourFilter, vtkGenericCutter, vtkGenericDataSetTessellator, vtkGenericGeometryFilter, vtkBridgeDataSet, vtkBandedPolyDataContourFilter, vtkBoxClipDataSet, vtkCleanPolyData, vtkClipDataSet, vtkClipHyperOctree, vtkClipPolyData, vtkClipVolume, vtkContourFilter, vtkContourGrid, vtkCutter, vtkDelaunay3D, vtkExtractEdges, vtkExtractGeometry, vtkExtractPolyDataGeometry, vtkExtractSelectedFrustum, vtkExtractUnstructuredGrid, vtkFeatureEdges, vtkGeometryFilter, vtkGridSynchronizedTemplates3D, vtkHyperOctreeContourFilter, vtkHyperOctreeCutter, vtkHyperOctreeDualGridContourFilter, vtkHyperOctreeSampleFunction, vtkHyperOctreeSurfaceFilter, vtkImageMarchingCubes, vtkKdTreeSelector, vtkMarchingContourFilter, vtkMarchingCubes, vtkMarchingSquares, vtkParametricFunctionSource, vtkRectilinearSynchronizedTemplates, vtkSelectPolyData, vtkSynchronizedTemplates2D, vtkSynchronizedTemplates3D, vtkTessellatorFilter, vtkTransformCoordinateSystems, vtkTransformFilter, vtkTransformPolyDataFilter, vtkUnstructuredGridGeometryFilter, vtkAnnotatedCubeActor, vtkArcPlotter, vtkAxesActor, vtkDepthSortPolyData, vtkExodusIIReader, vtkGridTransform, vtkIterativeClosestPointTransform, vtkLandmarkTransform, vtkThinPlateSplineTransform, vtkTransformToGrid, vtkWeightedTransformFilter, vtkXYPlotActor, vtkImageMapToColors, vtkImageOpenClose3D, vtkImageReslice, vtkImageSeparableConvolution, vtkSampleFunction, vtkGraphLayout, vtkGraphMapper, vtkTableToGraph, vtkTreeMapLayout, vtkMCubesReader, vtkRowQueryToTable, vtkSTLReader, vtkUGFacetReader, vtkExtractCTHPart, vtkHandleRepresentation, vtkLineRepresentation, vtkSliderRepresentation3D, vtkActor, vtkAssembly, vtkCameraInterpolator, vtkDataSetMapper, vtkExporter, vtkImageMapper, vtkMapper, vtkPolyDataMapper2D, vtkProp3D, vtkRenderer, vtkRendererSource, vtkSelectVisiblePoints, vtkTexturedActor2D, vtkTransformInterpolator, vtkVolume, and vtkVolumeProperty.

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

static void vtkObject::SetGlobalWarningDisplay ( int val ) [static]

This is a global flag that controls whether any debug, warning or error messages are displayed.

static void vtkObject::GlobalWarningDisplayOn ( ) [inline, static]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 109 of file vtkObject.h.

static void vtkObject::GlobalWarningDisplayOff ( ) [inline, static]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 110 of file vtkObject.h.

static int vtkObject::GetGlobalWarningDisplay ( ) [static]

This is a global flag that controls whether any debug, warning or error messages are displayed.

unsigned long vtkObject::AddObserver	(	unsigned long	event,
		vtkCommand *	,
		float	priority = `0.0f`
	)

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

unsigned long vtkObject::AddObserver	(	const char *	event,
		vtkCommand *	,
		float	priority = `0.0f`
	)

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

vtkCommand* vtkObject::GetCommand ( unsigned long tag )

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

void vtkObject::RemoveObserver ( vtkCommand * )

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

void vtkObject::RemoveObservers	(	unsigned long	event,
		vtkCommand *
	)

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

void vtkObject::RemoveObservers	(	const char *	event,
		vtkCommand *
	)

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

int vtkObject::HasObserver	(	unsigned long	event,
		vtkCommand *
	)

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

int vtkObject::HasObserver	(	const char *	event,
		vtkCommand *
	)

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

void vtkObject::RemoveObserver ( unsigned long tag )

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

void vtkObject::RemoveObservers ( unsigned long event )

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

void vtkObject::RemoveObservers ( const char * event )

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

void vtkObject::RemoveAllObservers ( )

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

int vtkObject::HasObserver ( unsigned long event )

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

int vtkObject::HasObserver ( const char * event )

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.) BTX

int vtkObject::InvokeEvent	(	unsigned long	event,
		void *	callData
	)

Allow people to add/remove/invoke observers (callbacks) to any VTK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and a vtkCommand to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. When events are invoked, the observers are called in the order they were added. If a priority value is specified, then the higher priority commands are called first. A command may set an abort flag to stop processing of the event. (See vtkCommand.h for more information.)

int vtkObject::InvokeEvent	(	const char *	event,
		void *	callData
	)

int vtkObject::InvokeEvent ( unsigned long event ) [inline]

Definition at line 161 of file vtkObject.h.

int vtkObject::InvokeEvent ( const char * event ) [inline]

Definition at line 162 of file vtkObject.h.

virtual void vtkObject::RegisterInternal	(	vtkObjectBase *	,
		int	check
	)			`[protected, virtual]`

Reimplemented from vtkObjectBase.

virtual void vtkObject::UnRegisterInternal	(	vtkObjectBase *	,
		int	check
	)			`[protected, virtual]`

Reimplemented from vtkObjectBase.

void vtkObject::InternalGrabFocus	(	vtkCommand *	mouseEvents,
		vtkCommand *	keypressEvents = `NULL`
	)			`[protected]`

These methods allow a command to exclusively grab all events. (This method is typically used by widgets to grab events once an event sequence begins.) These methods are provided in support of the public methods found in the class vtkInteractorObserver. Note that these methods are designed to support vtkInteractorObservers since they use two separate vtkCommands to watch for mouse and keypress events. BTX

void vtkObject::InternalReleaseFocus ( ) [protected]

These methods allow a command to exclusively grab all events. (This method is typically used by widgets to grab events once an event sequence begins.) These methods are provided in support of the public methods found in the class vtkInteractorObserver. Note that these methods are designed to support vtkInteractorObservers since they use two separate vtkCommands to watch for mouse and keypress events. BTX

Member Data Documentation

unsigned char vtkObject::Debug [protected]

Definition at line 172 of file vtkObject.h.

vtkTimeStamp vtkObject::MTime [protected]

Definition at line 173 of file vtkObject.h.

vtkSubjectHelper* vtkObject::SubjectHelper [protected]

Definition at line 174 of file vtkObject.h.

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

dox/Common/vtkObject.h

vtkObject Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation