3ds Max C++ API Reference
|
#include <mxsPlugin.h>
Public Member Functions | |
MSPluginDesc (MSPluginClass *ipc) | |
int | IsPublic () override |
Controls if the plug-in shows up in lists from the user to choose from. | |
BOOL | OkToCreate (Interface *i) override |
This method is used to enable or disable the button that allows the plug-ins class to be created. | |
void * | Create (BOOL loading=FALSE) override |
3ds Max calls this method when it needs a pointer to a new instance of the plug-in class. | |
const MCHAR * | ClassName () override |
This method returns the name of the class. | |
const MCHAR * | NonLocalizedClassName () override |
This method returns the non-localized name of the class. | |
const MCHAR * | InternalName () override |
Returns a string which provides a fixed, machine parsable internal name for the plug-in. | |
SClass_ID | SuperClassID () override |
This method returns a system defined constant describing the class this plug-in class was derived from. | |
Class_ID | ClassID () override |
This method must return the unique ID for the object. | |
const MCHAR * | Category () override |
This methods returns a string describing the category a plug-in fits into. | |
int | BeginCreate (Interface *i) override |
The custom creation process of the plug-in object is handled by this method. | |
int | EndCreate (Interface *i) override |
The termination of the custom creation process is managed by the implementation of this method. | |
void | ResetClassParams (BOOL fileReset) override |
DWORD | InitialRollupPageState () override |
This method returns a DWORD which is used to initialize the rollup state in both the create branch and the modify branch. | |
BOOL | IsManipulator () override |
Returns TRUE if the class implements a manipulator object; otherwise FALSE. | |
BOOL | CanManipulate (ReferenceTarget *hTarget) override |
The method returns true if the class is a manipulator and it manipulates the given base object, modifier or controller. | |
BOOL | CanManipulateNode (INode *pNode) override |
Returns TRUE if the manipulator applies to the given node; otherwise FALSE. | |
Manipulator * | CreateManipulator (ReferenceTarget *hTarget, INode *pNode) override |
Creates a manipulator object When a manipulator returns TRUE to CanManipulate(ReferenceTarget* hTarget), the system calls this version of CreateManipulator() to create an instance of the manipulator. | |
Manipulator * | CreateManipulator (INode *pNode) override |
Creates a manipulator object. | |
HINSTANCE | HInstance () override |
Returns the DLL instance handle of the plug-in. | |
const MCHAR * | GetString (INT_PTR id) |
const MCHAR * | GetRsrcString (INT_PTR id) override |
Returns a pointer to the string from the resource string table. | |
void | StartTool (IObjCreate *iob) |
void | StopTool (IObjCreate *iob) |
Class_ID | SubClassID () override |
This method can be used for further categorizing plugins. | |
bool | IsCompatibleWithRenderer (ClassDesc &rendererClassDesc) override |
bool | GetCustomMtlBrowserIcon (HIMAGELIST &hImageList, int &inactiveIndex, int &activeIndex, int &disabledIndex) override |
![]() | |
PB2Export | ClassDesc2 () |
PB2Export | ~ClassDesc2 () |
PB2Export void | ResetClassParams (BOOL fileReset) override |
PB2Export int | NumParamBlockDescs () override |
PB2Export ParamBlockDesc2 * | GetParamBlockDesc (int i) override |
PB2Export ParamBlockDesc2 * | GetParamBlockDescByID (BlockID id) override |
PB2Export ParamBlockDesc2 * | GetParamBlockDescByName (const MCHAR *name) |
PB2Export void | AddParamBlockDesc (ParamBlockDesc2 *pbd) override |
PB2Export void | ClearParamBlockDescs () |
PB2Export void | BeginEditParams (IObjParam *ip, ReferenceMaker *obj, ULONG flags, Animatable *prev) override |
PB2Export void | EndEditParams (IObjParam *ip, ReferenceMaker *obj, ULONG flags, Animatable *prev) override |
PB2Export void | InvalidateUI () |
PB2Export void | InvalidateUI (ParamBlockDesc2 *pbd) override |
PB2Export void | InvalidateUI (ParamBlockDesc2 *pbd, ParamID id, int tabIndex=-1) |
PB2Export void | MakeAutoParamBlocks (ReferenceMaker *owner) override |
PB2Export int | NumParamMaps () override |
PB2Export IParamMap2 * | GetParamMap (int i) override |
PB2Export IParamMap2 * | GetParamMap (ParamBlockDesc2 *pbd, MapID map_id=0) |
PB2Export bool | SetUserDlgProc (ParamBlockDesc2 *pbd, MapID map_id, ParamMap2UserDlgProc *proc=nullptr) |
bool | SetUserDlgProc (ParamBlockDesc2 *pbd, ParamMap2UserDlgProc *proc=nullptr) override |
PB2Export ParamMap2UserDlgProc * | GetUserDlgProc (ParamBlockDesc2 *pbd, MapID map_id=0) |
PB2Export IAutoMParamDlg * | CreateParamDlgs (HWND hwMtlEdit, IMtlParams *imp, ReferenceTarget *obj) |
PB2Export IAutoMParamDlg * | CreateParamDlg (BlockID id, HWND hwMtlEdit, IMtlParams *imp, ReferenceTarget *obj, MapID mapID=0) |
PB2Export IAutoEParamDlg * | CreateParamDialogs (IRendParams *ip, SpecialFX *obj) |
PB2Export IAutoRendererParamDlg * | CreateParamDialogs (IRendParams *ip, Renderer &renderer) |
Creates the automatically-managed parameter dialogs defined with the P_AUTO_UI or P_AUTO_UI_QT flags in the parameter block descriptors. | |
PB2Export IAutoRendererParamDlg * | CreateParamDialog (BlockID id, IRendParams *ip, Renderer &renderer, MapID mapID) |
Creates the automatically-managed parameter dialog for the given parameter block and parameter map only. | |
PB2Export IAutoEParamDlg * | CreateParamDialog (BlockID id, IRendParams *ip, SpecialFX *obj, MapID mapID=0) |
PB2Export void | MainDlgDeleted (IAutoMParamDlg *dlg) |
PB2Export void | MainDlgDeleted (IAutoEParamDlg *dlg) |
PB2Export void | MainDlgDeleted (IAutoRendererParamDlg &dlg) |
Used internally. | |
PB2Export IAutoMParamDlg * | GetMParamDlg () |
PB2Export IAutoEParamDlg * | GetEParamDlg () |
PB2Export void | RestoreRolloutState () |
PB2Export ParamID | LastNotifyParamID (ReferenceMaker *owner, IParamBlock2 *&pb) |
PB2Export void | Reset (ReferenceMaker *owner, BOOL updateUI=TRUE, BOOL callSetHandlers=TRUE) |
PB2Export void | GetValidity (ReferenceMaker *owner, TimeValue t, Interval &valid) |
PB2Export void | RemoveParamBlockDesc (ParamBlockDesc2 *pbd) |
virtual MaxSDK::QMaxParamBlockWidget * | CreateQtWidget (ReferenceMaker &owner, IParamBlock2 ¶mBlock, const MapID paramMapID, MSTR &rollupTitle, int &rollupFlags, int &rollupCategory) |
Creates a Qt widget to be associated with the given parameter map ID. | |
virtual MaxSDK::QMaxParamBlockWidget * | CreateQtWidget (ReferenceMaker &owner, IParamBlock2 ¶mBlock, const MapID paramMapID, MSTR &rollupTitle, int &rollupFlags, int &rollupCategory, Class_ID &tabID) |
Creates a Qt widget that is connected to the given parameter block. | |
![]() | |
virtual | ~ClassDesc () |
virtual int | IsPublic ()=0 |
Controls if the plug-in shows up in lists from the user to choose from. | |
virtual const MCHAR * | ClassName ()=0 |
This method returns the name of the class. | |
virtual const MCHAR * | NonLocalizedClassName ()=0 |
This method returns the non-localized name of the class. | |
virtual const MCHAR * | InternalName () |
Returns a string which provides a fixed, machine parsable internal name for the plug-in. | |
virtual SClass_ID | SuperClassID ()=0 |
This method returns a system defined constant describing the class this plug-in class was derived from. | |
virtual Class_ID | ClassID ()=0 |
This method must return the unique ID for the object. | |
virtual const MCHAR * | Category ()=0 |
This methods returns a string describing the category a plug-in fits into. | |
virtual DWORD | InitialRollupPageState () |
This method returns a DWORD which is used to initialize the rollup state in both the create branch and the modify branch. | |
virtual bool | UseOnlyInternalNameForMAXScriptExposure () |
Returns true if only the InternalName is to be used for MAXScript exposure. | |
virtual HINSTANCE | HInstance () |
Returns the DLL instance handle of the plug-in. | |
virtual CoreExport const MCHAR * | GetRsrcString (INT_PTR id) |
Returns a pointer to the string from the resource string table. | |
virtual void | MakeAutoParamBlocks (ReferenceMaker *owner) |
This method creates the automatic parameter blocks for the specified plug-in. | |
virtual Class_ID | SubClassID () |
This method can be used for further categorizing plugins. | |
virtual BOOL | HasClassParams () |
If a plug-in class has default parameters that it needs to allow the user to edit, TRUE should be returned and EditClassParams() and ResetClassParams() should be implemented. | |
virtual void | EditClassParams (HWND hParent) |
If the user picks the class from the list this method is called. | |
virtual int | NumActionTables () |
3ds Max calls this to get the number of action tables a plug-in has. | |
virtual ActionTable * | GetActionTable (int i) |
Returns a pointer to the specified action table. | |
virtual BOOL | NeedsToSave () |
Returns TRUE if there is data associated with the class that needs to be saved in the 3ds Max file. | |
virtual IOResult | Save (ISave *isave) |
If NeedsToSave() returns TRUE then this method should be implemented to save the data associated with the class. | |
virtual IOResult | Load (ILoad *iload) |
If NeedsToSave() returns TRUE then this method should be implemented to load the data associated with the class. | |
virtual IParamMap2 * | GetParamMap (ParamBlockDesc2 *pbd) |
Returns a pointer to the parameter map2 whose descriptor is passed. | |
virtual ParamMap2UserDlgProc * | GetUserDlgProc (ParamBlockDesc2 *pbd) |
Returns a pointer to the parameter map 2 user dialog proc (if any) for the specified descriptor. | |
virtual bool | DrawRepresentation (COLORREF bkColor, HDC hDC, Rect &rect) |
Allows a plug-in to provide a custom image for display in Schematic View. | |
virtual int | NumInterfaces () |
Returns the number of function publishing interfaces maintained by the class descriptor. | |
virtual FPInterface * | GetInterfaceAt (int i) |
Returns the nth function publishing interface. | |
virtual CoreExport FPInterface * | GetInterface (Interface_ID id) |
Returns a pointer to the function publishing interface whose ID is specified. | |
virtual CoreExport FPInterface * | GetInterface (const MCHAR *name) |
Returns a pointer to the function publishing interface whose name is specified. | |
virtual CoreExport void | AddInterface (FPInterface *fpi) |
Adds the specified interface to the list maintained by this class descriptor. | |
virtual void | ClearInterfaces () |
Deletes all the interfaces maintained by the class descriptor. | |
virtual INT_PTR | Execute (int cmd, ULONG_PTR arg1=0, ULONG_PTR arg2=0, ULONG_PTR arg3=0) |
This function is maintained so the 3ds Max SDK can be extended without breaking backwards compatibility. | |
![]() | |
void | Init (ClassDesc &classDesc) |
virtual bool | IsCompatibleWithRenderer (ClassDesc &rendererClassDesc)=0 |
virtual bool | GetCustomMtlBrowserIcon (HIMAGELIST &hImageList, int &inactiveIndex, int &activeIndex, int &disabledIndex) |
![]() | |
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 () |
Public Attributes | |
MSPluginClass * | pc |
MSPlugin * | plugin |
RefTargetHandle | base_obj |
![]() | |
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 |
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. | |
![]() | |
static CoreExport FPInterfaceDesc | nullInterface |
![]() | |
void | SetMParamDlg (IAutoMParamDlg *dlg) |
Sets the root level material ParamDlg. | |
void | SetEParamDlg (IAutoEParamDlg *dlg) |
Sets the root level effect ParamDlg. | |
Tab< IParamMap2 * > & | GetParamMaps () |
![]() | |
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) |
|
inline |
|
overridevirtual |
Controls if the plug-in shows up in lists from the user to choose from.
Implements ClassDesc.
|
inlineoverridevirtual |
This method is used to enable or disable the button that allows the plug-ins class to be created.
For example, at certain times it is not appropriate to for the Boolean object to be created. When there is not an object of the appropriate type selected the Boolean object cannot be created. At these times the button should be disabled (the button will appear as grayed out in the Create branch of the command panel). The button should be enabled if there is an object of the appropriate type selected. This method allows a plug-in to control the state of the button.
i | An interface pointer the plug-in may use to call functions in 3ds Max. |
Reimplemented from ClassDesc.
|
inlineoverridevirtual |
3ds Max calls this method when it needs a pointer to a new instance of the plug-in class.
For example, if 3ds Max is loading a file from disk containing a previously used plug-in (procedural object, modifier, controller, etc...), it will call the plug-in's Animatable::Create() method. The plug-in responds by allocating a new instance of its plug-in class. See the Advanced Topic section on ~{ Memory Management }~ for more details.
loading | This parameter is a flag indicating if the class being created is going to be loaded from a disk file. If the flag is TRUE, the plug-in may not have to perform any initialization of the object because the loading process will take care of it. See the Advanced Topics section on ~{ Loading and Saving Plug-in Data }~ for more information. Note: If this parameter is TRUE, developers must initialize their references to NULL. Otherwise 3ds Max may crash. 3ds Max provides a default plug-in object creation process. Many plug-ins fit this form. When the system is about to create an instance of the plug-in object it calls a method BaseObject::GetCreateMouseCallBack().This method returns a callback object whose proc() method handles the mouse input during its creation phase. Most of the work is then handled by the system. The procedural sphere is an example of this type of plug-in. Certain plug-ins may have special creation needs however. The target camera is an example of such a plug-in. Because it needs to create two nodes in the scene (the camera and the target) it requires a custom creation process. To support these plug-ins the following two methods are provided. They allow the plug-in to manage the creation process themselves. See ~{ Object Creation Methods }~ for more details. |
Implements ClassDesc.
|
inlineoverridevirtual |
|
inlineoverridevirtual |
This method returns the non-localized name of the class.
This method was added in 3ds Max 2022 to provide more consistent scripting behavior in localized versions of 3ds Max. In versions of 3ds Max prior to 2022, MAXScript used the name returned from ClassName() (unless UseOnlyInternalNameForMAXScriptExposure() returns true) as (one of) the global variable name(s) holding the MAXClass value which exposes this class. In 3ds Max 2022 and later, MAXScript uses the name returned from NonLocalizedClassName() (unless UseOnlyInternalNameForMAXScriptExposure() returns true) as (one of) the global variable name(s) holding the MAXClass value which exposes this class. To maintain scripting compatibility with older versions of 3ds Max, the name returned should be the ClassName returned for locale en-US in versions of 3ds Max prior to 2022.
Implements ClassDesc.
|
inlineoverridevirtual |
|
inlineoverridevirtual |
This method returns a system defined constant describing the class this plug-in class was derived from.
For example, the Bend modifier returns OSM_CLASS_ID. This super class ID is used by all object space modifiers. See Super Class IDs.
Implements ClassDesc.
|
inlineoverridevirtual |
This method must return the unique ID for the object.
If two ClassIDs conflict, the system will only load the first one it finds. The ClassID consists of two unsigned 32-bit quantities. The constructor assigns a value to each of these, for example Class_ID(0xA1C8E1D1, 0xE7AA2BE5). A developer should use the random Class_ID generator to avoid conflicts (Generate a random Class_ID). See Class Class_ID for more information.
Implements ClassDesc.
|
inlineoverridevirtual |
This methods returns a string describing the category a plug-in fits into.
The category is usually selected in the drop down list in the create, or utility branch of the command panel. In the create branch, if this is set to be an existing category (i.e. "Standard Primitives", "Splines", ...) then the plug-in will appear in that category. If the category doesn't yet exists then it is created. If the plug-in does not need to appear in the list, it may simply return a null string as in _M(""). In the modify branch, the category determines which group it appears in the Configure Button Sets / Modifiers list. These are the categories such as "MAX STANDARD", "MAX EDIT", and "MAX SURFACE".
This method is also used to distinguish between the various types of texture maps so they can be separated in the Material/Map Browser. The appropriate string should be returned by this method of the Texmap. For example:
The options for texture maps are:
Implements ClassDesc.
The custom creation process of the plug-in object is handled by this method.
For example, a plug-in can create a custom command mode and push it on the command stack to handle the creation process.
Important Note: A plug-in that doesn't want to participate in the standard object creation mechanism using CreateMouseCallBack must push a CommandMode on the stack in this method and remove it in EndCreate(). This is true even if the plug-in doesn't do anything inside the mode. A mode has to be pushed on the stack and then later popped off otherwise a crash will occur (if the default implementation of this method is not used). For more details on object creation see the Advanced Topics section ~{ Object Creation Methods }~.
i | An interface pointer the plug-in may use to call functions in 3ds Max. |
Reimplemented from ClassDesc.
The termination of the custom creation process is managed by the implementation of this method.
For example, the plug-in could remove a custom command mode from the command stack. See the Advanced Topics section on ~{ Object Creation Methods }~ for more details.
i | An interface pointer the plug-in may use to call functions in 3ds Max. |
Reimplemented from ClassDesc.
|
overridevirtual |
fileReset | This parameter is not used. |
Reimplemented from ClassDesc2.
|
overridevirtual |
This method returns a DWORD which is used to initialize the rollup state in both the create branch and the modify branch.
The semantics are different, however for these two cases. Whenever the rollups are created in the create branch, their state will be that specified by this method. In the modify branch, the first time an object of this type is modified the state will be that of this method, but after that it will remain what it was last set to.
0x7fffffff
is returned by the default implementation so the command panel can detect this method is not being overridden, and just leave the rollups as is. Reimplemented from ClassDesc.
|
inlineoverridevirtual |
Returns TRUE if the class implements a manipulator object; otherwise FALSE.
Reimplemented from ClassDesc.
|
inlineoverridevirtual |
The method returns true if the class is a manipulator and it manipulates the given base object, modifier or controller.
When starting "Manipulate" mode, this is called on selected nodes for the base object, all modifiers, the TM controller and the position, rotation and scale controllers, if the TM controller is a PRSController.
hTarget | A pointer to a reference target. |
Reimplemented from ClassDesc.
|
inlineoverridevirtual |
Returns TRUE if the manipulator applies to the given node; otherwise FALSE.
This method can be used to indicate that the manipulator works on a part of an object that is not covered by BOOL CanManipulate(ReferenceTarget* hTarget) such as the visibility controller of a node.
pNode | The INode to check. |
Reimplemented from ClassDesc.
|
inlineoverridevirtual |
Creates a manipulator object When a manipulator returns TRUE to CanManipulate(ReferenceTarget* hTarget), the system calls this version of CreateManipulator() to create an instance of the manipulator.
hTarget | - The ReferenceTarget for which a manipulator is requested |
pNode | - The node that the manipulator needs to manipulate (know about) |
Reimplemented from ClassDesc.
|
inlineoverridevirtual |
Creates a manipulator object.
When a manipulator returns TRUE to CanManipulateNode(INode* pNode), the system calls this version of CreateManipulator() to create an instance of the manipulator.
pNode | - The node that the manipulator needs to manipulate (know about) |
Reimplemented from ClassDesc.
|
inlineoverridevirtual |
Returns the DLL instance handle of the plug-in.
This is used so that string resources can be loaded by the ParamBlock2 system.
Reimplemented from ClassDesc.
|
inline |
|
inlineoverridevirtual |
Returns a pointer to the string from the resource string table.
id | The resource ID. |
Reimplemented from ClassDesc.
void StartTool | ( | IObjCreate * | iob | ) |
void StopTool | ( | IObjCreate * | iob | ) |
|
overridevirtual |
This method can be used for further categorizing plugins.
If a plugin has sub-plugins (like light > shadows, particles > operators), this method can be used to differentiate them. sub-plugins can be derived from ReferenceTarget but return a particular class ID published by the parent plugins SDK headers. Then parent plugin can get a list of all reference targets whose SubClassID matches the published SubClassID.
Reimplemented from ClassDesc.
|
overridevirtual |
rendererClassDesc | - Class descriptor of a Renderer plugin |
Implements IMtlRender_Compatibility_MtlBase.
|
overridevirtual |
hImageList | - The image list from which the icons are extracted. The images should have a mask. |
inactiveIndex | - Index (into image list) of icon to be displayed when the material/map has the "Show Maps in Viewport" flag turned OFF. |
activeIndex | - Index (into image list) of icon to be displayed when the material/map has the "Show Maps in Viewport" flag turned ON. |
disabledIndex | - Index (into image list) of icon to be displayed when the material/map is NOT COMPATIBLE with the current renderer. |
Reimplemented from IMtlRender_Compatibility_MtlBase.
MSPluginClass* pc |
MSPlugin* plugin |
RefTargetHandle base_obj |