VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkBackgroundColorMonitor Class Reference

#include <vtkBackgroundColorMonitor.h>

Inheritance diagram for vtkBackgroundColorMonitor:
Inheritance graph
[legend]
Collaboration diagram for vtkBackgroundColorMonitor:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkBackgroundColorMonitorNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
bool StateChanged (vtkRenderer *ren)
void Update (vtkRenderer *ren)

Static Public Member Functions

static vtkBackgroundColorMonitorNew ()
static int IsTypeOf (const char *type)
static vtkBackgroundColorMonitorSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkBackgroundColorMonitor ()
 ~vtkBackgroundColorMonitor ()

Detailed Description

tracks state of background color(s).

vtkBackgroundColorMonitor -- A helper for painters that tracks state of background color(s). A Painter could use this to skip expensive processing that is only needed when background color changes. This class queries VTK renderer rather than OpenGL state in order to support VTK's gradient background.

this is not intended to be shared. each object should use it's own instance of this class. it's intended to be called once per render.

Tests:
vtkBackgroundColorMonitor (Tests)

Definition at line 42 of file vtkBackgroundColorMonitor.h.


Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 46 of file vtkBackgroundColorMonitor.h.


Constructor & Destructor Documentation

Definition at line 61 of file vtkBackgroundColorMonitor.h.


Member Function Documentation

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

Reimplemented from vtkObject.

static int vtkBackgroundColorMonitor::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 vtkObject.

virtual int vtkBackgroundColorMonitor::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 vtkObject.

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

Reimplemented from vtkObject.

void vtkBackgroundColorMonitor::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.

Fetches the current background color state and updates the internal copies of the data. returns true if any of the tracked colors or modes have changed. Typically this is the only function a user needs to call.

Update the internal state if anything changed. Note, this is done automatically in SateChanged.


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