IIRenderMgr Class Reference

#include <IIRenderMgr.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 () const =0
virtual void	SetActive (bool active)=0
virtual const MCHAR *	GetName () const =0
virtual bool	IsActive () const =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	AnyUpdatesPending ()=0
virtual BOOL	AreAnyNodesSelected () const =0
virtual IIRenderMgrSelector *	GetNodeSelector ()=0
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Static Public Member Functions
static IIRenderMgr *	GetActiveIIRenderMgr ()
static unsigned int	GetNumIIRenderMgrs ()
static IIRenderMgr *	GetIIRenderMgr (unsigned int i)
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

See also

Class InterfaceServer, Class IInteractiveRender , Class IIRenderMgrSelector , Class ViewExp

Description:

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

Member Enumeration Documentation

CommandMode

enum CommandMode

Enumerator
CMD_MODE_NULL
CMD_MODE_DRAW_REGION
CMD_MODE_SELECT_OBJECT

    {
        CMD_MODE_NULL = 0,
        CMD_MODE_DRAW_REGION,
        CMD_MODE_SELECT_OBJECT,
    }; // may later add modes for camera control

Member Function Documentation

CanExecute()

virtual bool CanExecute ( ) const

pure virtual

Remarks

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

SetActive()

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.

GetName()

virtual const MCHAR * GetName ( ) const

pure virtual

Remarks

This method will return the name of the render manager.

IsActive()

virtual bool IsActive ( ) const

pure virtual

Remarks

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

GetHWnd()

virtual HWND GetHWnd ( ) const

pure virtual

Remarks

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

GetViewExp()

virtual ViewExp * GetViewExp ( )

pure virtual

Remarks

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

SetPos()

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.

Show()

virtual void Show ( )

pure virtual

Remarks

This method will show the window currently being rendered to.

Hide()

virtual void Hide ( )

pure virtual

Remarks

This method will hide the window currently being rendered to.

UpdateDisplay()

virtual void UpdateDisplay ( )

pure virtual

Remarks

This method will issue an update of the current display.

Render()

virtual void Render ( )

pure virtual

Remarks

This method starts the actual rendering process.

SetDelayTime()

virtual void SetDelayTime ( int  msecDelay )

pure virtual

Remarks

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

GetDelayTime()

virtual int GetDelayTime ( )

pure virtual

Remarks

This method returns the delay time in milliseconds.

Close()

virtual void Close ( )

pure virtual

Remarks

This method will close the window currently being rendered to.

Delete()

virtual void Delete ( )

pure virtual

Remarks

This method will delete this render manager.

SetCommandMode()

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.

GetCommandMode()

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.

SetActOnlyOnMouseUp()

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.

GetActOnlyOnMouseUp()

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.

ToggleToolbar()

virtual void ToggleToolbar ( ) const

pure virtual

Remarks

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

GetDisplayStyle()

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.

IsRendering()

virtual BOOL IsRendering ( )

pure virtual

Remarks

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

AnyUpdatesPending()

virtual BOOL AnyUpdatesPending ( )

pure virtual

Remarks

This method returns TRUE if the renderer has not applied all pending scene updates yet, or FALSE if there are no updates pending and what is currently rendering (or has been rendered) is matching what the scene looks like.

AreAnyNodesSelected()

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.

GetNodeSelector()

virtual IIRenderMgrSelector * GetNodeSelector ( )

pure virtual

Remarks

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

GetActiveIIRenderMgr()

static IIRenderMgr * GetActiveIIRenderMgr ( )

static

Remarks

Obsolete Function

GetNumIIRenderMgrs()

static unsigned int GetNumIIRenderMgrs ( )

static

Remarks

Obsolete Function

GetIIRenderMgr()

static IIRenderMgr * GetIIRenderMgr ( unsigned int  i )

static

Remarks

Obsolete Function