#include <mxsPlugin.h>

Inheritance diagram for MSPluginDesc:

Public Member Functions
	MSPluginDesc (MSPluginClass *ipc)

int	IsPublic ()
	Controls if the plug-in shows up in lists from the user to choose from. More...

virtual BOOL	OkToCreate (Interface *i)
	This method is used to enable or disable the button that allows the plug-ins class to be created. More...

void *	Create (BOOL loading=FALSE)
	3ds Max calls this method when it needs a pointer to a new instance of the plug-in class. More...

const MCHAR *	ClassName ()
	This method returns the name of the class. More...

const MCHAR *	NonLocalizedClassName ()
	This method returns the non-localized name of the class. More...

const MCHAR *	InternalName ()
	Returns a string which provides a fixed, machine parsable internal name for the plug-in. More...

SClass_ID	SuperClassID ()
	This method returns a system defined constant describing the class this plug-in class was derived from. More...

Class_ID	ClassID ()
	This method must return the unique ID for the object. More...

const MCHAR *	Category ()
	This methods returns a string describing the category a plug-in fits into. More...

int	BeginCreate (Interface *i)
	The custom creation process of the plug-in object is handled by this method. More...

int	EndCreate (Interface *i)
	The termination of the custom creation process is managed by the implementation of this method. More...

void	ResetClassParams (BOOL fileReset)

DWORD	InitialRollupPageState ()
	This method returns a DWORD which is used to initialize the rollup state in both the create branch and the modify branch. More...

BOOL	IsManipulator ()
	Returns TRUE if the class implements a manipulator object; otherwise FALSE. More...

BOOL	CanManipulate (ReferenceTarget *hTarget)
	The method returns true if the class is a manipulator and it manipulates the given base object, modifier or controller. More...

BOOL	CanManipulateNode (INode *pNode)
	Returns TRUE if the manipulator applies to the given node; otherwise FALSE. More...

Manipulator *	CreateManipulator (ReferenceTarget hTarget, INode pNode)
	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. More...

Manipulator *	CreateManipulator (INode *pNode)
	Creates a manipulator object. More...

HINSTANCE	HInstance ()
	Returns the DLL instance handle of the plug-in. More...

const MCHAR *	GetString (INT_PTR id)

const MCHAR *	GetRsrcString (INT_PTR id)
	Returns a pointer to the string from the resource string table. More...

void	StartTool (IObjCreate *iob)

void	StopTool (IObjCreate *iob)

Class_ID	SubClassID ()
	This method can be used for further categorizing plugins. More...

bool	IsCompatibleWithRenderer (ClassDesc &rendererClassDesc)

bool	GetCustomMtlBrowserIcon (HIMAGELIST &hImageList, int &inactiveIndex, int &activeIndex, int &disabledIndex)

Public Member Functions inherited from ClassDesc2
PB2Export	ClassDesc2 ()

PB2Export	~ClassDesc2 ()

PB2Export int	NumParamBlockDescs ()

PB2Export ParamBlockDesc2 *	GetParamBlockDesc (int i)

PB2Export ParamBlockDesc2 *	GetParamBlockDescByID (BlockID id)

PB2Export ParamBlockDesc2 *	GetParamBlockDescByName (const MCHAR *name)

PB2Export void	AddParamBlockDesc (ParamBlockDesc2 *pbd)

PB2Export void	ClearParamBlockDescs ()

PB2Export void	BeginEditParams (IObjParam ip, ReferenceMaker obj, ULONG flags, Animatable *prev)

PB2Export void	EndEditParams (IObjParam ip, ReferenceMaker obj, ULONG flags, Animatable *prev)

PB2Export void	InvalidateUI ()

PB2Export void	InvalidateUI (ParamBlockDesc2 *pbd)

PB2Export void	InvalidateUI (ParamBlockDesc2 *pbd, ParamID id, int tabIndex=-1)

PB2Export void	MakeAutoParamBlocks (ReferenceMaker *owner)

PB2Export int	NumParamMaps ()

