Implementation to create the Transform variables needed by Bones.
More...
#include <OgreBoneArrayMemoryManager.h>
|
| enum | MemoryTypes {
Owner = 0
, Position
, Orientation
, Scale
,
ParentMat
, ParentNode
, WorldMat
, FinalMat
,
InheritOrientation
, InheritScale
, NumMemoryTypes
} |
| |
| typedef std::vector< ptrdiff_t > | PtrdiffVec |
| |
|
| | BoneArrayMemoryManager (uint16 depthLevel, size_t hintMaxNodes, size_t cleanupThreshold=100, size_t maxHardLimit=MAX_MEMORY_SLOTS, RebaseListener *rebaseListener=0) |
| | Constructor. More...
|
| |
| void | createNewNode (BoneTransform &outTransform) |
| | Requests memory for a new Bone (for the Array vectors & matrices) May be also be used for a new Entity, etc. More...
|
| |
| void | destroyNode (BoneTransform &inOutTransform) |
| | Releases memory acquired through. More...
|
| |
| size_t | getFirstNode (BoneTransform &outTransform) |
| | Retrieves a BoneTransform pointing to the first Bone. More...
|
| |
| | ArrayMemoryManager (size_t const *elementsMemSize, CleanupRoutines const *initRoutines, CleanupRoutines const *cleanupRoutines, size_t numElementsSize, uint16 depthLevel, size_t hintMaxNodes, size_t cleanupThreshold=100, size_t maxHardLimit=MAX_MEMORY_SLOTS, RebaseListener *rebaseListener=0) |
| | Constructor. More...
|
| |
| virtual | ~ArrayMemoryManager () |
| |
| void | defragment () |
| | Triggers on demand a defragmentation of the pools, so that all slots become contiguous in memory. More...
|
| |
| void | destroy () |
| | Destroys the memory ptrs. More...
|
| |
| size_t | getAllMemory () const |
| | Gets all memory reserved for this manager. More...
|
| |
| size_t | getFreeMemory () const |
| | Gets available memory in bytes. More...
|
| |
| size_t | getNumUsedSlotsIncludingFragmented () const |
| | Returns mUsedMemory. More...
|
| |
| size_t | getUsedMemory () const |
| | Gets used memory in bytes (not including waste) More...
|
| |
| size_t | getWastedMemory () const |
| | Gets wasted memory (perform a cleanup to fix) More...
|
| |
| void | initialize () |
| | Initializes mMemoryPools. More...
|
| |
| void | neverDefragment () |
| | Prevent defragmentation from ever happening. More...
|
| |
| void | shrinkToFit () |
| | Defragments memory, then reallocates a smaller pool that tightly fits the current number of objects. More...
|
| |
Implementation to create the Transform variables needed by Bones.
- Author
- Matias N. Goldberg
- Version
- 1.0
◆ MemoryTypes
| Enumerator |
|---|
| Owner | |
| Position | |
| Orientation | |
| Scale | |
| ParentMat | |
| ParentNode | |
| WorldMat | |
| FinalMat | |
| InheritOrientation | |
| InheritScale | |
| NumMemoryTypes | |
◆ BoneArrayMemoryManager()
| Ogre::BoneArrayMemoryManager::BoneArrayMemoryManager |
( |
uint16 |
depthLevel, |
|
|
size_t |
hintMaxNodes, |
|
|
size_t |
cleanupThreshold = 100, |
|
|
size_t |
maxHardLimit = MAX_MEMORY_SLOTS, |
|
|
RebaseListener * |
rebaseListener = 0 |
|
) |
| |
Constructor.
See intialize(). See destroy().
- Parameters
-
| elementsMemSize | Array containing the size in bytes of each element type (i.e. NodeElementsMemSize) |
| initRoutines | Array containing the cleanup function that will be called when default initializing memory. Unlike cleanupRoutines, just leave the function pointer null if all you want is just to initialize to 0. |
| cleanupRoutines | Array containing the cleanup function that will be called when performing cleanups. Many pointers can use the flatCleaner and is the fastest. However Array variables (i.e. ArrayVector3) have a layout where flatCleaner won't work correctly because the data is interleaved (rather than flat). |
| numElementsSize | Number of entries in elementsMemSize |
| depthLevel | Value only used to pass to the listener. Identifies to which hierarchy depth level this memory manager belongs to. |
| hintMaxNodes | Hint on how many SceneNodes we'll be creating. |
| cleanupThreshold | The threshold at which a cleanup is triggered after too many nodes have been destroyed in a non-LIFO order or without being created again. -1 to disable cleanups. |
| maxHardLimit | Maximum amount of SceneNodes. The manager is not allowed to grow and consume more memory past that limit. MAX_MEMORY_SLOTS for no limit. This is useful when target architecture has much less memory than the dev machine. |
- Note that if hintMaxNodes < maxHardLimit, the manager may be forced to do temporary allocations (to do the reallocs) thus during a brief perdiod of time it may consume more memory than the established hard limit (up to 2x).
- Parameters
-
| rebaseListener | The listener to be called when cleaning up or growing the memory pool. If null, cleanupThreshold is set to -1 & maxHardLimit will be set to hintMaxNodes |
◆ createNewNode()
| void Ogre::BoneArrayMemoryManager::createNewNode |
( |
BoneTransform & |
outTransform | ) |
|
Requests memory for a new Bone (for the Array vectors & matrices) May be also be used for a new Entity, etc.
- Parameters
-
| outTransform | Out: The transform with filled memory pointers |
◆ destroyNode()
| void Ogre::BoneArrayMemoryManager::destroyNode |
( |
BoneTransform & |
inOutTransform | ) |
|
Releases memory acquired through.
- See also
- createNewNode
- Parameters
-
| inOutTransform | Out: Transform to destroy. Pointers are nullified |
◆ getFirstNode()
| size_t Ogre::BoneArrayMemoryManager::getFirstNode |
( |
BoneTransform & |
outTransform | ) |
|
Retrieves a BoneTransform pointing to the first Bone.
- See also
- BoneMemoryManager::getStart
- Parameters
-
| outTransform | [out] Transform with filled pointers to the first Node in this depth |
- Returns
- Number of Nodes in this depth level
◆ BoneCleanupRoutines
◆ BoneInitRoutines
◆ ElementsMemSize
| const size_t Ogre::BoneArrayMemoryManager::ElementsMemSize[NumMemoryTypes] |
|
static |
The documentation for this class was generated from the following file:
Inheritance diagram for Ogre::BoneArrayMemoryManager:
1.9.1