vtkObject - abstract base class for most of the vtk objects

Description:

vtkObject is the base class for many objects in the visualization toolkit. vtkObject provides methods for tracking modification times, debugging, and printing. 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. Typically only data objects that are passed between objects are reference counted.

Caveats:

Note: in vtk objects should always be created with combinations of new/Delete() methods. This does not work when objects are allocated off the stack (i.e., automatic objects). Automatic objects, when automatically deleted (by exiting scope), will cause warnings to occur. You should not create vtkObjects in this manner.

Methods:

• vtkObject ();
• virtual ~vtkObject ();
• virtual char *GetClassName ();
• virtual void Delete ();
• vtkObject *New ();
• virtual void DebugOn ();
• virtual void DebugOff ();
• unsigned char GetDebug ();
• void SetDebug (unsigned char debugFlag);
• void BreakOnError ();
• virtual unsigned long GetMTime ();
• virtual void Modified ();
• virtual void PrintSelf (ostream &os, vtkIndent indent);
• void Print (ostream &os);
• virtual void PrintHeader (ostream &os, vtkIndent indent);
• virtual void PrintTrailer (ostream &os, vtkIndent indent);
• void SetGlobalWarningDisplay (int val);
• void GlobalWarningDisplayOn ();
• void GlobalWarningDisplayOff ();
• int GetGlobalWarningDisplay ();
• void Register (vtkObject *o);
• virtual void UnRegister (vtkObject *o);
• int GetReferenceCount ();
• void SetReferenceCount (int );

Detailed Method Descriptions:

• virtual char *GetClassName ();

Return the class name as a string.

• virtual void Delete ();

Delete a vtk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

• vtkObject *New ();

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

• virtual void DebugOn ();

Turn debugging output on.

• virtual void DebugOff ();

Turn debugging output off.

• unsigned char GetDebug ();

Get the value of the debug flag.

• void SetDebug (unsigned char debugFlag);

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

• void BreakOnError ();

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

• virtual unsigned long GetMTime ();

Return this objects modified time.

• virtual void Modified ();

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

• virtual void PrintSelf (ostream &os, vtkIndent indent);

Chaining method to print an object's instance variables, as well as its superclasses.

• void Print (ostream &os);

Print an object to an ostream.

• virtual void PrintHeader (ostream &os, vtkIndent indent);
• virtual void PrintTrailer (ostream &os, vtkIndent indent);

Support methods for the printing process.

• void SetGlobalWarningDisplay (int val);
• void GlobalWarningDisplayOn ();
• void GlobalWarningDisplayOff ();
• int GetGlobalWarningDisplay ();

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

• void Register (vtkObject *o);

Increase the reference count (mark as used by another object).

• virtual void UnRegister (vtkObject *o);

Decrease the reference count (release by another object).

• void SetReferenceCount (int );

Sets the reference count (use with care)