#include <iimageviewer.h>
Class Description
- See also:
- Class IImageViewer, Class Bitmap, Class CropCallback
- Description:
- This class represents an abstract interface class for a default
bitmap viewer.
The following functions are available for use but are not part of
the class IMaxBitmapViewer.
Note that the minimum size of the floating window is 390 x
325.
Public Member Functions
|
virtual
void |
SetBitmap
(Bitmap *pBitmap)=0 |
virtual
Bitmap * |
GetBitmap
() const =0 |
virtual
void |
SetCropCB
(CropCallback
*pCropCallback)=0 |
virtual
CropCallback
* |
GetCropCB
() const =0 |
virtual
void |
SetAutonomous
(bool isAutonomous)=0 |
virtual
bool |
GetAutonomous
() const =0 |
virtual
void |
SetCurrentPosition
(WindowPosition
currentPosition)=0 |
virtual
WindowPosition |
GetCurrentPosition
() const =0 |
virtual
void |
SetShowSaveButton
(bool showSaveButton)=0 |
virtual
bool |
GetShowSaveButton
() const =0 |
virtual
bool |
Display
(const MCHAR *title, WindowPosition
position=WPos_Center)=0 |
virtual
bool |
Display
(MCHAR *title, WindowPosition
position) sealed |
virtual
bool |
Display
(const MCHAR *title, HWND hParent, int x, int
y, int w, int h)=0 |
virtual
bool |
Display
(MCHAR *title, HWND hParent, int x, int
y, int w, int h) sealed |
virtual
bool |
UnDisplay
()=0 |
virtual
void |
ClearScreen
()=0 |
virtual
POINT |
XFormScreenToBitmap
(const POINT &pt) const =0 |
virtual
POINT |
XFormBitmapToScreen
(const POINT &pt) const =0 |
virtual
Rect |
XFormScreenToBitmap
(const Rect &rect)
const =0 |
virtual
Rect |
XFormBitmapToScreen
(const Rect &rect)
const =0 |
virtual
void |
ShowToolbar
(bool show)=0 |
virtual
void |
ToggleToolbar
()=0 |
virtual
void |
GetDrawableRect
(Rect
&drawableRect)=0 |
virtual
void |
RefreshWindow
(Rect
*pRefreshRegion=NULL)=0 |
virtual
BaseInterface
* |
GetInterface
(Interface_ID
id) |
Member Function Documentation
virtual void SetBitmap |
( |
Bitmap * |
pBitmap |
) |
[pure virtual] |
- Parameters:
- Bitmap* pBitmap
A pointer to the bitmap to display.
virtual Bitmap* GetBitmap |
( |
|
) |
const [pure virtual] |
virtual void SetCropCB |
( |
CropCallback * |
pCropCallback |
) |
[pure virtual] |
- Parameters:
- CropCallback* pCropCallback
A pointer to the callback function to set.
virtual void SetAutonomous |
( |
bool |
isAutonomous |
) |
[pure virtual] |
- Parameters:
- bool isAutonomous
TRUE to set the viewer to autonomous, otherwise FALSE.
virtual bool GetAutonomous |
( |
|
) |
const [pure virtual] |
virtual void SetCurrentPosition |
( |
WindowPosition |
currentPosition |
) |
[pure virtual] |
virtual void SetShowSaveButton |
( |
bool |
showSaveButton |
) |
[pure virtual] |
- Parameters:
- bool showSaveButton
TRUE to show; FALSE to hide.
virtual bool GetShowSaveButton |
( |
|
) |
const [pure virtual] |
virtual bool Display |
( |
const MCHAR * |
title, |
|
|
WindowPosition |
position =
WPos_Center |
|
) |
|
[pure virtual] |
- Parameters:
- MCHAR *title
The title of the window to set.
WindowPosition position = WPos_Center
The window position you wish to set, which is one of the following
enum values; WPos_NULL, WPos_UpperLeft, WPos_LowerLeft,
WPos_UpperRight, WPos_LowerRight, WPos_Center.
- Returns:
- TRUE if successful, otherwise FALSE.
virtual bool Display |
( |
MCHAR * |
title, |
|
|
WindowPosition |
position |
|
) |
|
[inline, sealed, virtual] |
- Deprecated:
- Deprecated method in terms of implementation as of 3ds Max 2013
- re-implement with const MCHAR* method signature
{
return Display(const_cast<const MCHAR*>(title), position); }
virtual bool Display |
( |
const MCHAR * |
title, |
|
|
HWND |
hParent, |
|
|
int |
x, |
|
|
int |
y, |
|
|
int |
w, |
|
|
int |
h |
|
) |
|
[pure virtual] |
- Parameters:
- MCHAR *title
The title of the window to set.
HWND hParent
A handle to the parent window.
int x, y, h, w
The position and dimensions of the window.
Note that these parameters will be ignored unless 'Current
Position' is WPos_NULL.
- Returns:
- TRUE if successful, otherwise FALSE.
virtual bool Display |
( |
MCHAR * |
title, |
|
|
HWND |
hParent, |
|
|
int |
x, |
|
|
int |
y, |
|
|
int |
w, |
|
|
int |
h |
|
) |
|
[inline, sealed, virtual] |
- Deprecated:
- Deprecated method in terms of implementation as of 3ds Max 2013
- re-implement with const MCHAR* method signature
{
return Display(const_cast<const MCHAR*>(title), hParent, x, y, w, h); }
virtual bool UnDisplay |
( |
|
) |
[pure virtual] |
virtual void ClearScreen |
( |
|
) |
[pure virtual] |
virtual POINT XFormScreenToBitmap |
( |
const POINT & |
pt |
) |
const [pure virtual] |
- Parameters:
- const POINT &pt
The point on screen.
virtual POINT XFormBitmapToScreen |
( |
const POINT & |
pt |
) |
const [pure virtual] |
- Parameters:
- const POINT &pt
The point on the bitmap.
virtual Rect XFormScreenToBitmap |
( |
const Rect & |
rect |
) |
const [pure virtual] |
- Parameters:
- const Rect &rect
The screen rectangle.
virtual Rect XFormBitmapToScreen |
( |
const Rect & |
rect |
) |
const [pure virtual] |
- Parameters:
- const Rect &rect
The bitmap rectangle.
virtual void ShowToolbar |
( |
bool |
show |
) |
[pure virtual] |
- Parameters:
- bool show
TRUE to show; FALSE to hide.
virtual void ToggleToolbar |
( |
|
) |
[pure virtual] |
virtual void GetDrawableRect |
( |
Rect
& |
drawableRect |
) |
[pure virtual] |
- Parameters:
- Rect& drawableRect
The client area.
virtual void RefreshWindow |
( |
Rect
* |
pRefreshRegion =
NULL |
) |
[pure virtual] |
- Parameters:
- Rect* pRefreshRegion = NULL
The region of the window you wish to refresh.