Bitmap Proxy Manager Function-Published Interface. More...

#include <bitmap.h>

Inheritance diagram for IBitmapProxyManager:

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 Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

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< const 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< const 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.

Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()

CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, ULONG flag,...)

CoreExport	~FPInterfaceDesc ()

virtual void	Init ()

LifetimeType	LifetimeControl ()

virtual BaseInterface *	GetInterface (Interface_ID id)

CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc pCD, ULONG flag,...)

CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor.

CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor.

CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor.

CoreExport void	SetClassDesc (ClassDesc *i_cd)

CoreExport va_list	check_fn (va_list ap, int id)

CoreExport va_list	scan_fn (va_list ap, int id, int index)

CoreExport va_list	check_prop (va_list ap, int id)

CoreExport va_list	scan_prop (va_list ap, int id, int index)

CoreExport va_list	check_enum (va_list ap, EnumID id)

CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)

FPInterfaceDesc *	GetDesc ()

Interface_ID	GetID ()

CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)

ActionTable *	GetActionTable ()

CoreExport void	EnableActions (BOOL onOff)

virtual CoreExport HINSTANCE	HInstance ()

virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)

Public Member Functions inherited from FPInterface
virtual BaseInterface *	GetInterface (Interface_ID id)

virtual FPInterfaceDesc *	GetDesc ()=0

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPParams *params)

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)

virtual CoreExport FunctionID	FindFn (const MCHAR *name)

virtual CoreExport BOOL	IsEnabled (FunctionID actionID)

virtual CoreExport BOOL	IsChecked (FunctionID actionID)

virtual CoreExport BOOL	IsVisible (FunctionID actionID)

virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)

virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)

virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)

virtual ActionTable *	GetActionTable ()

virtual void	EnableActions (BOOL onOff)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor.

UtilExport BaseInterface *	GetInterface (Interface_ID id) override

virtual UtilExport Interface_ID	GetID ()

virtual LifetimeType	LifetimeControl ()

virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.

virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
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.

Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID

MSTR	internal_name

StringResID	description

ClassDesc *	cd

USHORT	flags

Tab< FPFunctionDef * >	functions

Tab< FPPropDef * >	props

Tab< FPEnum * >	enumerations

MSPluginClass *	pc

Rollout *	rollout

ActionTable *	action_table

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, USHORT flag, va_list ap)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Detailed Description

Bitmap Proxy Manager Function-Published Interface.

Member Function Documentation

◆ GetGlobalProxyEnable()

virtual BOOL GetGlobalProxyEnable ( )

pure virtual

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

◆ SetGlobalProxyEnable()

virtual void SetGlobalProxyEnable ( BOOL enable )

pure virtual

Enables or disables the proxy system.

◆ GetGlobalProxyRenderMode()

virtual RenderMode GetGlobalProxyRenderMode ( )

pure virtual

Returns: The proxy render mode selected currently in use.

◆ SetGlobalProxyRenderMode()

virtual void SetGlobalProxyRenderMode ( RenderMode renderMode )

pure virtual

Sets the proxy render mode to be used.

Parameters

[in] renderMode The render mode to be set.

◆ GetGlobalProxySizeFactor()

virtual int GetGlobalProxySizeFactor ( )

pure virtual

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

◆ SetGlobalProxySizeFactor()

virtual void SetGlobalProxySizeFactor ( int factor )

pure virtual

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

◆ GetGlobalProxySizeMin()

virtual int GetGlobalProxySizeMin ( )

pure virtual

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

◆ SetGlobalProxySizeMin()

virtual void SetGlobalProxySizeMin ( int min )

pure virtual

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

◆ GetProxySizeFactor()

virtual int GetProxySizeFactor ( const MCHAR * filename )

pure virtual

Returns the proxy size factor for a specific bitmap.

(proxySizeFactor_Half, proxySizeFactor_Quarter, etc.)

◆ SetProxySizeFactor()

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

pure virtual

Sets the proxy size factor for a specific bitmap.

(proxySizeFactor_Half, proxySizeFactor_Quarter, etc.)

◆ GetProxyUseGlobal()

virtual BOOL GetProxyUseGlobal ( const MCHAR * filename )

pure virtual

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

◆ SetProxyUseGlobal()

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

pure virtual

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

◆ GetProxyReady()

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).

◆ RefreshProxies()

virtual void RefreshProxies ( int requestRefresh )

pure virtual

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

◆ GenerateProxies()

virtual void GenerateProxies ( int requestRefresh )

pure virtual

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

◆ ShowConfigDialog()

virtual void ShowConfigDialog ( Tab< const 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.

◆ ShowPrecacheDialog()

virtual void ShowPrecacheDialog ( Tab< const 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.

◆ LoadInto()

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetGlobalProxyEnable()

◆ SetGlobalProxyEnable()

◆ GetGlobalProxyRenderMode()

◆ SetGlobalProxyRenderMode()

◆ GetGlobalProxySizeFactor()

◆ SetGlobalProxySizeFactor()

◆ GetGlobalProxySizeMin()

◆ SetGlobalProxySizeMin()

◆ GetProxySizeFactor()

◆ SetProxySizeFactor()

◆ GetProxyUseGlobal()

◆ SetProxyUseGlobal()

◆ GetProxyReady()

◆ RefreshProxies()

◆ GenerateProxies()

◆ ShowConfigDialog()

◆ ShowPrecacheDialog()

◆ LoadInto()