PB2Export IParamMap2 *	GetParamMap (int i)

PB2Export IParamMap2 *	GetParamMap (ParamBlockDesc2 *pbd, MapID map_id=0)

PB2Export bool	SetUserDlgProc (ParamBlockDesc2 pbd, MapID map_id, ParamMap2UserDlgProc proc=NULL)

bool	SetUserDlgProc (ParamBlockDesc2 pbd, ParamMap2UserDlgProc proc=NULL)

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. More...

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. More...

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. More...

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 &paramBlock, const MapID paramMapID, MSTR &rollupTitle, int &rollupFlags, int &rollupCategory)
	Creates a Qt widget to be associated with the given parameter map ID. More...

virtual MaxSDK::QMaxParamBlockWidget *	CreateQtWidget (ReferenceMaker &owner, IParamBlock2 &paramBlock, const MapID paramMapID, MSTR &rollupTitle, int &rollupFlags, int &rollupCategory, Class_ID &tabID)
	Creates a Qt widget that is connected to the given parameter block. More...

Public Member Functions inherited from ClassDesc
virtual	~ClassDesc ()

virtual bool	UseOnlyInternalNameForMAXScriptExposure ()
	Returns true if only the InternalName is to be used for MAXScript exposure. More...

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. More...

virtual void	EditClassParams (HWND hParent)
	If the user picks the class from the list this method is called. More...

virtual int	NumActionTables ()
	3ds Max calls this to get the number of action tables a plug-in has. More...

virtual ActionTable *	GetActionTable (int i)
	Returns a pointer to the specified action table. More...

virtual BOOL	NeedsToSave ()
	Returns TRUE if there is data associated with the class that needs to be saved in the 3ds Max file. More...

virtual IOResult	Save (ISave *isave)
	If NeedsToSave() returns TRUE then this method should be implemented to save the data associated with the class. More...

virtual IOResult	Load (ILoad *iload)
	If NeedsToSave() returns TRUE then this method should be implemented to load the data associated with the class. More...

virtual IParamMap2 *	GetParamMap (ParamBlockDesc2 *pbd)
	Returns a pointer to the parameter map2 whose descriptor is passed. More...

virtual ParamMap2UserDlgProc *	GetUserDlgProc (ParamBlockDesc2 *pbd)
	Returns a pointer to the parameter map 2 user dialog proc (if any) for the specified descriptor. More...

virtual bool	DrawRepresentation (COLORREF bkColor, HDC hDC, Rect &rect)
	Allows a plug-in to provide a custom image for display in Schematic View. More...

virtual int	NumInterfaces ()
	Returns the number of function publishing interfaces maintained by the class descriptor. More...

virtual FPInterface *	GetInterfaceAt (int i)
	Returns the nth function publishing interface. More...

virtual CoreExport FPInterface *	GetInterface (Interface_ID id)
	Returns a pointer to the function publishing interface whose ID is specified. More...

virtual CoreExport FPInterface *	GetInterface (const MCHAR *name)
	Returns a pointer to the function publishing interface whose name is specified. More...

virtual CoreExport void	AddInterface (FPInterface *fpi)
	Adds the specified interface to the list maintained by this class descriptor. More...

virtual void	ClearInterfaces ()
	Deletes all the interfaces maintained by the class descriptor. More...

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. More...

Public Member Functions inherited from IMtlRender_Compatibility_MtlBase
void	Init (ClassDesc &classDesc)

Public Member Functions inherited from FPInterfaceDesc
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. More...

CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor. More...

CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor. More...

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)

Public Member Functions inherited from FPInterface
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)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

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 ()

Public Attributes
MSPluginClass *	pc

MSPlugin *	plugin

RefTargetHandle	base_obj

Public Attributes inherited from FPInterfaceDesc
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
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...

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from ClassDesc2
void	SetMParamDlg (IAutoMParamDlg *dlg)
	Sets the root level material ParamDlg. More...

void	SetEParamDlg (IAutoEParamDlg *dlg)
	Sets the root level effect ParamDlg. More...

