agi.foundation.terrain

(agi.foundation.models-2024r1.jar)

Class TerrainCacheGroup

java.lang.Object

agi.foundation.terrain.TerrainCacheGroup

public class TerrainCacheGroup
extends Object

A group of terrain caches. Each group has its own thread for loading terrain regions. A group can also limit the total memory used by all caches in the group.

Constructor Summary

Constructors

Constructor and Description
TerrainCacheGroup() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
void	addCache(TerrainCache cache) Adds a cache to the group.
TerrainCacheTimeStamp	getCurrentTimeStamp() Gets a time stamp that can be used for relative ordering of accesses to caches and regions within this cache group.
static TerrainCacheGroup	getDefault() Gets the default group.
long	getMaximumSize() Gets the maximum size, in bytes, of this cache group.
void	requestRegionLoad(TerrainRegion region) Requests that a region be loaded into cache.
void	setMaximumSize(long value) Sets the maximum size, in bytes, of this cache group.
void	startCacheThread() Starts the thread associate with this cache group.
void	stopCacheThread() Stops the thread associated with this cache group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TerrainCacheGroup

public TerrainCacheGroup()

Initializes a new instance.

Method Detail

getDefault

@Nonnull
public static TerrainCacheGroup getDefault()

Gets the default group. Additional groups can be created to isolate groups of terrain.

startCacheThread

public final void startCacheThread()

Starts the thread associate with this cache group. It is not normally necessary to call this method because constructing an instance of TerrainCacheGroup will start the thread automatically.

stopCacheThread

public final void stopCacheThread()

Stops the thread associated with this cache group. This method does not return until the thread has stopped.

Throws:

IllegalStateException - Thrown if attempting to stop a thread that is already stopping or stopped.

getMaximumSize

public final long getMaximumSize()

Gets the maximum size, in bytes, of this cache group.

The size of the TerrainCacheGroup will not always be less than the MaximumSize (get / set). Rather, when loading a new region, if the size is above maximum size, old regions will be unloaded until the size is below the maximum (or all regions are unloaded). When the new region is then loaded, the size might go back up above the maximum.

Throws:

ArgumentOutOfRangeException - Thrown when the provided maximum size is less than zero.

setMaximumSize

public final void setMaximumSize(long value)

Sets the maximum size, in bytes, of this cache group.

The size of the TerrainCacheGroup will not always be less than the MaximumSize (get / set). Rather, when loading a new region, if the size is above maximum size, old regions will be unloaded until the size is below the maximum (or all regions are unloaded). When the new region is then loaded, the size might go back up above the maximum.

Throws:

ArgumentOutOfRangeException - Thrown when the provided maximum size is less than zero.

addCache

public final void addCache(@Nonnull
                           TerrainCache cache)

Adds a cache to the group.

Parameters:

cache - The cache to add.

Throws:

ArgumentNullException - Thrown when cache is null.

getCurrentTimeStamp

@Nonnull
public final TerrainCacheTimeStamp getCurrentTimeStamp()

Gets a time stamp that can be used for relative ordering of accesses to caches and regions within this cache group.

requestRegionLoad

public final void requestRegionLoad(TerrainRegion region)

Requests that a region be loaded into cache. This method returns immediately without loading the region and the region is later loaded in the cache group's thread.

Parameters:

region - The region to load.

Throws:

IllegalStateException - Thrown when this cache group is asked to load a region belonging to a different cache group.