Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
135 lines (101 sloc) 3.75 KB
/*=========================================================================
Program: Visualization Toolkit
Module: vtkActor2DCollection.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkActor2DCollection - a list of 2D actors
// .SECTION Description
// vtkActor2DCollection is a subclass of vtkCollection. vtkActor2DCollection
// maintains a collection of vtkActor2D objects that is sorted by layer
// number, with lower layer numbers at the start of the list. This allows
// the vtkActor2D objects to be rendered in the correct order.
// .SECTION See Also
// vtkActor2D vtkCollection
#ifndef __vtkActor2DCollection_h
#define __vtkActor2DCollection_h
#include "vtkPropCollection.h"
#include "vtkActor2D.h" // Needed for inline methods
class vtkViewport;
class VTK_FILTERING_EXPORT vtkActor2DCollection : public vtkPropCollection
{
public:
// Description:
// Desctructor for the vtkActor2DCollection class. This removes all
// objects from the collection.
static vtkActor2DCollection *New();
vtkTypeMacro(vtkActor2DCollection,vtkPropCollection);
// Description:
// Sorts the vtkActor2DCollection by layer number. Smaller layer
// numbers are first. Layer numbers can be any integer value.
void Sort();
// Description:
// Add an actor to the list. The new actor is inserted in the list
// according to it's layer number.
void AddItem(vtkActor2D *a);
// Description:
// Standard Collection methods
int IsItemPresent(vtkActor2D *a);
vtkActor2D *GetNextActor2D();
vtkActor2D *GetLastActor2D();
// Description:
// Access routines that are provided for compatibility with previous
// version of VTK. Please use the GetNextActor2D(), GetLastActor2D()
// variants where possible.
vtkActor2D *GetNextItem();
vtkActor2D *GetLastItem();
// Description:
// Sort and then render the collection of 2D actors.
void RenderOverlay(vtkViewport* viewport);
//BTX
// Description:
// Reentrant safe way to get an object in a collection. Just pass the
// same cookie back and forth.
vtkActor2D *GetNextActor2D(vtkCollectionSimpleIterator &cookie) {
return static_cast<vtkActor2D *>(this->GetNextItemAsObject(cookie));};
//ETX
protected:
vtkActor2DCollection() {};
~vtkActor2DCollection();
virtual void DeleteElement(vtkCollectionElement *);
private:
// hide the standard AddItem from the user and the compiler.
void AddItem(vtkObject *o) { this->vtkCollection::AddItem(o); };
void AddItem(vtkProp *o) { this->vtkPropCollection::AddItem(o); };
int IsItemPresent(vtkObject *o) { return this->vtkCollection::IsItemPresent(o); };
private:
vtkActor2DCollection(const vtkActor2DCollection&); // Not implemented.
void operator=(const vtkActor2DCollection&); // Not implemented.
};
inline int vtkActor2DCollection::IsItemPresent(vtkActor2D *a)
{
return this->vtkCollection::IsItemPresent(a);
}
inline vtkActor2D *vtkActor2DCollection::GetNextActor2D()
{
return static_cast<vtkActor2D *>(this->GetNextItemAsObject());
}
inline vtkActor2D *vtkActor2DCollection::GetLastActor2D()
{
if ( this->Bottom == NULL )
{
return NULL;
}
else
{
return static_cast<vtkActor2D *>(this->Bottom->Item);
}
}
inline vtkActor2D *vtkActor2DCollection::GetNextItem()
{
return this->GetNextActor2D();
}
inline vtkActor2D *vtkActor2DCollection::GetLastItem()
{
return this->GetLastActor2D();
}
#endif