Tab< IParamMap2 * > &	GetParamMaps ()

Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, USHORT flag, va_list ap)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Constructor & Destructor Documentation

◆ MSPluginDesc()

MSPluginDesc ( MSPluginClass * ipc )

inline

283 { pc = ipc; Init(*this); }

FPInterfaceDesc::Init

virtual void Init()

Definition: ifnpub.h:381

MSPluginDesc::pc

MSPluginClass * pc

Definition: mxsPlugin.h:279

Member Function Documentation

◆ IsPublic()

int IsPublic ( )

virtual

Controls if the plug-in shows up in lists from the user to choose from.

Returns: If the plug-in can be picked and assigned by the user, as is usually the case, return TRUE. Certain plug-ins may be used privately by other plug-ins implemented in the same DLL and should not appear in lists for user to choose from. These plug-ins would return FALSE.

Implements ClassDesc.

◆ OkToCreate()

virtual BOOL OkToCreate ( Interface * i )

inlinevirtual

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.

Parameters

i	An interface pointer the plug-in may use to call functions in 3ds Max.

Returns: TRUE to enable the class creation button; FALSE to disable it.

Sample Code:: The following code from /MAXSDK/SAMPLES/OBJECTS/BOOLOBJ.CPP demonstrates an implementation of this method. If there is not a node selected, it is not OK to use the command so the button should appear disabled. To disable the button OkToCreate() returns FALSE. If the object that is selected is not of the appropriate type it the button is disabled as well

BOOL BoolObjClassDesc::OkToCreate(Interface *i)
{
    if (i->GetSelNodeCount()!=1) return FALSE;
    ObjectState os = i->GetSelNode(0)->GetObjectRef()->Eval(i->GetTime());
    if (os.obj->SuperClassID()!=GEOMOBJECT_CLASS_ID) {
        return FALSE;
    }
    return TRUE;
}

Reimplemented from ClassDesc.

287 { return pc->OkToCreate(i); }

MSPluginClass::OkToCreate

virtual BOOL OkToCreate(Interface *i)

◆ Create()

void* Create ( BOOL loading = FALSE )

inlinevirtual

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.

Parameters

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.

288 { return pc->Create(loading); }

MSPluginClass::Create

virtual RefTargetHandle Create(BOOL isloading)

◆ ClassName()

const MCHAR* ClassName ( )

inlinevirtual

This method returns the name of the class.

This name appears in the button for the plug-in in the 3ds Max user interface.

Returns: The name of the class.

Implements ClassDesc.

289 { return pc->ClassName(); }

MSPluginClass::ClassName

const MCHAR * ClassName()

Definition: mxsPlugin.h:218

◆ NonLocalizedClassName()

const MCHAR* NonLocalizedClassName ( )

inlinevirtual

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.

Returns: The non-localized name of the class.

Implements ClassDesc.

290 { return pc->NonLocalizedClassName(); }

MSPluginClass::NonLocalizedClassName

const MCHAR * NonLocalizedClassName()

Definition: mxsPlugin.h:219

◆ InternalName()

const MCHAR* InternalName ( )

inlinevirtual

Returns a string which provides a fixed, machine parsable internal name for the plug-in.

This name is used by Scripting Engines. MAXScript uses this name (if not null) as (one of) the global variable name(s) holding the MAXClass value which exposes this class.

Reimplemented from ClassDesc.

291 { return pc->InternalName(); }

MSPluginClass::InternalName

const MCHAR * InternalName()

Definition: mxsPlugin.h:220

◆ SuperClassID()

SClass_ID SuperClassID ( )

inlinevirtual

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.

Returns: The SuperClassID of the plug-in.

Implements ClassDesc.

292 { return pc->SuperClassID(); }

MSPluginClass::SuperClassID

SClass_ID SuperClassID()

Definition: mxsPlugin.h:221

◆ ClassID()

Class_ID ClassID ( )

inlinevirtual

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.

Returns: The unique ClassID of the plug-in.

Implements ClassDesc.

