INodeInstancingPool2 Class Referenceabstract
Extends class INodeInstancingPool with additional functionality. More...
#include <INodeInstancingPool.h>
Inheritance diagram for INodeInstancingPool2:
Public Member Functions | |
| virtual size_t | GetSize () const =0 |
| Returns the number of nodes in the pool. More... | |
| virtual INode * | GetNode (const size_t index) const =0 |
| Returns the node, at the given index, contained in the pool. More... | |
| Public Member Functions inherited from INodeInstancingPool | |
| virtual INode * | GetRepresentativeNode () const =0 |
| Returns the pool's representative node. More... | |
| virtual void | MonitorNodePool (INotifier ¬ifier) const =0 |
| Registers a change notification callback, which gets called whenever the pool, or the instanced object, changes. More... | |
| virtual void | StopMonitoringNodePool (INotifier ¬ifier) const =0 |
| Unregisteres a notification callback previously registered with MonitorNodePool(). More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from INodeInstancingPool | |
| virtual | ~INodeInstancingPool () |
Detailed Description
Extends class INodeInstancingPool with additional functionality.
See class INodeInstancingPool for more details.
Member Function Documentation
◆ GetSize()
|
pure virtual |
Returns the number of nodes in the pool.
- Remarks
- In most cases, users of INodeInstancingPool should only care about the representative node, returned by GetRepresentativeNode(). In some cases, however, they may care about the set of of nodes contained by the pool. Note, however, that nodes are only incorporated into their respective pool on calling INodeInstancingPool::IManager::GetPoolForNode(), and may be ejected at any time, e.g. when scene changes are detected. Querying the list of nodes contained by a pool is therefore only truly valid right after calling INodeInstancingPool::IManager::GetPoolForNode() for every node in the scene.
◆ GetNode()
Returns the node, at the given index, contained in the pool.
- Parameters
-
index The index of the node to query; see GetSize().
- Remarks
- In most cases, users of INodeInstancingPool should only care about the representative node, returned by GetRepresentativeNode(). In some cases, however, they may care about the set of of nodes contained by the pool. Note, however, that nodes are only incorporated into their respective pool on calling INodeInstancingPool::IManager::GetPoolForNode(), and may be ejected at any time, e.g. when scene changes are detected. Querying the list of nodes contained by a pool is therefore only truly valid right after calling INodeInstancingPool::IManager::GetPoolForNode() for every node in the scene.
