abstract base class for most VTK objects More...

#include <vtkObject.h>

Inherited by vtkAbstractArray, vtkAbstractContextBufferId, vtkAbstractContextItem, vtkAbstractGridConnectivity, vtkAbstractImageInterpolator, vtkAbstractPicker, vtkAbstractTransform, vtkAdjacentVertexIterator, vtkAlgorithm, vtkAlgorithmOutput, vtkAmoebaMinimizer, vtkAMRDataInternals, vtkAMRDataSetCache, vtkAMRInformation, vtkAMRUtilities, vtkAnimationCue, vtkAreaLayoutStrategy, vtkArray, vtkArrayIterator, vtkAssemblyNode, vtkAxisExtended, vtkBackgroundColorMonitor, vtkBase64Utilities, vtkBlueObeliskData, vtkBrush, vtkBSPIntersections, vtkByteSwap, vtkCamera, vtkCameraInterpolator, vtkCell, vtkCellArray, vtkCellIterator, vtkCellLinks, vtkCellTypes, vtkCirclePackLayoutStrategy, vtkCocoaTkUtilities, vtkCoincidentPoints, vtkCollection, vtkCollectionIterator, vtkColorMaterialHelper, vtkColorSeries, vtkCommunicator, vtkCompositeDataDisplayAttributes, vtkCompositeDataIterator, vtkCompositer, vtkConditionVariable, vtkContext2D, vtkContext3D, vtkContextDevice2D, vtkContextDevice3D, vtkContextScene, vtkContourLineInterpolator, vtkContourValues, vtkCoordinate, vtkCPExodusIIElementBlockImpl, vtkCriticalSection, vtkCuller, vtkDataArraySelection, vtkDataCompressor, vtkDataEncoder, vtkDataObject, vtkDataObjectTypes, vtkDataTransferHelper, vtkDebugLeaks, vtkDirectionEncoder, vtkDirectory, vtkDistributedGraphHelper, vtkDSPFilterDefinition, vtkDSPFilterGroup, vtkDynamicLoader, vtkEdgeLayoutStrategy, vtkEdgeListIterator, vtkEdgeSubdivisionCriterion, vtkEdgeTable, vtkEncodedGradientEstimator, vtkEncodedGradientShader, vtkEvent, vtkEventQtSlotConnect, vtkExecutionTimer, vtkExecutive, vtkExodusIICache, vtkExodusIIReaderPrivate, vtkExodusModel, vtkExporter, vtkExtentRCBPartitioner, vtkExtentSplitter, vtkExtentTranslator, vtkFastNumericConversion, vtkFieldData, vtkFieldDataSerializer, vtkFixedPointRayCastImage, vtkFixedPointVolumeRayCastHelper, vtkFrameBufferObject, vtkFrameBufferObject2, vtkFreeTypeTools, vtkFreeTypeUtilities, vtkFunctionParser, vtkFunctionSet, vtkGarbageCollector, vtkGenericAdaptorCell, vtkGenericAttribute, vtkGenericAttributeCollection, vtkGenericCellIterator, vtkGenericCellTessellator, vtkGenericEdgeTable, vtkGenericPointIterator, vtkGenericSubdivisionErrorMetric, vtkGenericVertexAttributeMapping, vtkGeoCamera, vtkGeoMath, vtkGeoProjection, vtkGeoSource, vtkGeoTerrain, vtkGeoTreeNode, vtkGeoTreeNodeCache, vtkGhostArray, vtkGL2PSUtilities, vtkGlobFileNames, vtkGPUInfo, vtkGPUInfoList, vtkGraphEdge, vtkGraphicsFactory, vtkGraphInternals, vtkGraphLayoutStrategy, vtkHardwareSelector, vtkHeap, vtkHierarchicalGraphPipeline, vtkHyperOctreeCursor, vtkHyperOctreePointsGrabber, vtkHyperTree, vtkHyperTreeCursor, vtkIdList, vtkImageConnector, vtkImageOrthoPlanes, vtkImageProperty, vtkImageReader2Factory, vtkImageViewer, vtkImageViewer2, vtkImplicitFunction, vtkImporter, vtkIncrementalForceLayout, vtkIncrementalOctreeNode, vtkInEdgeIterator, vtkInformation, vtkInformationIterator, vtkInformationVector, vtkInitialValueProblemSolver, vtkInputStream, vtkInstantiator, vtkInteractorObserver, vtkKdNode, vtkKMeansDistanceFunctor, vtkLabelHierarchyIterator, vtkLabelRenderStrategy, vtkLight, vtkLightingHelper, vtkLightKit, vtkLineIntegralConvolution2D, vtkLocator, vtkLSDynaPart, vtkLSDynaPartCollection, vtkMarkerUtilities, vtkMath, vtkMathTextUtilities, vtkMatrix3x3, vtkMatrix4x4, vtkMeanValueCoordinatesInterpolator, vtkMedicalImageProperties, vtkMergeCells, vtkMINCImageAttributes, vtkModelMetadata, vtkMPIEventLog, vtkMultiProcessController, vtkMultiThreader, vtkMutableGraphHelper, vtkMutexLock, vtkNamedColors, vtkObjectFactory, vtkObjectIdMap, vtkObserverMediator, vtkOctreePointLocatorNode, vtkOpenGLHardwareSupport, vtkOpenGLLightMonitor, vtkOpenGLModelViewProjectionMonitor, vtkOrderedTriangulator, vtkOutEdgeIterator, vtkOutputStream, vtkOutputWindow, vtkOverrideInformation, vtkPainter, vtkPainterDeviceAdapter, vtkParallelRenderManager, vtkParallelTimer, vtkParametricFunction, vtkPen, vtkPeriodicTable, vtkPickingManager, vtkPipelineSize, vtkPistonScalarsColors, vtkPixelBufferObject, vtkPointPlacer, vtkPoints, vtkPoints2D, vtkPolynomialSolversUnivariate, vtkPriorityQueue, vtkProcess, vtkProcessGroup, vtkProgressObserver, vtkProp, vtkProperty, vtkProperty2D, vtkPUnstructuredGridConnectivity, vtkQtInitialization, vtkQtTimePointUtility, vtkQuadratureSchemeDefinition, vtkQuaternionInterpolator, vtkRAdapter, vtkRandomSequence, vtkRayCastImageDisplayHelper, vtkReebGraphSimplificationMetric, vtkReferenceCount, vtkRenderbuffer, vtkRendererDelegate, vtkRenderPass, vtkRenderWindowInteractor, vtkResliceCursor, vtkResliceImageViewerMeasurements, vtkRInterface, vtkRowQuery, vtkScalarsToColors, vtkScalarTree, vtkScenePicker, vtkSelectionNode, vtkShader2, vtkShaderDeviceAdapter2, vtkShaderProgram2, vtkSILBuilder, vtkSliceCubes, vtkSocket, vtkSortDataArray, vtkSortFileNames, vtkSpline, vtkSQLDatabase, vtkSQLDatabaseSchema, vtkStreamingTessellator, vtkStringToImage, vtkStructuredData, vtkStructuredExtent, vtkStructuredVisibilityConstraint, vtkSubGroup, vtkSurfaceLICComposite, vtkSynchronizedRenderers, vtkSynchronizedRenderWindows, vtkTDxDevice, vtkTDxInteractorStyle, vtkTDxInteractorStyleSettings, vtkTensor, vtkTesting, vtkTestNewVar, vtkTextCodec, vtkTextCodecFactory, vtkTextProperty, vtkTextRenderer, vtkTextureObject, vtkTextureUnitManager, vtkThreadMessager, vtkTimePointUtility, vtkTimerLog, vtkTransform2D, vtkTransformInterpolator, vtkTreeIterator, vtkTupleInterpolator, vtkUniformVariables, vtkUnstructuredGridVolumeRayCastFunction, vtkUnstructuredGridVolumeRayCastIterator, vtkUnstructuredGridVolumeRayIntegrator, vtkVersion, vtkVertexListIterator, vtkView, vtkViewport, vtkViewTheme, vtkViewUpdater, vtkVisibilitySort, vtkVoidArray, vtkVolumeProperty, vtkVolumeRayCastFunction, vtkWebApplication, vtkWebGLDataSet, vtkWebGLExporter, vtkWebGLObject, vtkWebInteractionEvent, vtkWebUtilities, vtkWidgetCallbackMapper, vtkWidgetEvent, vtkWidgetEventTranslator, vtkWidgetSet, vtkWindow, vtkX3DExporterJavaHelper, vtkX3DExporterWriter, vtkXdmfDataArray, vtkXMLDataElement, vtkXMLHierarchicalBoxDataFileConverter, vtkXMLParser, and vtkXMLUtilities.

