Detailed Description
- See also:
- Class InterfaceServer, Class IInteractiveRender
, Class IIRenderMgrSelector ,
Class ViewExp
- Description:
- This class is available in release 4.0 and later only.
This class represents the abstract (interface) for an interactive rendering manager.
#include <interactiverender.h>
Inheritance diagram for IIRenderMgr:
Public Types |
|
| enum | CommandMode { CMD_MODE_NULL = 0, CMD_MODE_DRAW_REGION, CMD_MODE_SELECT_OBJECT } |
Public Member Functions |
|
| virtual bool | CanExecute ()=0 |
| virtual void | SetActive (bool active)=0 |
| virtual MCHAR * | GetName ()=0 |
| virtual bool | IsActive ()=0 |
| virtual HWND | GetHWnd () const =0 |
| virtual ViewExp * | GetViewExp ()=0 |
| virtual void | SetPos (int X, int Y, int W, int H)=0 |
| virtual void | Show ()=0 |
| virtual void | Hide ()=0 |
| virtual void | UpdateDisplay ()=0 |
| virtual void | Render ()=0 |
| virtual void | SetDelayTime (int msecDelay)=0 |
| virtual int | GetDelayTime ()=0 |
| virtual void | Close ()=0 |
| virtual void | Delete ()=0 |
| virtual void | SetCommandMode (CommandMode commandMode)=0 |
| virtual CommandMode | GetCommandMode () const =0 |
| virtual void | SetActOnlyOnMouseUp (bool actOnlyOnMouseUp)=0 |
| virtual bool | GetActOnlyOnMouseUp () const =0 |
| virtual void | ToggleToolbar () const =0 |
| virtual IImageViewer::DisplayStyle | GetDisplayStyle () const =0 |
| virtual BOOL | IsRendering ()=0 |
| virtual BOOL | AreAnyNodesSelected () const =0 |
| virtual IIRenderMgrSelector * | GetNodeSelector ()=0 |
Static Public Member Functions |
|
| static IIRenderMgr * | GetActiveIIRenderMgr () |
| static unsigned int | GetNumIIRenderMgrs () |
| static IIRenderMgr * | GetIIRenderMgr (unsigned int i) |
Member Enumeration Documentation
| enum CommandMode |
{
CMD_MODE_NULL = 0,
CMD_MODE_DRAW_REGION,
CMD_MODE_SELECT_OBJECT,
}; // may later add modes for camera control
Member Function Documentation
| virtual bool CanExecute | ( | ) | [pure virtual] |
- Remarks:
- This method will indicate the viewport has valid data and can execute.
| virtual void SetActive | ( | bool | active | ) | [pure virtual] |
- Remarks:
- This method allows you to activate and deactivate the current interactive rendering manager.
- Parameters:
- bool active
TRUE to enable; FALSE to disable.
| virtual MCHAR* GetName | ( | ) | [pure virtual] |
- Remarks:
- This method will return the name of the render manager.
| virtual bool IsActive | ( | ) | [pure virtual] |
- Remarks:
- This method returns TRUE if the current interactive rendering manager is active, otherwise FALSE.
| virtual HWND GetHWnd | ( | ) | const [pure virtual] |
- Remarks:
- This method returns a handle to the current window which is being rendered to.
| virtual ViewExp* GetViewExp | ( | ) | [pure virtual] |
- Remarks:
- This method returns a pointer to the ViewExp associated with the current interactive rendering manager.
| virtual void SetPos | ( | int | X, |
| int | Y, | ||
| int | W, | ||
| int | H | ||
| ) | [pure virtual] |
- Remarks:
- This method allows you to set the position and size of the window being rendered to.
- Parameters:
- int X, int Y
The x and y screen coordinates of the window.
int W, int H
The width and height of the window.
| virtual void Show | ( | ) | [pure virtual] |
- Remarks:
- This method will show the window currently being rendered to.
| virtual void Hide | ( | ) | [pure virtual] |
- Remarks:
- This method will hide the window currently being rendered to.
| virtual void UpdateDisplay | ( | ) | [pure virtual] |
- Remarks:
- This method will issue an update of the current display.
| virtual void Render | ( | ) | [pure virtual] |
- Remarks:
- This method starts the actual rendering process.
| virtual void SetDelayTime | ( | int | msecDelay | ) | [pure virtual] |
- Remarks:
- This method allows you to set the delay time in milliseconds.
| virtual int GetDelayTime | ( | ) | [pure virtual] |
- Remarks:
- This method returns the delay time in milliseconds.
| virtual void Close | ( | ) | [pure virtual] |
- Remarks:
- This method will close the window currently being rendered to.
| virtual void Delete | ( | ) | [pure virtual] |
- Remarks:
- This method will delete this render manager.
| virtual void SetCommandMode | ( | CommandMode | commandMode | ) | [pure virtual] |
- Remarks:
- This method allows you to set the command mode.
- Parameters:
-
CommandMode commandMode
One of the following; CMD_MODE_DRAW_REGION, or CMD_MODE_SELECT_OBJECT.
| virtual CommandMode GetCommandMode | ( | ) | const [pure virtual] |
- Remarks:
- This method returns the command mode, which is one of the following; CMD_MODE_DRAW_REGION, or CMD_MODE_SELECT_OBJECT.
| virtual void SetActOnlyOnMouseUp | ( | bool | actOnlyOnMouseUp | ) | [pure virtual] |
- Remarks:
- This method allows you to define whether an interactive rendering action and update should be issued when the mouse button is released upward.
- Parameters:
- bool actOnlyOnMouseUp
TRUE to act only on mouse-up, otherwise FALSE.
| virtual bool GetActOnlyOnMouseUp | ( | ) | const [pure virtual] |
- Remarks:
- This method returns TRUE if the interactive rendering action and update should be issued when the mouse button is released upward, otherwise FALSE.
| virtual void ToggleToolbar | ( | ) | const [pure virtual] |
- Remarks:
- This method toggles the toolbar display mode (for docked windows).
| virtual IImageViewer::DisplayStyle GetDisplayStyle | ( | ) | const [pure virtual] |
- Remarks:
- This method returns the display style of the window being rendered in, which is one of the following; IV_FLOATING or IV_DOCKED.
| virtual BOOL IsRendering | ( | ) | [pure virtual] |
- Remarks:
- This method returns TRUE if the renderer is currently rendering, otherwise FALSE.
| virtual BOOL AreAnyNodesSelected | ( | ) | const [pure virtual] |
- Remarks:
- This method returns TRUE if the rendering manager has any selected notes or FALSE if there are none.
| virtual IIRenderMgrSelector* GetNodeSelector | ( | ) | [pure virtual] |
- Remarks:
- This method allows you to get the interface that determines whether nodes are selected.
| static IIRenderMgr* GetActiveIIRenderMgr | ( | ) | [static] |
- Remarks:
- Obsolete Function
| static unsigned int GetNumIIRenderMgrs | ( | ) | [static] |
- Remarks:
- Obsolete Function
| static IIRenderMgr* GetIIRenderMgr | ( | unsigned int | i | ) | [static] |
- Remarks:
- Obsolete Function
