3ds Max C++ API Reference
|
Interface to the brush preset manager. More...
#include <IBrushPresets.h>
Public Member Functions | |
DECLARE_DESCRIPTOR (IBrushPresetMgr) | |
virtual void | RegisterContext (IBrushPresetContext *context)=0 |
Registers a context with the manager. | |
virtual void | UnRegisterContext (IBrushPresetContext *context)=0 |
Unregisters a context with the manager. | |
virtual IBrushPresetContext * | GetContext (Class_ID contextID)=0 |
Returns a context object from its ID. | |
virtual int | GetNumContexts ()=0 |
Returns the number of contexts. | |
virtual Class_ID | GetContextID (int contextIndex)=0 |
Translates the index number of a context into the corresponding context ID. | |
virtual int | GetContextIndex (Class_ID contextID)=0 |
Translates the ID of a context into the corresponding context index number. | |
virtual int | BeginContext (Class_ID contextID)=0 |
Notifies the manager that a context is activated. | |
virtual int | EndContext (Class_ID contextID)=0 |
Notifies the manager that a context is deactived. | |
virtual BOOL | IsContextActive (Class_ID contextID)=0 |
Returns TRUE if the given context is active, FALSE otherwise. | |
virtual IBrushPreset * | GetPreset (int presetID)=0 |
Returns a brush preset object from its ID, or NULL if no preset exists with the given ID. | |
virtual IBrushPreset * | CreatePreset ()=0 |
Creates a new preset, and adds a corresponding button to the brush preset toolbar. | |
virtual void | DeletePreset (IBrushPreset *preset)=0 |
Deletes a preset, removing the corresponding button from the brush preset toolbar. | |
virtual int | GetNumPresets ()=0 |
Returns the current number of brush presets. | |
virtual int | GetPresetID (int presetIndex)=0 |
Translates the index number of a brush preset into the corresponding preset ID. | |
virtual int | GetPresetIndex (int presetID)=0 |
Translates the ID of a brush preset into the corresponding preset index number. | |
virtual int | GetActivePreset ()=0 |
Returns the ID of the active preset. | |
virtual void | SetActivePreset (int presetID)=0 |
Sets the active preset. | |
virtual void | OnContextUpdated (Class_ID contextID)=0 |
Notifies the manager that a parameter has changed within a brush preset context. | |
virtual int | ReadConfig (const MCHAR *cfg=NULL)=0 |
Reads a brush preset file, including the preset values and the layout of the toolbar. | |
virtual int | WriteConfig (const MCHAR *cfg=NULL)=0 |
Writes a brush preset file, including the preset values and the layout of the toolbar. | |
![]() | |
CoreExport | FPInterfaceDesc () |
CoreExport | FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...) |
CoreExport | ~FPInterfaceDesc () |
virtual void | Init () |
LifetimeType | LifetimeControl () |
virtual BaseInterface * | GetInterface (Interface_ID id) |
CoreExport void | LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...) |
CoreExport void | AppendFunction (int id,...) |
Add a new function to this interface descriptor. | |
CoreExport void | AppendProperty (int id,...) |
Add a new property to this interface descriptor. | |
CoreExport void | AppendEnum (int id,...) |
Add a new enum to this interface descriptor. | |
CoreExport void | SetClassDesc (ClassDesc *i_cd) |
CoreExport va_list | check_fn (va_list ap, int id) |
CoreExport va_list | scan_fn (va_list ap, int id, int index) |
CoreExport va_list | check_prop (va_list ap, int id) |
CoreExport va_list | scan_prop (va_list ap, int id, int index) |
CoreExport va_list | check_enum (va_list ap, EnumID id) |
CoreExport va_list | scan_enum (va_list ap, EnumID id, int index) |
FPInterfaceDesc * | GetDesc () |
Interface_ID | GetID () |
CoreExport FPFunctionDef * | GetFnDef (FunctionID fid) |
ActionTable * | GetActionTable () |
CoreExport void | EnableActions (BOOL onOff) |
virtual CoreExport HINSTANCE | HInstance () |
virtual CoreExport const MCHAR * | GetRsrcString (StringResID id) |
![]() | |
virtual BaseInterface * | GetInterface (Interface_ID id) |
virtual FPInterfaceDesc * | GetDesc ()=0 |
virtual CoreExport FPStatus | Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL) |
virtual FPStatus | Invoke (FunctionID fid, FPParams *params) |
virtual CoreExport FPStatus | Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL) |
virtual FPStatus | Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL) |
virtual CoreExport FunctionID | FindFn (const MCHAR *name) |
virtual CoreExport BOOL | IsEnabled (FunctionID actionID) |
virtual CoreExport BOOL | IsChecked (FunctionID actionID) |
virtual CoreExport BOOL | IsVisible (FunctionID actionID) |
virtual CoreExport FunctionID | GetIsEnabled (FunctionID actionID) |
virtual CoreExport FunctionID | GetIsChecked (FunctionID actionID) |
virtual CoreExport FunctionID | GetIsVisible (FunctionID actionID) |
virtual ActionTable * | GetActionTable () |
virtual void | EnableActions (BOOL onOff) |
![]() | |
virtual UtilExport | ~BaseInterface () |
Destructor. | |
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) |
![]() | |
virtual UtilExport | ~InterfaceServer () |
Destructor. | |
virtual UtilExport BaseInterface * | GetInterface (Interface_ID id) |
template<class InterfaceType > | |
InterfaceType * | GetTypedInterface () |
Additional Inherited Members | |
![]() | |
enum | LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled } |
![]() | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
New operator used to allocate arrays of objects. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
static UtilExport void * | operator new (size_t size, void *placement_ptr) |
Placement new operator. | |
static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
Placement delete operator. | |
static UtilExport void * | aligned_malloc (size_t size, size_t alignment) |
Allocates memory on a specified alignment boundary. | |
static UtilExport void * | aligned_realloc (void *ptr, size_t size, size_t alignment) |
Reallocates memory on a specified alignment boundary. | |
static UtilExport void | aligned_free (void *ptr) |
Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. | |
![]() | |
Interface_ID | ID |
MSTR | internal_name |
StringResID | description |
ClassDesc * | cd |
USHORT | flags |
Tab< FPFunctionDef * > | functions |
Tab< FPPropDef * > | props |
Tab< FPEnum * > | enumerations |
MSPluginClass * | pc |
Rollout * | rollout |
ActionTable * | action_table |
![]() | |
static CoreExport FPInterfaceDesc | nullInterface |
![]() | |
CoreExport void | load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap) |
![]() | |
virtual FPStatus | _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p) |
Interface to the brush preset manager.
The manager is a singleton object implemented by the system. It maintains the list of contexts and presets. It communicates with the contexts to track which is active, and when a context is updated. It tracks which preset is active in order to store parameters into the preset when contexts are updated. It has functionality to read and write brush preset files. Finally, the brush preset manager provides a maxscript interface to activate and deactivate presets.
DECLARE_DESCRIPTOR | ( | IBrushPresetMgr | ) |
|
pure virtual |
Registers a context with the manager.
Contexts should call this method at system startup, or immediately when loaded into memory to support deferred loading.
[in] | context | The context to register |
|
pure virtual |
Unregisters a context with the manager.
Contexts may call this method if they are unloaded from memory, but it is not required during normal shutdown.
[in] | context | The context to unregister |
|
pure virtual |
Returns a context object from its ID.
This returns the context immediately if it is currently registered, otherwise it loads the context plug-in if it is not in memory but supports deferred loading.
[in] | contextID | The ID of the context |
|
pure virtual |
Returns the number of contexts.
This includes all currently registered contexts, plus contexts in deferred plug-ins which were registered previously but are not yet loaded.
Translates the index number of a context into the corresponding context ID.
[in] | contextIndex | The index of the context |
Translates the ID of a context into the corresponding context index number.
[in] | contextID | The ID of the context |
Notifies the manager that a context is activated.
This should be called by a context when its UI is opened and ready for painting
[in] | contextID | The ID of the context |
Notifies the manager that a context is deactived.
This should be called by a context when its UI is closed
[in] | contextID | The ID of the context |
|
pure virtual |
Returns TRUE if the given context is active, FALSE otherwise.
[in] | contextID | The ID of the context |
|
pure virtual |
Returns a brush preset object from its ID, or NULL if no preset exists with the given ID.
[in] | presetID | The ID of the preset |
|
pure virtual |
Creates a new preset, and adds a corresponding button to the brush preset toolbar.
|
pure virtual |
Deletes a preset, removing the corresponding button from the brush preset toolbar.
|
pure virtual |
Returns the current number of brush presets.
Translates the index number of a brush preset into the corresponding preset ID.
[in] | presetIndex | The index of the preset |
Translates the ID of a brush preset into the corresponding preset index number.
[in] | presetID | The ID of the preset |
|
pure virtual |
Returns the ID of the active preset.
This corresponds to the currently checked button on the brush preset toolbar, or zero if no button is checked.
Sets the active preset.
The button on the brush preset toolbar corresponding to this preset will become checked.
[in] | presetID | The ID of the preset |
Notifies the manager that a parameter has changed within a brush preset context.
Contexts should call this method whenever they are active, and any parameter changes which needs to be stored into the active preset
[in] | contextID | The ID of the updated context |
Reads a brush preset file, including the preset values and the layout of the toolbar.
[in] | cfg | The path of the file, or NULL to use the standard startup file |