VISU.ColoredPrs3dCache Interface Reference

ColoredPrs3dCache interface. This interface is responsible for memory management of 3d presentations. One cache corresponds to one study.

Inheritance diagram for VISU.ColoredPrs3dCache:

Public Types
enum	MemoryMode { MINIMAL, LIMITED }
enum	EnlargeType { NO_ENLARGE, ENLARGE, IMPOSSIBLE }
Public Member Functions
void	SetMemoryMode (in MemoryMode theMode)
MemoryMode	GetMemoryMode ()
void	SetLimitedMemory (in float theMemorySize)
float	GetLimitedMemory ()
float	GetMemorySize ()
ColoredPrs3dHolder	CreateHolder (in VISUType theType, in ColoredPrs3dHolder::BasicInput theInput)
EnlargeType	GetRequiredMemory (in VISUType theType, in ColoredPrs3dHolder::BasicInput theInput, out float theRequiredMemory)
void	RemoveFromStudy ()
IdType	GetID ()
VISUType	GetType ()

Member Enumeration Documentation

This enumeration contains the cache memory modes.

Enumerator:

MINIMAL	Minimal memory mode (default behaviour).
LIMITED	Limited memory mode (fixed memory size for presentations).

This enumeration defines how to enlarge the cache limited memory.

Enumerator:

NO_ENLARGE	No need to enlarge (default behaviour).
ENLARGE	Enlarge limited memory.
IMPOSSIBLE	Impossible to enlarge (not enough free memory).

void VISU.ColoredPrs3dCache.SetMemoryMode ( in MemoryMode theMode )

Sets a memory mode.

MemoryMode VISU.ColoredPrs3dCache.GetMemoryMode ( )

Gets a memory mode.

void VISU.ColoredPrs3dCache.SetLimitedMemory ( in float theMemorySize )

Sets a memory size for limited mode (Mb).

float VISU.ColoredPrs3dCache.GetLimitedMemory ( )

Gets a memory size for limited mode (Mb).

float VISU.ColoredPrs3dCache.GetMemorySize ( )

Gets memory size actually used by the cache system (Mb).

ColoredPrs3dHolder VISU.ColoredPrs3dCache.CreateHolder	(	in VISUType	theType,
		in ColoredPrs3dHolder::BasicInput	theInput
	)

Creates ColoredPrs3dHolder.

EnlargeType VISU.ColoredPrs3dCache.GetRequiredMemory	(	in VISUType	theType,
		in ColoredPrs3dHolder::BasicInput	theInput,
		out float	theRequiredMemory
	)

Gets a memory which is required to create a holder.

void VISU.RemovableObject.RemoveFromStudy ( ) [inherited]

Remove object from study.

IdType VISU.Base.GetID ( ) [inherited]

Returns ID of the object.

VISUType VISU.Base.GetType ( ) [inherited]

Returns the type of the presentable object