IPublishedCustAttrib Class Referenceabstract
Any CustAttrib which wants to support being published should implement this interface. More...
#include <custattrib.h>
Inheritance diagram for IPublishedCustAttrib:
Public Member Functions | |
| virtual const MCHAR * | GetName () const =0 |
| Return the name of the published custom attribute. More... | |
| virtual CustAttrib * | GetPublishedCustAttrib () const =0 |
| Return the custom attribute this interface publishes. More... | |
| virtual int | PublishedParameterCount () const =0 |
| Return how many published parameters there are in this custom attribute. More... | |
| virtual MSTR | PublishedParameterName (int index) const =0 |
| Retrieve the name of the i-th published parameter. More... | |
| virtual Control * | GetPublishedParameterControl (int index) const =0 |
| Retrieve the controller of the i-th published parameter. More... | |
| virtual bool | SetPublishedParameterControl (int index, Control *pControl)=0 |
| Set the controller of the i-th published parameter. More... | |
| virtual SClass_ID | GetParameterControlType (int index) const =0 |
| Get the controller type of the i-th published parameter. More... | |
| Public Member Functions inherited from BaseInterface | |
| virtual UtilExport | ~BaseInterface () |
| Destructor. More... | |
| UtilExport BaseInterface * | GetInterface (Interface_ID id) override |
| virtual UtilExport Interface_ID | GetID () |
| virtual LifetimeType | LifetimeControl () |
| virtual bool | RegisterNotifyCallback (InterfaceNotifyCallback *incb) |
| virtual void | UnRegisterNotifyCallback (InterfaceNotifyCallback *incb) |
| virtual BaseInterface * | AcquireInterface () |
| virtual void | ReleaseInterface () |
| virtual void | DeleteInterface () |
| virtual BaseInterface * | CloneInterface (void *remapDir=nullptr) |
| Public Member Functions inherited from InterfaceServer | |
| virtual UtilExport | ~InterfaceServer () |
| Destructor. More... | |
| template<class InterfaceType > | |
| InterfaceType * | GetTypedInterface () |
Additional Inherited Members | |
| Public Types inherited from BaseInterface | |
| enum | LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled } |
| 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 Noncopyable | |
| Noncopyable () | |
| ~Noncopyable () | |
Detailed Description
Any CustAttrib which wants to support being published should implement this interface.
When users xref objects with published custom attribute, users can visit and edit those CustAttrib values and saved with the XRef main scene and later if the value of source scene was changed, the main scene will also be updated accordingly(merge the value from source scene and the value saved in the main scene)
Member Function Documentation
◆ GetName()
|
pure virtual |
Return the name of the published custom attribute.
- Returns
- the name of the published custom attribute
◆ GetPublishedCustAttrib()
|
pure virtual |
Return the custom attribute this interface publishes.
- Returns
- the CustAttrib the interface publishes
◆ PublishedParameterCount()
|
pure virtual |
Return how many published parameters there are in this custom attribute.
- Returns
- the count of published parameters.
◆ PublishedParameterName()
Retrieve the name of the i-th published parameter.
- Parameters
-
index - index of the published parameter whose name we want to get.
- Returns
- - the name of the i-th published parameter.
◆ GetPublishedParameterControl()
Retrieve the controller of the i-th published parameter.
- Parameters
-
index - index of the published parameter whose controller we want to get.
- Returns
- - the controller of the i-th published parameter.
◆ SetPublishedParameterControl()
Set the controller of the i-th published parameter.
- Parameters
-
index - index of the published parameter whose controller we want to set. pControl - the controller to be set to the i-th parameter.
- Returns
- - if the operation is succeeded or not
