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

a list of lights More...

#include <vtkLightCollection.h>

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

List of all members.

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
void AddItem (vtkLight *a)
vtkLightGetNextItem ()
vtkLightGetNextLight (vtkCollectionSimpleIterator &cookie)
- Public Member Functions inherited from vtkCollection
void InsertItem (int i, vtkObject *)
void ReplaceItem (int i, vtkObject *)
void RemoveItem (int i)
void RemoveItem (vtkObject *)
void RemoveAllItems ()
int IsItemPresent (vtkObject *a)
int GetNumberOfItems ()
void InitTraversal ()
vtkObjectGetNextItemAsObject ()
vtkObjectGetItemAsObject (int i)
vtkCollectionIteratorNewIterator ()
void InitTraversal (vtkCollectionSimpleIterator &cookie)
vtkObjectGetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
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)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkLightCollectionNew ()
static int IsTypeOf (const char *type)
static vtkLightCollectionSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkLightCollection ()
 ~vtkLightCollection ()
- Protected Member Functions inherited from vtkCollection
virtual void DeleteElement (vtkCollectionElement *)
virtual void ReportReferences (vtkGarbageCollector *collector)
 vtkCollection ()
 ~vtkCollection ()
- 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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

- Protected Attributes inherited from vtkCollection
int NumberOfItems
vtkCollectionElementTop
vtkCollectionElementBottom
vtkCollectionElementCurrent
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Detailed Description

a list of lights

vtkLightCollection represents and provides methods to manipulate a list of lights (i.e., vtkLight and subclasses). The list is unsorted and duplicate entries are not prevented.

See also:
vtkCollection vtkLight
Tests:
vtkLightCollection (Tests)

Definition at line 36 of file vtkLightCollection.h.


Member Typedef Documentation

Reimplemented from vtkCollection.

Definition at line 40 of file vtkLightCollection.h.


Constructor & Destructor Documentation

vtkLightCollection::vtkLightCollection ( )
inlineprotected

Definition at line 59 of file vtkLightCollection.h.

vtkLightCollection::~vtkLightCollection ( )
inlineprotected

Definition at line 60 of file vtkLightCollection.h.


Member Function Documentation

static vtkLightCollection* vtkLightCollection::New ( )
static

Construct with empty list.

Reimplemented from vtkCollection.

virtual const char* vtkLightCollection::GetClassName ( )
virtual

Reimplemented from vtkCollection.

static int vtkLightCollection::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 vtkCollection.

virtual int vtkLightCollection::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 vtkCollection.

static vtkLightCollection* vtkLightCollection::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkCollection.

virtual void vtkLightCollection::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 vtkCollection.

void vtkLightCollection::AddItem ( vtkLight a)

Add a light to the list.

vtkLight* vtkLightCollection::GetNextItem ( )

Get the next light in the list. NULL is returned when the collection is exhausted.

vtkLight* vtkLightCollection::GetNextLight ( vtkCollectionSimpleIterator cookie)

Reentrant safe way to get an object in a collection. Just pass the same cookie back and forth.


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