CUIFrameMgr Class Reference
CUIFrameMgr Class Referenceabstract
#include <custcont.h>
Class Description
- See also
- Class ICUIFrame, Class CUIFrameMsgHandler, Class ICustToolbar, Class ICustomControl, Class ICustStatus, Class MAXBmpFileIcon.
- Description:
- reflect changes with MAXBMPFileIcon class***
This object controls the overall operation of the individual CUI Frames (the name given to the windows that contain toolbars, menus, the command panel, etc.). There is one instance of this CUIFrameMgr class (obtained by calling the global function GetCUIFrameMgr()). Methods of this class are available to do things like float and dock individual windows, get pointers to frames, get pointers to button and status controls, and bring up the standard toolbar right click menu .
Note: Developers may use their own images on icon buttons that are managed by this class but the following guidelines must be followed:
BMP files must be put in the /UI/icons folder. This is the UI directory under the 3ds Max EXE directory. This is hard coded because it must be retrieved before 3ds Max is fully started and thus there is no configurable path for it. There is a command line option however, (-c), which specifies for 3ds Max to look in an alternate directory for the CUI file. In that case the bitmap files should be located in the same directory.
For more information on the new icon image system refer to the chapter on Icons.
Inheritance diagram for CUIFrameMgr:
Protected Member Functions | |
| CoreExport | CUIFrameMgr () |
| Constructor made protected to prevent instantiation. More... | |
| CUIFrameMgr (CUIFrameMgr &frame) | |
| Copy Constructor made protected to prevent instantiation. More... | |
| virtual CoreExport | ~CUIFrameMgr () |
Protected Attributes | |
| MSTR | cfgFile |
| Protected Attributes inherited from BaseInterfaceServer | |
| Tab< BaseInterface * > | interfaces |
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. 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... | |
Constructor & Destructor Documentation
|
protected |
Constructor made protected to prevent instantiation.
Blocking default constructor - use GetCUIFrameMgr() accessor
- Remarks
- Constructor.
|
protected |
Copy Constructor made protected to prevent instantiation.
Blocking Copy constructor - use GetCUIFrameMgr() accessor
|
protectedvirtual |
- Remarks
- Destructor.
Member Function Documentation
| CoreExport void SetAppHWnd | ( | HWND | _hApp | ) |
- Remarks
- This method is for internal use only.
| CoreExport const MCHAR* GetCUIDirectory | ( | ) |
- Remarks
- Returns the directory name of the custom user interface (CUI) file location.
| CoreExport void ProcessCUIMenu | ( | HWND | hWnd, |
| int | x, | ||
| int | y | ||
| ) |
- Remarks
- This brings up the CUI right click menu (with the Add Tab, Delete Tab, etc selections). Also see the global function DoCUICustomizeDialog().
- Parameters
-
hWnd The handle of the window there the mouse was clicked. x The x coordinate of the mouse when right clicked. y The y coordinate of the cursor when right clicked.
| CoreExport void DockCUIWindow | ( | HWND | hWnd, |
| int | panel, | ||
| RECT * | rp = NULL, |
||
| int | init = FALSE |
||
| ) |
- Remarks
- This method docks the CUI window whose handle is passed. Developers who want to dock a window should use this method by passing a rectangle which specifies the general area of the screen where the window is to be docked. This will cause 3ds Max reorganize the existing windows.
- Parameters
-
hWnd The handle of the window to dock. panel The CUI docking panel location. One of the following values:
CUI_TOP_DOCK
Docked at the top.
CUI_BOTTOM_DOCK
Docked at the bottom.
CUI_LEFT_DOCK
Docked on the left.
CUI_RIGHT_DOCK
Docked on the right.rp This is the rectangle which specifies where to dock the window. This is the rectangle that a user moves around the screen when dragging a floating window over top of a docking region. This is specified in screen coordinates. If NULL is passed the window is docked using CUI_TOP_DOCK. init This is used internally by 3ds Max when it's starting up. This should always default to FALSE (don't override this and pass TRUE).
| CoreExport void FloatCUIWindow | ( | HWND | hWnd, |
| RECT * | rp = NULL, |
||
| int | init = FALSE |
||
| ) |
- Remarks
- Floats (un-docks) the specified CUI Window.
- Parameters
-
hWnd The window to float. rp Specifies the rectangle in screen coordinates where the floating window should reside. If NULL is passed the window is restored to the position it was before it was docked (this information is stored in the CUI file).
Note: Calling this method on an already floating window will explicitly NOT resize the window, but rather just move it to the new origin. Said another way, only the left and top members of the rectangle are used on an already floating window. Developers should call the Win32 API MoveWindow or SetWindowPlacement to size the window. See GetFloatingCUIFrameSize() below to compute a size.init This is used internally by 3ds Max when it's starting up. This should always default to FALSE (don't override this and pass TRUE).
| CoreExport void MinimizeCUIWindow | ( | HWND | hWnd, |
| int | init = FALSE |
||
| ) |
- Remarks
- Switch CUI window to "minimize docked" state. A minimized CUI window can be expanded when user hover the cursor onto the minimized strip. The window is minimized to where it used to be docked. So there's no need to provide another docking panel location nor rectangle as parameter. This will cause 3ds Max reorganize the existing windows.
- Parameters
-
hWnd The handle of the window to minimize. init This is used internally by 3ds Max when it's starting up. This should always default to FALSE (don't override this and pass TRUE).
| CoreExport void SetReservedSize | ( | int | panel, |
| int | size | ||
| ) |
- Remarks
- This method is for internal use only.
| CoreExport int GetReservedSize | ( | int | panel | ) |
- Remarks
- This method is for internal use only.
| CoreExport int GetPanelSize | ( | int | panel, |
| int | incReserved = FALSE |
||
| ) |
- Remarks
- This method is for internal use only.
| CoreExport int GetPanelWidth | ( | int | panel | ) |
| CoreExport void RecalcLayout | ( | int | entireApp = FALSE | ) |
- Remarks
- This method may be called to recalculates the layout of the CUI. Developers need to call this method after they, for example, add new tool palettes. A developer would create the new palettes and then call this method when done. Otherwise the changes wouldn't be reflected until the user redrew the viewports or resized 3ds Max.
- Parameters
-
entireApp TRUE to recalculate the entire application, including the viewports. This can be expensive (basically like an Interface::ForceCompleteRedraw()); FALSE will recalculate the top, bottom, left and right panels but won't redraw the viewports.
| CoreExport void DrawCUIWindows | ( | int | panels = CUI_ALL_PANELS | ) |
- Remarks
- This method redraws the specified panels. Typically developers don't need to call this method.
- Parameters
-
panels See CUI Docking Panel Locations.
| CoreExport void SetMacroButtonStates | ( | BOOL | force | ) |
- Remarks
- This is a very important method. It redraws all the visible CUI buttons in 3ds Max, calling the "IsEnabled" and
"IsChecked" handlers on the ActionItems associated with each button (if it has one). If a the "IsEnabled" handler returns FALSE, the button is grayed out. If the "IsChecked" handler return TRUE, the button is draw pressed in.
This method is called internally by the system on selection changes and command mode changes. This handles the majority of the cases where buttons need to be redrawn. However, if a 3rd party plug-in changes some sort of internal state that might affect the return value of an ActionItem's IsEnables or IsChecked handler, then the plug-in should call this method to update the button states. If this method isn't called, buttons may look disabled or pressed (or visa versa) when they shouldn't be. See Class ActionItem.
- Parameters
-
force This parameter, if TRUE, tells the system to redraw the button even if its state hasn't changed since the last time it was redrawn. Normally this argument is FALSE so it only redraws the buttons that changed state.
| CoreExport void ResetIconImages | ( | ) |
- Remarks
- This method is for internal use only. This is automatically called when the system changes its custom colors. It tells all the buttons on toolbars to toss their icon image cache.
This method only resets the icons for toolbars that are part of the CUI system, not for toolbars created by other code, which is why the ICustToolbar method ResetIconImages() is needed. See the method ICustToolbar::ResetIconImages.
| CoreExport int OverDockRegion | ( | LPPOINT | pt, |
| DWORD | posType, | ||
| int | override = FALSE |
||
| ) |
- Remarks
- Given a point and a position type this method returns nonzero if the point is over the specified docking region; otherwise zero.
- Parameters
-
pt The input point to check in screen coordinates. posType See CUI Frame Position Types. override Passing TRUE overrides the docking function so that it won't dock. Passing FALSE will cause it to dock. Also note that if the UI layout is locked, passing TRUE here will override that lock.
In the code fragment below the state of the Ctrl key is checked and used as the docking override.
- Sample Code:
- GetCursorPos(&pt);overDockRegion = GetCUIFrameMgr()->OverDockRegion(&pt, cf->GetPosType(), (GetKeyState(VK_CONTROL) & 0x8000));
| CoreExport void SetMode | ( | int | md | ) |
- Remarks
- This method is for internal use only.
| CoreExport int GetMode | ( | ) |
- Remarks
- This method is for internal use only.
| CoreExport void ExpertMode | ( | int | onOff | ) |
- Remarks
- This method is for internal use only. Calling this method alone will not put 3ds Max in Expert mode.
| CoreExport void HideFloaters | ( | int | onOff | ) |
| CoreExport HWND GetItemHwnd | ( | int | id | ) |
- Remarks
- Returns the window handle for the item whose ID is passed. This correspond to the method in ICustToolbar but which should no longer be called for Tool Palettes. It is now also a method of this class because the CUI system doesn't know which toolbar a particular button is on. For example, a 3ds Max user in 3.0 can drag a button from one tool palette to another. No longer then can one use the previous GetItemHwnd() method since the button has moved to a different toolbar.
- Parameters
-
id The ID of the control.
| CoreExport ICustButton* GetICustButton | ( | int | id | ) |
- Remarks
- Returns a pointer to the custom button whose ID is passed (or NULL if not found). In the CUIFrameMgr implementation of this method it loops through each toolbar that it has control over and calls ICustToolbar::GetICustButton() on it. That method returns NULL if it doesn't find the specified ID. The CUIFrameMgr keeps looping through the toolbars until it gets a non-NULL value. When it finds it it returns the ICustButton pointer.
- Parameters
-
id The ID of the control.
| CoreExport ICustStatus* GetICustStatus | ( | int | id | ) |
- Remarks
- Returns a pointer to the custom status control whose ID is passed.
Returns a pointer to the custom status control whose ID is passed (or NULL if not found). In the CUIFrameMgr implementation of this method it loops through each toolbar that it has control over and calls ICustToolbar::GetICustStatus() on it. That method returns NULL if it doesn't find the specified ID. The CUIFrameMgr keeps looping through the toolbars until it gets a non-NULL value. When it finds it it returns the ICustStatus pointer.
- Parameters
-
id The ID of the control.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
| CoreExport int GetCount | ( | ) |
- Remarks
- Returns the number of frames that exist.
| CoreExport ICUIFrame* GetICUIFrame | ( | int | i | ) |
- Remarks
- Returns a pointer to the CUI Frame as specified by the index passed.
- Parameters
-
i The zero based index in the list of frames (between 0 and GetCount()-1).
| CoreExport ICUIFrame* GetICUIFrame | ( | const MCHAR * | name | ) |
- Remarks
- Returns a pointer to the CUI Frame as specified by the name passed.
- Parameters
-
name The name of the frame.
| CoreExport ICUIFrame* GetICUIFrame | ( | int | panel, |
| int | rank, | ||
| int | subrank | ||
| ) |
- Remarks
- Returns a pointer to the CUI Frame as specified by the panel, rank and subrank passed.
- Parameters
-
panel One of a set of values. rank The zero based rank index. subrank The zero based sub-rank index.
| CoreExport int SetConfigFile | ( | const MCHAR * | cfg | ) |
- Remarks
- This method is for internal use only.
| CoreExport const MCHAR* GetConfigFile | ( | ) |
- Remarks
- This returns the path to the CUI file in use. This may be a UNC name.
| CoreExport int DeleteSystemWindows | ( | int | toolbarsOnly = TRUE | ) |
- Remarks
- This method is for internal use only.
| CoreExport int CreateSystemWindows | ( | int | reset = FALSE | ) |
- Remarks
- This method is for internal use only.
| CoreExport int GetSystemWindowCount | ( | ) |
|
inline |
|
inline |
|
inline |
- Remarks
- Returns the bitmap button image height for the specified size.
- Parameters
-
sz The size to check. If 0 is passed then the current icon size is checked. One of the following values:
CUI_SIZE_16
CUI_SIZE_24
|
inline |
- Remarks
- Returns the bitmap button image width for the specified size.
- Parameters
-
sz The size to check. One of the following values:
CUI_SIZE_16
CUI_SIZE_24
| CoreExport void SetDefaultData | ( | CUIFrameMsgHandler * | msg, |
| HIMAGELIST | img16, | ||
| HIMAGELIST | img24 = NULL |
||
| ) |
- Remarks
- This method is for internal use only.
| CoreExport int GetDefaultImageListBaseIndex | ( | SClass_ID | sid, |
| Class_ID | cid | ||
| ) |
- Remarks
- This method is used internally to create a MaxBmpFileIcon for a given object type. These methods retrieve the file name and base index in the file of the icon for the given object class. They are used in the constructor for MaxBmpFileIcon that takes a class ID and super class ID. This method is for internal use only.
| CoreExport MSTR* GetDefaultImageListFilePrefix | ( | SClass_ID | sid, |
| Class_ID | cid | ||
| ) |
- Remarks
- This method is used internally to create a MaxBmpFileIcon for a given object type. These methods retrieve the file name and base index in the file of the icon for the given object class. They are used in the constructor for MaxBmpFileIcon that takes a class ID and super class ID. This method is for internal use only.
| CoreExport int AddToRawImageList | ( | const MCHAR * | pFilePrefix, |
| int | sz, | ||
| HBITMAP | image, | ||
| HBITMAP | mask | ||
| ) |
- Remarks
- This method is for internal use only. It is used to add images to the icon manager. The icon manager, which is used to implement the MaxBmpFileIcon class, reads all the .bmp files in the UI/Icons directory at startup time. These icons are specified by an image file and an alpha mask. The icons support two sizes. Large, which is 24 by 24 and small, which is 15 by 16. The icon manager stores the unprocessed image and alpha masks (the "raw" images). Whenever an instance of MaxBmpFileIcon needs to draw itself, it gets the image list and index of the icon in the imagelist using GetSmallImageIndex or GetLargeImageIndex.
| CoreExport int LoadBitmapFile | ( | const MCHAR * | filename | ) |
- Remarks
- This method is for internal use only.
| CoreExport int FindAndLoadBitmapFiles | ( | const MaxSDK::Util::Path & | filePath | ) |
- Remarks
- This method is for internal use only.
| CoreExport int LoadBitmapImages | ( | ) |
- Remarks
- This method is for internal use only.
|
inline |
| CoreExport int ReadConfig | ( | ) |
- Remarks
- Plug-In developers should not call this method – it is for internal use only.
| CoreExport int WriteConfig | ( | ) |
- Remarks
- Plug-In developers should not call this method – it is for internal use only.
|
inline |
|
inline |
| CoreExport void EnableAllCUIWindows | ( | int | enabled | ) |
- Remarks
- This method is for internal use only.
|
pure virtual |
Given a configuration filename, will attempt to find the best match.
If the application is configured to use User Profiles, this function will attempt to match the filename in the user profile UI directory. If this fails, it will check the system directory.
- Parameters
-
aFilename [in] the filename to match, with extension aResult [out] the resulting absolute path for the matched file, if found
- Returns
- true if a match is found, false otherwise
|
pure virtual |
Given a configuration filename, will resolve the correct write absolute path.
If the application is configured to use User Profiles, this function map this configuration file to a user profile directory. Otherwise, the configuration file will be resolved to the legacy system UI directory.
- Parameters
-
aFilename [in] the filename to match, with extension aResult [out] the resulting absolute path to which a client should write a config file
- Returns
- true if resolved correctly, false if any error is encountered
Member Data Documentation
|
protected |