Class SFXParamDlg
See Also: Class Effect, Class Atmospheric , Class Sampler.
class SFXParamDlg : public InterfaceServer
Description:
This class is available in release 3.0 and later only.
An instance of this class is returned by a rendering effect, atmopsheric plug-in, or sampler when it is asked to put up its rollup page in the user interface.
Methods:
public:
Prototype:
virtual Class_ID ClassID()=0;
Remarks:
Implemented by the Plug-In.
Returns the unique Class_ID of this item.
Prototype:
virtual void SetThing(ReferenceTarget *m)=0;
Remarks:
Implemented by the Plug-In.
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.
Prototype:
virtual ReferenceTarget* GetThing()=0;
Remarks:
Implemented by the Plug-In.
This returns the current filter, sampler, atmospheric or rendering effect being edited.
Prototype:
virtual void SetTime(TimeValue t);
Remarks:
Implemented by the Plug-In.
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:
{}
Prototype:
virtual void DeleteThis()=0;
Remarks:
Implemented by the Plug-In.
Deletes this instance of the class.
Prototype:
virtual INT_PTR Execute(int cmd, ULONG arg1=0, ULONG arg2=0, ULONG arg3=0);
Remarks:
This is a general purpose function that allows the API to be extended in the future. The 3ds max development team can assign new cmd numbers and continue to add functionality to this class without having to 'break' the API.
Parameters:
int cmd
The index of the command to execute.
ULONG arg1=0
Optional argument 1. See the documentation where the cmd option is discussed for more details on these parameters.
ULONG arg2=0
Optional argument 2.
ULONG arg3=0
Optional argument 3.
Return Value:
An integer return value. See the documentation where the cmd option is discussed for more details on the meaning of this value.
Default Implementation:
{ return 0; }