VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkOpenGLLightMonitor Class Reference

#include <vtkOpenGLLightMonitor.h>

Inheritance diagram for vtkOpenGLLightMonitor:
[legend]
Collaboration diagram for vtkOpenGLLightMonitor:
[legend]

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkOpenGLLightMonitorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
bool StateChanged ()
 
void Update ()
 
virtual void SetLightId (int)
 
virtual int GetLightId ()
 
void SetEnabled (int val)
 
void SetAmbient (float *val)
 
void SetDiffuse (float *val)
 
void SetSpecular (float *val)
 
void SetPosition (float *val)
 
void SetSpotDirection (float *val)
 
void SetSpotExponent (float val)
 
void SetSpotCutoff (float val)
 
void SetAttenuation (float *val)
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
vtkCommandGetCommand (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 vtkOpenGLLightMonitorNew ()
 
static vtkOpenGLLightMonitorNew (int lightId)
 
static int IsTypeOf (const char *type)
 
static vtkOpenGLLightMonitorSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
- 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 OpenGL model-view and projection matrices.

vtkOpenGLLightMonitor – A helper for painters that tracks state of OpenGL lights. A Painter could use this to skip expensive processing that is only needed when lights change.

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:
vtkOpenGLLightMonitor (Tests)

Definition at line 38 of file vtkOpenGLLightMonitor.h.

Member Typedef Documentation

Definition at line 43 of file vtkOpenGLLightMonitor.h.

Member Function Documentation

static vtkOpenGLLightMonitor* vtkOpenGLLightMonitor::New ( )
static
static vtkOpenGLLightMonitor* vtkOpenGLLightMonitor::New ( int  lightId)
static
static int vtkOpenGLLightMonitor::IsTypeOf ( const char *  type)
static
virtual int vtkOpenGLLightMonitor::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 vtkOpenGLLightMonitor* vtkOpenGLLightMonitor::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkOpenGLLightMonitor::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

vtkOpenGLLightMonitor* vtkOpenGLLightMonitor::NewInstance ( ) const
void vtkOpenGLLightMonitor::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.

virtual void vtkOpenGLLightMonitor::SetLightId ( int  )
virtual

Set/Get the light id of the OpenGL light to track. The light id must be set prior to use. Default value 0.

virtual int vtkOpenGLLightMonitor::GetLightId ( )
virtual

Set/Get the light id of the OpenGL light to track. The light id must be set prior to use. Default value 0.

bool vtkOpenGLLightMonitor::StateChanged ( )

Fetches the current GL state and updates the internal copies of the data. returns true if any of the tracked OpenGL lights have changed. Typically this is the only function a user needs to call.

void vtkOpenGLLightMonitor::Update ( )

Fetch and save OpenGL light state. Note, this is done automatically in SateChanged.

void vtkOpenGLLightMonitor::SetEnabled ( int  val)

Setters for internal state.

void vtkOpenGLLightMonitor::SetAmbient ( float val)

Setters for internal state.

void vtkOpenGLLightMonitor::SetDiffuse ( float val)

Setters for internal state.

void vtkOpenGLLightMonitor::SetSpecular ( float val)

Setters for internal state.

void vtkOpenGLLightMonitor::SetPosition ( float val)

Setters for internal state.

void vtkOpenGLLightMonitor::SetSpotDirection ( float val)

Setters for internal state.

void vtkOpenGLLightMonitor::SetSpotExponent ( float  val)

Setters for internal state.

void vtkOpenGLLightMonitor::SetSpotCutoff ( float  val)

Setters for internal state.

void vtkOpenGLLightMonitor::SetAttenuation ( float val)

Setters for internal state.


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