Class IIRenderMgr

3DS Max Plug-In SDK

Class IIRenderMgr

See Also: Class InterfaceServer, Class IInteractiveRender , IIRenderMgrSelector , Class ViewExp

class IIRenderMgr : public InterfaceServer

Description:

This class is available in release 4.0 and later only.

This class represents the abstract (interface) for an interactive rendering manager.

Methods:

public:

Prototype:

virtual bool CanExecute() = 0;

Remarks:

This method will indicate the viewport has valid data and can execute.

Prototype:

virtual void SetActive(bool active) = 0;

Remarks:

This method allows you to activate and deactivate the current interactive rendering manager.

Parameters:

bool active

TRUE to enable; FALSE to disable.

Prototype:

virtual TCHAR* GetName() = 0;

Remarks:

This method will return the name of the render manager.

Prototype:

virtual bool IsActive() = 0;

Remarks:

This method returns TRUE if the current interactive rendering manager is active, otherwise FALSE.

Prototype:

virtual BOOL AreAnyNodesSelected() const = 0;

Remarks:

This method returns TRUE if the rendering manager has any selected notes or FALSE if there are none.

Prototype:

virtual IIRenderMgrSelector* GetNodeSelector() = 0;

Remarks:

This method allows you to get the interface that determines whether nodes are selected.

Prototype:

virtual HWND GetHWnd() const = 0;

Remarks:

This method returns a handle to the current window which is being rendered to.

Prototype:

virtual ViewExp *GetViewExp() = 0;

Remarks:

This method returns a pointer to the ViewExp associated with the current interactive rendering manager.

Prototype:

virtual void SetPos(int X, int Y, int W, int H) = 0;

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.

Prototype:

virtual void Show() = 0;

Remarks:

This method will show the window currently being rendered to.

Prototype:

virtual void Hide() = 0;

Remarks:

This method will hide the window currently being rendered to.

Prototype:

virtual void UpdateDisplay() = 0;

Remarks:

This method will issue an update of the current display.

Prototype:

virtual void Render() = 0;

Remarks:

This method starts the actual rendering process.

Prototype:

virtual void SetDelayTime(int msecDelay) = 0;

Remarks:

This method allows you to set the delay time in milliseconds.

Prototype:

virtual int GetDelayTime() = 0;

Remarks:

This method returns the delay time in milliseconds.

Prototype:

virtual void Close() = 0;

Remarks:

This method will close the window currently being rendered to.

Prototype:

virtual void Delete() = 0;

Remarks:

This method will delete this render manager.

Prototype:

virtual void SetCommandMode(CommandMode commandMode) = 0;

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.

Prototype:

virtual CommandMode GetCommandMode() const = 0;

Remarks:

This method returns the command mode, which is one of the following; CMD_MODE_DRAW_REGION, or CMD_MODE_SELECT_OBJECT.

Prototype:

virtual void SetActOnlyOnMouseUp(bool actOnlyOnMouseUp) = 0;

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.

 

Prototype:

virtual bool GetActOnlyOnMouseUp() const = 0;

Remarks:

This method returns TRUE if the interactive rendering action and update should be issued when the mouse button is released upward, otherwise FALSE.

Prototype:

virtual void ToggleToolbar() const = 0;

Remarks:

This method toggles the toolbar display mode (for docked windows).

Prototype:

virtual IImageViewer::DisplayStyle GetDisplayStyle() const = 0;

Remarks:

This method returns the display style of the window being rendered in, which is one of the following; IV_FLOATING or IV_DOCKED.

Prototype:

virtual BOOL IsRendering() = 0;

Remarks:

This method returns TRUE if the renderer is currently rendering, otherwise FALSE.

Prototype:

static IIRenderMgr* GetActiveIIRenderMgr();

Remarks:

This method returns a pointer to the active interactive rendering manager, or NULL if none exist.

Prototype:

static unsigned int GetNumIIRenderMgrs();

Remarks:

This method returns the number of interactive rendering managers.

Prototype:

static IIRenderMgr* GetIIRenderMgr(unsigned int i);

Remarks:

This method returns a pointer to the I-th interactive rendering manager.

Parameters:

unsigned int i

The index of the IIRenderMgr to return.