IConsolidationKey Class Referenceabstract
This class is used as a key for a hash table. More...
#include <IConsolidationKey.h>
Inheritance diagram for IConsolidationKey:
Public Member Functions | |
| virtual size_t | GetHashKey ()=0 |
| Returns hash key of this consolidation key. More... | |
| virtual bool | Equals (const IConsolidationKey &rhs) const =0 |
| Returns the comparison of two keys. More... | |
| virtual const Class_ID | GetClassID () const =0 |
| Returns the class ID that can identify this type of key Keys with different class ID always return false. More... | |
| virtual IConsolidationKey * | Clone ()=0 |
| Returns a copy of the current key. More... | |
| GraphicsDriverAPI bool | operator== (const IConsolidationKey &rhs) const |
| Same as Equals(), returns the comparison of two keys. More... | |
| Public Member Functions inherited from ARefObject | |
| GraphicsUtilityAPI | ARefObject () |
| virtual GraphicsUtilityAPI long | AddRef () |
| from IRefObject, see comments in IRefObject More... | |
| virtual GraphicsUtilityAPI long | Release () |
| decrease reference count of this object by one, if the decreased reference count equals zero, the object will be deleted. More... | |
| GraphicsUtilityAPI IRefObject * | QueryInterface (Interface_ID classID) |
| Try query an interface from the ref object using a given interface id. More... | |
| Public Member Functions inherited from IRefObject | |
| GraphicsUtilityAPI | IRefObject () |
| virtual GraphicsUtilityAPI | ~IRefObject () |
Additional Inherited Members | |
| Static Public Member Functions inherited from MaxHeapOperators | |
| static UtilExport void * | operator new (size_t size) |
| Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e) |
| Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new (size_t size, const char *filename, int line) |
| New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, int block_type, const char *filename, int line) |
| New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, const char *filename, int line) |
| New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new (size_t size, unsigned long flags) |
| New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, unsigned long flags) |
| New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size, const char *filename, int line) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
| New operator used to allocate arrays of objects. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size, unsigned long flags) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void | operator delete (void *ptr) |
| Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e) |
| Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete (void *ptr, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, int block_type, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete (void *ptr, unsigned long flags) |
| Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags) |
| Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr) |
| Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e) |
| Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, int block_type, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr, unsigned long flags) |
| Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags) |
| Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, void *placement_ptr) |
| Placement new operator. More... | |
| static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
| Placement delete operator. More... | |
| static UtilExport void * | aligned_malloc (size_t size, size_t alignment) |
| Allocates memory on a specified alignment boundary. More... | |
| static UtilExport void * | aligned_realloc (void *ptr, size_t size, size_t alignment) |
| Reallocates memory on a specified alignment boundary. More... | |
| static UtilExport void | aligned_free (void *ptr) |
| Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More... | |
| Protected Member Functions inherited from ARefObject | |
| virtual GraphicsUtilityAPI void | DeleteThis () |
| This function will be called when the reference count of an ARefObject equals zero. More... | |
| virtual GraphicsUtilityAPI | ~ARefObject () |
Detailed Description
This class is used as a key for a hash table.
Render items with the same keys will be sent to a consolidation item. Plugins can implement this interface to provide their own consolidation properties. Since this class stores key data to decide which consolidation item a render item belongs to, we don't recommended you put any volatile variables in the key. Furthermore, since GetInterfaceID is the only way to determine the type of a key, if plugins want to implement their own consolidation method for an existing key type, they must inherit the key and provide a new interface ID. Otherwise, the render items may not be sent to the plugin's consolidation item.
Member Function Documentation
◆ GetHashKey()
|
pure virtual |
Returns hash key of this consolidation key.
Usually the hash key consists of at least the corresponding consolidation item's interface ID for its initial value.
- Returns
- hash key
Implemented in SplineItemKey, MeshEdgeKey, and MarkerItemKey.
◆ Equals()
|
pure virtual |
Returns the comparison of two keys.
- Returns
- true if two keys are the same, false if they're different.
Implemented in SplineItemKey, MeshEdgeKey, and MarkerItemKey.
◆ GetClassID()
|
pure virtual |
Returns the class ID that can identify this type of key Keys with different class ID always return false.
- Returns
- the keys' class ID
Implemented in SplineItemKey, MeshEdgeKey, and MarkerItemKey.
◆ Clone()
|
pure virtual |
Returns a copy of the current key.
Note that all members of the new keys should also been copied. You should not share pointers between keys because the life time of a key is managed by Max. The key's dispose time is unknown from the plug-in's perspective.
- Returns
- new copy of the current key
Implemented in SplineItemKey, MeshEdgeKey, and MarkerItemKey.
◆ operator==()
| GraphicsDriverAPI bool operator== | ( | const IConsolidationKey & | rhs | ) | const |
Same as Equals(), returns the comparison of two keys.
- Returns
- true if the two keys are same, false if they're different.
