Iterate over all renderable Actors in an Context. More...
#include <Context.h>
Inheritance diagram for nvidia::apex::RenderableIterator:
Public Member Functions | |
| virtual Renderable * | getFirst ()=0 |
| Return the first renderable in an Context. | |
| virtual Renderable * | getNext ()=0 |
| Return the next unlocked renderable in an Context. | |
| virtual void | reset ()=0 |
| Refresh the renderable actor list for this context. | |
Detailed Description
Iterate over all renderable Actors in an Context.
An RenderableIterator is a lock-safe iterator over all renderable Actors in an Context. Actors which are locked are skipped in the initial pass and deferred till the end. The returned Renderable is locked by the iterator and remains locked until you call getNext().
The RenderableIterator is also deletion safe. If an actor is deleted from the Context in another thread, the iterator will skip that actor.
An RenderableIterator should not be held for longer than a single simulation step. It should be allocated on demand and released after use.
Member Function Documentation
| virtual void nvidia::apex::RenderableIterator::reset | ( | ) | [pure virtual] |
Refresh the renderable actor list for this context.
This function is only necessary if you believe actors have been added or deleted since the iterator was created.
The documentation for this class was generated from the following file:
