#include <IViewPanel.h>
Many viewpanel related methods of CORE interface only work on the active tabbed view panel.
For example, Interface::getNumViewports() only return the number of viewports of current view panel. This interface provides methods to get/modify settings of a tabbed view panel no matter it is currently active or not. Here is an example on how to get the number of active and non-extended viewports of all view panels.
int viewportCount = 0; for (int i = 0; i < GetViewPanelManager()->GetViewPanelCount(); ++i) { IViewPanel* pViewPanel = GetViewPanelManager()->GetViewPanel(i); if (pViewPanel) { viewportCount += pViewPanel->GetNumberOfViewports(); } }
Public Member Functions |
|
virtual | ~IViewPanel () |
virtual Interface_ID | GetID () |
virtual size_t | GetNumberOfViewports () const =0 |
Gets number of the enabled and non-extended
viewports. |
|
virtual int | GetLayout () const =0 |
Gets the layout of this view panel. |
|
virtual void | SetLayout (int layout)=0 |
Set layout of this view panel. |
|
virtual void | SetLayout (int layout, bool forceSettings)=0 |
Set layout of this view panel. |
|
virtual int | GetViewportIndex (HWND hwnd)=0 |
Gets index of the viewport with the
specified window handle. |
|
virtual bool | SetActiveViewport (int index)=0 |
Set active viewport according to the input
param. |
|
virtual int | GetActiveViewportIndex (void)=0 |
Get the index of the active viewport.
|
|
virtual HWND | GetHWnd ()=0 |
Get the window handle of the tabbed view
panel. |
|
virtual void | SetViewPanelName (const MSTR &newName)=0 |
Set the view panel name. |
|
virtual const MSTR & | GetViewPanelName ()=0 |
Get the view panel name. |
|
virtual ViewExp & | GetViewExpByIndex (int index)=0 |
Get the ViewExp interface given the viewport
index. |
virtual ~IViewPanel | ( | ) | [inline, virtual] |
{}
virtual Interface_ID GetID | ( | ) | [inline, virtual] |
Reimplemented from BaseInterface.
{ return VIEW_PANEL_INTERFACE; }
virtual size_t GetNumberOfViewports | ( | ) | const [pure virtual] |
Gets number of the enabled and non-extended viewports.
virtual int GetLayout | ( | ) | const [pure virtual] |
Gets the layout of this view panel.
virtual void SetLayout | ( | int | layout | ) | [pure virtual] |
Set layout of this view panel.
[in] | layout | the layout configuration to use |
virtual void SetLayout | ( | int | layout, |
bool | forceSettings | ||
) | [pure virtual] |
Set layout of this view panel.
[in] | layout | the layout configuration to use |
[in] | forceSettings | force the config setting to be re-applied |
virtual int GetViewportIndex | ( | HWND | hwnd | ) | [pure virtual] |
Gets index of the viewport with the specified window handle.
User can use the viewport index to get the corresponding ViewExp interface by calling IViewPanel::GetViewExpByIndex(int index).
[in] | hwnd | the window handle of a viewport in this viewpanel. |
virtual bool SetActiveViewport | ( | int | index | ) | [pure virtual] |
Set active viewport according to the input param.
[in] | index | the index of the viewport to be activated |
virtual int GetActiveViewportIndex | ( | void | ) | [pure virtual] |
Get the index of the active viewport.
virtual HWND GetHWnd | ( | ) | [pure virtual] |
Get the window handle of the tabbed view panel.
virtual void SetViewPanelName | ( | const MSTR & | newName | ) | [pure virtual] |
Set the view panel name.
[in] | newName | the new name for the view panel. |
virtual const MSTR& GetViewPanelName | ( | ) | [pure virtual] |