293 { return pc->ClassID(); }

MSPluginClass::ClassID

Class_ID ClassID()

Definition: mxsPlugin.h:222

◆ Category()

const MCHAR* Category ( )

inlinevirtual

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:

const MCHAR* Category() {
    return TEXMAP_CAT_3D;
}

The options for texture maps are:

MCHAR TEXMAP_CAT_2D[]; -> 2D maps.
MCHAR TEXMAP_CAT_3D[]; - 3D maps.
MCHAR TEXMAP_CAT_COMP[]; - Composite.
MCHAR TEXMAP_CAT_COLMOD[]; - Color modifier.
MCHAR TEXMAP_CAT_ENV[]; - Environment.

Implements ClassDesc.

294 { return pc->Category(); }

MSPluginClass::Category

const MCHAR * Category()

Definition: mxsPlugin.h:223

◆ BeginCreate()

int BeginCreate ( Interface * i )

virtual

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.

Parameters

i	An interface pointer the plug-in may use to call functions in 3ds Max.

Returns: To use the default creation process (the system implementation for this method) return 0; Return nonzero if the plug-in implements this method.

Reimplemented from ClassDesc.

◆ EndCreate()

int EndCreate ( Interface * i )

virtual

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.

Parameters

i	An interface pointer the plug-in may use to call functions in 3ds Max.

Returns: To use the system implementation for this method return 0; Return nonzero if the plug-in implements this method.

Reimplemented from ClassDesc.

◆ ResetClassParams()

void ResetClassParams ( BOOL fileReset )

virtual

Remarks: This method may be called to restore all sticky parameters to their default values.

Parameters

fileReset This parameter is not used.

Reimplemented from ClassDesc2.

◆ InitialRollupPageState()

DWORD InitialRollupPageState ( )

virtual

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.

Returns: The bits of this DWORD set indicate the corrresponding rollup page is closed. The zero bit corresponds to the plug-ins first rollup, the first bit is the second rollup, etc. The value 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.

◆ IsManipulator()

BOOL IsManipulator ( )

inlinevirtual

Returns TRUE if the class implements a manipulator object; otherwise FALSE.

Reimplemented from ClassDesc.

300 { return pc->IsManipulator(); }

MSPluginClass::IsManipulator

BOOL IsManipulator()

◆ CanManipulate()

BOOL CanManipulate ( ReferenceTarget * hTarget )

inlinevirtual

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.

Parameters

hTarget A pointer to a reference target.

Reimplemented from ClassDesc.

301 { return pc->CanManipulate(hTarget); }

MSPluginClass::CanManipulate

BOOL CanManipulate(ReferenceTarget *hTarget)

◆ CanManipulateNode()

BOOL CanManipulateNode ( INode * pNode )

inlinevirtual

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.

Parameters

pNode The INode to check.

Reimplemented from ClassDesc.

302 { return pc->CanManipulateNode(pNode); }

MSPluginClass::CanManipulateNode

BOOL CanManipulateNode(INode *pNode)

◆ CreateManipulator() [1/2]

Manipulator* CreateManipulator	(	ReferenceTarget *	hTarget,
		INode *	pNode
	)

inlinevirtual

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.

Parameters

hTarget	- The ReferenceTarget for which a manipulator is requested
pNode	- The node that the manipulator needs to manipulate (know about)

Returns: - Pointer to the newly created manipulator, or NULL if the creation failed.
Manipulator* BendManipClassDesc::CreateManipulator(ReferenceTarget* hTarget, INode* node) {

if (hTarget->ClassID() != Class_ID(BENDOSM_CLASS_ID, 0))

return NULL;

return (new BendManip((SimpleMod2*)hTarget, node));

}

NULL
#define NULL
Definition: autoptr.h:18

Animatable::ClassID
virtual CoreExport Class_ID ClassID()
Retrieves a constant that uniquely identifies the plugin class.

Class_ID
Definition: maxtypes.h:67

INode
Definition: inode.h:55

Manipulator
Definition: manipulator.h:356

ReferenceTarget
A scene entity that is being owned and listened to by other scene entities.
Definition: ref.h:1844

SimpleMod2
Base class for parameter block 2 (PB2) based object space modifiers.
Definition: simpmod.h:324

BENDOSM_CLASS_ID
#define BENDOSM_CLASS_ID
Definition: plugapi.h:836

Reimplemented from ClassDesc.

303 { return pc->CreateManipulator(hTarget, pNode); }

MSPluginClass::CreateManipulator

Manipulator * CreateManipulator(ReferenceTarget *hTarget, INode *pNode)

◆ CreateManipulator() [2/2]

Manipulator* CreateManipulator ( INode * pNode )

inlinevirtual

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.

Parameters

pNode - The node that the manipulator needs to manipulate (know about)

Returns: - Pointer to the newly created manipulator, or NULL if the creation failed.

Reimplemented from ClassDesc.

304 { return pc->CreateManipulator(pNode); }

◆ HInstance()

HINSTANCE HInstance ( )

inlinevirtual

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.

306 { return pc->HInstance(); }

MSPluginClass::HInstance

HINSTANCE HInstance()

Definition: mxsPlugin.h:224

◆ GetString()

const MCHAR* GetString ( INT_PTR id )

inline

307 { return id != 0 ? (const MCHAR*)id : NULL; } // resIDs are actual string ptrs in msplugins...

◆ GetRsrcString()

const MCHAR* GetRsrcString ( INT_PTR id )

inlinevirtual

Returns a pointer to the string from the resource string table.

Parameters

id	The resource ID.

Note: if the resource ID value is 0, a blank string is returned. If the resource ID value cannot be found, the string ">>> @!&*# <<<" is returned.

Reimplemented from ClassDesc.

308 { return id != 0 ? (const MCHAR*)id : NULL; }

◆ StartTool()

void StartTool ( IObjCreate * iob )

◆ StopTool()

void StopTool ( IObjCreate * iob )

◆ SubClassID()

Class_ID SubClassID ( )

virtual

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.

◆ IsCompatibleWithRenderer()

bool IsCompatibleWithRenderer ( ClassDesc & rendererClassDesc )

virtual

Remarks: Returns whether this material/map is compatible with the given renderer. (Use the class ID of the renderer to determine compatibility).

Parameters

rendererClassDesc - Class descriptor of a Renderer plugin

Implements IMtlRender_Compatibility_MtlBase.

◆ GetCustomMtlBrowserIcon()

bool GetCustomMtlBrowserIcon	(	HIMAGELIST &	hImageList,
		int &	inactiveIndex,
		int &	activeIndex,
		int &	disabledIndex
	)

virtual

Remarks: Provides custom icons for the material/map browser. Returns true if custom icons are provided.

When using this method, the developer should keep a single instance of the imagelist used, and it is the developers responsibility to release the memory

Parameters

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.

Returns: true if custom icons are provided

Reimplemented from IMtlRender_Compatibility_MtlBase.

Member Data Documentation

◆ pc

MSPluginClass* pc

◆ plugin

MSPlugin* plugin

◆ base_obj

RefTargetHandle base_obj

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ MSPluginDesc()

Member Function Documentation

◆ IsPublic()

◆ OkToCreate()

◆ Create()

◆ ClassName()

◆ NonLocalizedClassName()

◆ InternalName()

◆ SuperClassID()

◆ ClassID()

◆ Category()

◆ BeginCreate()

◆ EndCreate()

◆ ResetClassParams()

◆ InitialRollupPageState()

◆ IsManipulator()

◆ CanManipulate()

◆ CanManipulateNode()

◆ CreateManipulator() [1/2]

◆ CreateManipulator() [2/2]

◆ HInstance()

◆ GetString()

◆ GetRsrcString()

◆ StartTool()

◆ StopTool()

◆ SubClassID()

◆ IsCompatibleWithRenderer()

◆ GetCustomMtlBrowserIcon()

Member Data Documentation

◆ pc

◆ plugin

◆ base_obj