Collaboration diagram for vtkObject:

[legend]

List of all members.

Public Types
typedef vtkObjectBase	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkObject *	NewInstance () const
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)

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char event, void callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
Protected Attributes
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
void	InternalReleaseFocus ()
class	vtkObjectCommandInternal

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

Member Typedef Documentation

typedef vtkObjectBase vtkObject::Superclass

Definition at line 64 of file vtkObject.h.

Constructor & Destructor Documentation

vtkObject::vtkObject ( ) [protected]

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

Member Function Documentation

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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

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

virtual vtkObjectBase* vtkObject::NewInstanceInternal ( ) const [protected, virtual]

vtkObject* vtkObject::NewInstance ( ) const

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 vtkLightKit, vtkMultiBlockPLOT3DReader, vtkLODActor, vtkMappedDataArray< Scalar >, vtkInformation, and vtkImageOpenClose3D.

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

Return this object's modified time.

Reimplemented in vtkXYPlotActor, vtkRenderer, vtkGraph, vtkPerspectiveTransform, vtkTransform, vtkImageReslice, vtkGlyph3D, vtkProp3D, vtkAbstractTransform, vtkGeneralTransform, vtkFieldData, vtkApplyColors, vtkDataSet, vtkDelaunay3D, vtkGraphMapper, vtkDiscretizableColorTransferFunction, vtkLineRepresentation, vtkLabeledDataMapper, vtkCameraInterpolator, vtkMappedUnstructuredGrid< Implementation, CellIterator >, vtkClipVolume, vtkParametricFunctionSource, vtkHyperTreeGridSource, vtkUnstructuredGridGeometryFilter, vtkIterativeClosestPointTransform, vtkTransformInterpolator, vtkSelectPolyData, vtkImageProperty, vtkClipDataSet, vtkHyperOctreeSampleFunction, vtkPolyDataMapper2D, vtkGenericClip, vtkHyperOctreeContourFilter, vtkGenericDataSet, vtkClipHyperOctree, vtkImageResliceMapper, vtkCleanPolyData, vtkGeometryFilter, vtkClipPolyData, vtkMNITagPointWriter, vtkSliderRepresentation3D, vtkActor, vtkSampleFunction, vtkMCubesReader, vtkPolyDataSilhouette, vtkHyperOctreeDualGridContourFilter, vtkArcPlotter, vtkAssembly, vtkImageThresholdConnectivity, vtkGenericGeometryFilter, vtkHandleRepresentation, vtkHyperOctreeCutter, vtkTextMapper, vtkExtractUnstructuredGrid, vtkImageResize, vtkSpline, vtkDepthSortPolyData, vtkCutter, vtkBoxClipDataSet, vtkLabelPlacer, vtkBandedPolyDataContourFilter, vtkResliceCursor, vtkTransform2D, vtkSelectVisiblePoints, vtkGenericAttributeCollection, vtkTableToGraph, vtkBridgeDataSet, vtkExtractCTHPart, vtkConvexHull2D, vtkTableBasedClipDataSet, vtkTransformToGrid, vtkFeatureEdges, vtkActor2D, vtkResliceCursorPolyDataAlgorithm, vtkAxesActor, vtkThinPlateSplineTransform, vtkGraphToGlyphs, vtkImplicitSelectionLoop, vtkGenericCutter, vtkSelectionNode, vtkQtTreeRingLabelMapper, vtkAnnotation, vtkSelection, vtkImageSliceMapper, vtkPropAssembly, vtkAnnotatedCubeActor, vtkGraphAnnotationLayersFilter, vtkBSplineTransform, vtkCirclePackLayout, vtkMapper, vtkKdTreeSelector, vtkVolume, vtkAnnotationLink, vtkGridTransform, vtkLassoStencilSource, vtkAnnotationLayers, vtkContourFilter, vtkImageSlice, vtkImageStack, vtkMarchingContourFilter, vtkLightActor, vtkGenericDataSetTessellator, vtkWeightedTransformFilter, vtkTreeMapLayout, vtkTessellatorFilter, vtkSplineGraphEdges, vtkContourGrid, vtkImageResliceToColors, vtkExporter, vtkGenericContourFilter, vtkImplicitWindowFunction, vtkLandmarkTransform, vtkAreaLayout, vtkMarchingSquares, vtkImageMapToColors, vtkAssemblyNode, vtkDataObject, vtkTransformCoordinateSystems, vtkAssemblyPath, vtkImplicitBoolean, vtkGeoAdaptiveArcs, vtkImageMarchingCubes, vtkFrustumSource, vtkPointSet, vtkCameraActor, vtkResliceCursorActor, vtkExodusIIReader, vtkVolumeProperty, vtkTexturedActor2D, vtkPolyPlane, vtkDistanceToCamera, vtkMarchingCubes, vtkImageSeparableConvolution, vtkGraphLayout, vtkImplicitFunction, vtkRowQueryToTable, vtkHyperOctreeSurfaceFilter, vtkSTLReader, vtkImplicitDataSet, vtkImplicitVolume, vtkExtractGeometry, vtkDataSetMapper, vtkImplicitSum, vtkTrivialProducer, vtkExtractSelectedFrustum, vtkMatrixToLinearTransform, vtkImplicitPolyDataDistance, vtkExtractPolyDataGeometry, vtkTransformPolyDataFilter, vtkAbstractMapper, vtkExtractEdges, vtkImplicitFunctionToImageStencil, vtkAssemblyPaths, vtkMatrixToHomogeneousTransform, vtkTransformFilter, vtkImageOpenClose3D, vtkEdgeLayout, vtkRendererSource, vtkRectilinearSynchronizedTemplates, vtkClipConvexPolyData, vtkSynchronizedTemplates3D, vtkImageMapper, vtkSynchronizedTemplates2D, vtkGridSynchronizedTemplates3D, vtkUGFacetReader, and vtkShader2Collection.

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 111 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 112 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.)

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.)

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.)

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.)

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.)

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.)

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.)

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.)

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.)

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.)

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.)

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.)

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.)

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.)

