Detailed Description
- See also:
- Class Effect, Class
Atmospheric, Class
Sampler.
- 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.
#include <sfx.h>
Inheritance diagram for SFXParamDlg:
Public Member Functions |
|
| 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 () |
Member Function Documentation
| virtual Class_ID ClassID | ( | ) | [pure virtual] |
- Remarks:
- Returns the unique Class_ID of this item.
Implemented in MSAutoEParamDlg.
| virtual void SetThing | ( | ReferenceTarget * | m | ) | [pure virtual] |
- 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.
Implemented in MSAutoEParamDlg.
| virtual ReferenceTarget* GetThing | ( | ) | [pure virtual] |
- Remarks:
- This returns the current filter, sampler, atmospheric or rendering effect being edited.
Implemented in MSAutoEParamDlg.
| virtual void SetTime | ( | TimeValue | t | ) | [inline, virtual] |
- 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 in MSAutoEParamDlg.
{ }
| virtual void DeleteThis | ( | ) | [pure virtual] |
- Remarks:
- Deletes this instance of the class.
Implemented in MSAutoEParamDlg.
| virtual INT_PTR Execute | ( | int | cmd, |
| ULONG_PTR | arg1 = 0, |
||
| ULONG_PTR | arg2 = 0, |
||
| ULONG_PTR | arg3 = 0 |
||
| ) | [inline, virtual] |
- Remarks:
- This is a general purpose function that allows the Max SDK to be extended in the future. The 3ds Max development team can assign new command numbers and continue to add functionality to this class without having to 'break' the Max SDK.
- Parameters:
- int cmd
The index of the command to execute.
ULONG_PTR arg1=0
Optional argument 1. See the documentation where the cmd option is discussed for more details on these parameters.
ULONG_PTR arg2=0
Optional argument 2.
ULONG_PTR arg3=0
Optional argument 3.
- Returns:
- 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; }
{ return 0; }
| virtual void InvalidateUI | ( | ) | [inline, virtual] |
