vtkBackgroundColorMonitor Class Reference

#include <vtkBackgroundColorMonitor.h>

Inheritance diagram for vtkBackgroundColorMonitor:

Collaboration diagram for vtkBackgroundColorMonitor:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkBackgroundColorMonitor *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
bool	StateChanged (vtkRenderer *ren)
void	Update (vtkRenderer *ren)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
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)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkBackgroundColorMonitor *	New ()
static int	IsTypeOf (const char *type)
static vtkBackgroundColorMonitor *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
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 ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkBackgroundColorMonitor ()
	~vtkBackgroundColorMonitor ()
Protected Member Functions inherited from vtkObject
	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 Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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

typedef vtkObject vtkBackgroundColorMonitor::Superclass

Definition at line 46 of file vtkBackgroundColorMonitor.h.

Constructor & Destructor Documentation

vtkBackgroundColorMonitor::vtkBackgroundColorMonitor ( )

protected

vtkBackgroundColorMonitor::~vtkBackgroundColorMonitor ( )

inlineprotected

Definition at line 61 of file vtkBackgroundColorMonitor.h.

Member Function Documentation

static vtkBackgroundColorMonitor* vtkBackgroundColorMonitor::New ( )

static

static int vtkBackgroundColorMonitor::IsTypeOf ( const char *  type )

static

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.

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

static

virtual vtkObjectBase* vtkBackgroundColorMonitor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkBackgroundColorMonitor* vtkBackgroundColorMonitor::NewInstance

(

)

const

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.

bool vtkBackgroundColorMonitor::StateChanged

(

vtkRenderer *

ren

)

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.

void vtkBackgroundColorMonitor::Update

(

vtkRenderer *

ren

)

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:

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Core/vtkBackgroundColorMonitor.h