template<class U , class T >

unsigned long vtkObject::AddObserver	(	unsigned long	event,
		U	observer,
		void(T::*)()	callback,
		float	priority = `0.0f`
	)		`[inline]`

Overloads to AddObserver that allow developers to add class member functions as callbacks for events. The callback function can be one of these two types:

 void foo(void);\n void foo(vtkObject*,
      unsigned long, void*);

If the callback is a member of a vtkObjectBase-derived object, then the callback will automatically be disabled if the object destructs (but the observer will not automatically be removed). If the callback is a member of any other type of object, then the observer must be removed before the object destructs or else its dead pointer will be used the next time the event occurs. Typical usage of these functions is as follows:

      SomeClassOfMine* observer = SomeClassOfMine::New();\n
      to_observe->AddObserver(event, observer,
      \&SomeClassOfMine::SomeMethod);

Note that this does not affect the reference count of a vtkObjectBase-derived observer, which can be safely deleted with the observer still in place. For non-vtkObjectBase observers, the observer should never be deleted before it is removed. Return value is a tag that can be used to remove the observer.

Definition at line 168 of file vtkObject.h.

template<class U , class T >

unsigned long vtkObject::AddObserver	(	unsigned long	event,
		U	observer,
		void(T::)(vtkObject , unsigned long, void *)	callback,
		float	priority = `0.0f`
	)		`[inline]`

