Public Types | Public Member Functions

IBitmapProxyManager Class Reference

Search for all occurrences

Detailed Description

Bitmap Proxy Manager Function-Published Interface.

#include <bitmap.h>

Inheritance diagram for IBitmapProxyManager:
Inheritance graph
[legend]

List of all members.

Public Types

enum   RenderMode { kRenderMode_UseProxies, kRenderMode_UseFullRes_KeepInMemory, kRenderMode_UseFullRes_FlushFromMemory }
enum   {
  proxySizeFactor_Full = 1, proxySizeFactor_Half = 2, proxySizeFactor_Third = 3, proxySizeFactor_Quarter = 4,
  proxySizeFactor_Eighth = 8
}
enum   { proxyRequestRefresh_UpdateStale = 1, proxyRequestRefresh_RefreshAll = 2, proxyRequestRefresh_GenerateAll = 4 }
enum   { proxyRequestFlags_ForceProxyMode = 0x40000000 }
enum   { proxyRequestLoad_UseLoadedProxy = 1, proxyRequestLoad_ReloadProxy = 2, proxyRequestLoad_UseLoadedSubject = 3, proxyRequestLoad_ReloadSubject = 4 }

Public Member Functions

virtual BOOL  GetGlobalProxyEnable ()=0
  Returns TRUE if the proxy system is enabled, FALSE otherwise.
virtual void  SetGlobalProxyEnable (BOOL enable)=0
  Enables or disables the proxy system.
virtual RenderMode  GetGlobalProxyRenderMode ()=0
virtual void  SetGlobalProxyRenderMode (RenderMode renderMode)=0
  Sets the proxy render mode to be used.
virtual int  GetGlobalProxySizeFactor ()=0
  Returns the default factor by which proxies are scaled in size (half, quarter, etc.)
virtual void  SetGlobalProxySizeFactor (int factor)=0
  Sets the default factor by which proxies are scaled in size (half, quarter, etc.)
virtual int  GetGlobalProxySizeMin ()=0
  Returns the default minimum size, below which bitmap are not proxied.
virtual void  SetGlobalProxySizeMin (int min)=0
  Sets the default minimum size, below which bitmap are not proxied.
virtual int  GetProxySizeFactor (const MCHAR *filename)=0
  Returns the proxy size factor for a specific bitmap.
virtual void  SetProxySizeFactor (const MCHAR *filename, int factor)=0
  Sets the proxy size factor for a specific bitmap.
virtual BOOL  GetProxyUseGlobal (const MCHAR *filename)=0
  Returns whether a specific bitmap uses global proxy settings instead of its own settings.
virtual void  SetProxyUseGlobal (const MCHAR *filename, BOOL global)=0
  Sets whether a specific bitmap uses global proxy settings instead of its own settings.
virtual BOOL  GetProxyReady (const MCHAR *filename)=0
  Returns whether the desired proxy is ready for use, or is stale (in memory or on disk).
virtual void  RefreshProxies (int requestRefresh)=0
  Reloads correct versions of proxies into memory, if proxy settings have changed.
virtual void  GenerateProxies (int requestRefresh)=0
  Generates proxy bitmaps needed by the scene and caches them to disk.
virtual void  ShowConfigDialog (Tab< MCHAR * > *bitmapFilenames)=0
  Displays the UI to configure proxy settings for the given bitmaps, or to configure the global settings if the input is NULL.
virtual void  ShowPrecacheDialog (Tab< MCHAR * > *bitmapFilenames)=0
  Displays the UI to update the proxy cache for the given bitmaps, or to update all out-of-date cache files if the input is NULL.
virtual BMMRES  LoadInto (BitmapInfo *requestInfo, Bitmap **pbitmap, int requestLoad, int requestFlags=0)=0
  Loads a proxy bitmap storage into the input bitmap, according to the input request info.

Member Function Documentation

virtual BOOL GetGlobalProxyEnable ( ) [pure virtual]

Returns TRUE if the proxy system is enabled, FALSE otherwise.

virtual void SetGlobalProxyEnable ( BOOL  enable ) [pure virtual]

Enables or disables the proxy system.

virtual RenderMode GetGlobalProxyRenderMode ( ) [pure virtual]
Returns:
The proxy render mode selected currently in use.
virtual void SetGlobalProxyRenderMode ( RenderMode  renderMode ) [pure virtual]

Sets the proxy render mode to be used.

Parameters:
[in] renderMode The render mode to be set.
virtual int GetGlobalProxySizeFactor ( ) [pure virtual]

Returns the default factor by which proxies are scaled in size (half, quarter, etc.)

virtual void SetGlobalProxySizeFactor ( int  factor ) [pure virtual]

Sets the default factor by which proxies are scaled in size (half, quarter, etc.)

virtual int GetGlobalProxySizeMin ( ) [pure virtual]

Returns the default minimum size, below which bitmap are not proxied.

virtual void SetGlobalProxySizeMin ( int  min ) [pure virtual]

Sets the default minimum size, below which bitmap are not proxied.

virtual int GetProxySizeFactor ( const MCHAR *  filename ) [pure virtual]

Returns the proxy size factor for a specific bitmap.

(proxySizeFactor_Half, proxySizeFactor_Quarter, etc.)

virtual void SetProxySizeFactor ( const MCHAR *  filename,
int  factor 
) [pure virtual]

Sets the proxy size factor for a specific bitmap.

(proxySizeFactor_Half, proxySizeFactor_Quarter, etc.)

virtual BOOL GetProxyUseGlobal ( const MCHAR *  filename ) [pure virtual]

Returns whether a specific bitmap uses global proxy settings instead of its own settings.

virtual void SetProxyUseGlobal ( const MCHAR *  filename,
BOOL  global 
) [pure virtual]

Sets whether a specific bitmap uses global proxy settings instead of its own settings.

virtual BOOL GetProxyReady ( const MCHAR *  filename ) [pure virtual]

Returns whether the desired proxy is ready for use, or is stale (in memory or on disk).

virtual void RefreshProxies ( int  requestRefresh ) [pure virtual]

Reloads correct versions of proxies into memory, if proxy settings have changed.

virtual void GenerateProxies ( int  requestRefresh ) [pure virtual]

Generates proxy bitmaps needed by the scene and caches them to disk.

virtual void ShowConfigDialog ( Tab< MCHAR * > *  bitmapFilenames ) [pure virtual]

Displays the UI to configure proxy settings for the given bitmaps, or to configure the global settings if the input is NULL.

virtual void ShowPrecacheDialog ( Tab< MCHAR * > *  bitmapFilenames ) [pure virtual]

Displays the UI to update the proxy cache for the given bitmaps, or to update all out-of-date cache files if the input is NULL.

virtual BMMRES LoadInto ( BitmapInfo requestInfo,
Bitmap **  pbitmap,
int  requestLoad,
int  requestFlags = 0 
) [pure virtual]

Loads a proxy bitmap storage into the input bitmap, according to the input request info.

See also:
MAP_PROXY

IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager
IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager IBitmapProxyManager