MSAutoEParamDlg Class Reference

#include <mxsPlugin.h>

Inheritance diagram for MSAutoEParamDlg:

Public Member Functions
	MSAutoEParamDlg (IRendParams *i, SpecialFX *fx, MSPlugin *plugin, Rollout *ro)
	~MSAutoEParamDlg ()
Class_ID	ClassID () override
ReferenceTarget *	GetThing () override
void	SetThing (ReferenceTarget *fx) override
void	DeleteThis () override
void	SetTime (TimeValue t) override
void	InvalidateUI () override
int	NumDlgs () override
void	AddDlg (SFXParamDlg *dlg) override
SFXParamDlg *	GetDlg (int i) override
void	SetDlg (int i, SFXParamDlg *dlg) override
void	DeleteDlg (SFXParamDlg *dlg) override
IParamMap2 *	GetMap () override
virtual void	InvalidateUI ()=0
virtual int	NumDlgs ()=0
virtual void	AddDlg (SFXParamDlg *dlg)=0
virtual SFXParamDlg *	GetDlg (int i)=0
virtual void	SetDlg (int i, SFXParamDlg *dlg)=0
virtual void	DeleteDlg (SFXParamDlg *dlg)=0
virtual IParamMap2 *	GetMap ()=0
Public Member Functions inherited from SFXParamDlg
virtual Class_ID	ClassID ()=0
virtual void	SetThing (ReferenceTarget *m)=0
virtual ReferenceTarget *	GetThing ()=0
virtual void	SetTime (TimeValue t)
virtual void	DeleteThis ()=0
virtual INT_PTR	Execute (int cmd, ULONG_PTR arg1=0, ULONG_PTR arg2=0, ULONG_PTR arg3=0)
virtual void	InvalidateUI ()
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Public Attributes
Tab< SFXParamDlg * >	secondaryDlgs
SFXParamDlg *	delegateDlg
MSPlugin *	plugin
Rollout *	ro
SpecialFX *	sfx
IRendParams *	ip

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
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.

Constructor & Destructor Documentation

MSAutoEParamDlg()

MSAutoEParamDlg	(	IRendParams *	i,
		SpecialFX *	fx,
		MSPlugin *	plugin,
		Rollout *	ro
	)

~MSAutoEParamDlg()

~MSAutoEParamDlg

(

)

Member Function Documentation

ClassID()

Class_ID ClassID ( )

inlineoverridevirtual

Remarks

Returns the unique Class_ID of this item.

Implements SFXParamDlg.

{ return sfx->ClassID(); }

GetThing()

ReferenceTarget * GetThing ( )

inlineoverridevirtual

Remarks

This returns the current filter, sampler, atmospheric or rendering effect being edited.

Implements SFXParamDlg.

{ return sfx; }

SetThing()

void SetThing ( ReferenceTarget *  m )

overridevirtual

Remarks

This sets the current filter, sampler, atmospheric or rendering effect being edited to the one passed and updates the user interface controls to reflect the state of the new 'thing'.

Parameters:

ReferenceTarget *m

The effect to save as current.

Implements SFXParamDlg.

DeleteThis()

void DeleteThis ( )

overridevirtual

Remarks

Deletes this instance of the class.

Implements SFXParamDlg.

SetTime()

void SetTime ( TimeValue  t )

overridevirtual

Remarks

This method is called when the current time has changed. This gives the developer an opportunity to update any user interface data that may need adjusting due to the change in time.

Parameters:

TimeValue t

The new current time.

Default Implementation:

{}

Reimplemented from SFXParamDlg.

InvalidateUI()

void InvalidateUI ( )

overridevirtual

Remarks

This method causes the user interface controls to be re-drawn.

Implements IAutoEParamDlg.

NumDlgs()

int NumDlgs ( )

inlineoverridevirtual

Remarks

Returns the number of secondary dialogs.

Implements IAutoEParamDlg.

{ return secondaryDlgs.Count(); }

AddDlg()

void AddDlg ( SFXParamDlg *  dlg )

overridevirtual

Remarks

Adds the specified dialog as another secondary dialog.

Parameters:

SFXParamDlg* dlg

Points to the parameter dialog to add.

Implements IAutoEParamDlg.

GetDlg()

SFXParamDlg * GetDlg ( int  i )

overridevirtual

Remarks

Returns a pointer to the 'i-th' secondary dialog.

Parameters:

int i

The zero-based index of the dialog to return.

Implements IAutoEParamDlg.

SetDlg()

void SetDlg ( int  i, SFXParamDlg *  dlg  )

overridevirtual

Remarks

Sets the 'i-th' dialog to the one passed.

Parameters:

int i

The zero-based index of the dialog to set.

SFXParamDlg* dlg

Points to the parameter dialog to set.

Implements IAutoEParamDlg.

DeleteDlg()

void DeleteDlg ( SFXParamDlg *  dlg )

overridevirtual

Remarks

This method is used for deleting secondary dialogs from a main IAutoEParamDlg. Use this along with AddDlg() if you are dynamically changing the set of rollups for the plugin, so that the P_AUTO_UI system can correctly manage all current secondary rollups.

Parameters:

SFXParamDlg* dlg

Points to the ParamDlg to delete.

Implements IAutoEParamDlg.

GetMap()

IParamMap2 * GetMap ( )

inlineoverridevirtual

Remarks

Returns a pointer to the parameter map2 of this main dialog.

Implements IAutoEParamDlg.

{ return nullptr; }

Member Data Documentation

secondaryDlgs

Tab<SFXParamDlg*> secondaryDlgs

delegateDlg

SFXParamDlg* delegateDlg

plugin

MSPlugin* plugin

ro

Rollout* ro

sfx

SpecialFX* sfx

ip

IRendParams* ip