Overloads to AddObserver that allow developers to add class member functions as callbacks for events. The callback function can be one of these two types:

 void foo(void);\n void foo(vtkObject*,
      unsigned long, void*);

If the callback is a member of a vtkObjectBase-derived object, then the callback will automatically be disabled if the object destructs (but the observer will not automatically be removed). If the callback is a member of any other type of object, then the observer must be removed before the object destructs or else its dead pointer will be used the next time the event occurs. Typical usage of these functions is as follows:

      SomeClassOfMine* observer = SomeClassOfMine::New();\n
      to_observe->AddObserver(event, observer,
      \&SomeClassOfMine::SomeMethod);

Note that this does not affect the reference count of a vtkObjectBase-derived observer, which can be safely deleted with the observer still in place. For non-vtkObjectBase observers, the observer should never be deleted before it is removed. Return value is a tag that can be used to remove the observer.

Definition at line 178 of file vtkObject.h.

template<class U , class T >

unsigned long vtkObject::AddObserver	(	unsigned long	event,
		U	observer,
		bool(T::)(vtkObject , unsigned long, void *)	callback,
		float	priority = `0.0f`
	)		`[inline]`

Allow user to set the AbortFlagOn() with the return value of the callback method.

Definition at line 194 of file vtkObject.h.

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

This method invokes an event and return whether the event was aborted or not. If the event was aborted, the return value is 1, otherwise it is 0.

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

This method invokes an event and return whether the event was aborted or not. If the event was aborted, the return value is 1, otherwise it is 0.

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

This method invokes an event and return whether the event was aborted or not. If the event was aborted, the return value is 1, otherwise it is 0.

Definition at line 215 of file vtkObject.h.

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

This method invokes an event and return whether the event was aborted or not. If the event was aborted, the return value is 1, otherwise it is 0.

Definition at line 216 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.

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.

Friends And Related Function Documentation

friend class vtkObjectCommandInternal [friend]

Called by templated variants of AddObserver.

Definition at line 374 of file vtkObject.h.

Member Data Documentation

unsigned char vtkObject::Debug [protected]

Definition at line 227 of file vtkObject.h.

vtkTimeStamp vtkObject::MTime [protected]

Definition at line 228 of file vtkObject.h.

vtkSubjectHelper* vtkObject::SubjectHelper [protected]

Definition at line 229 of file vtkObject.h.

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

dox/Common/Core/vtkObject.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation