agi.foundation.terrain

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

Class TerrainRegion

java.lang.Object

agi.foundation.terrain.TerrainRegion

All Implemented Interfaces:

IEquatable<TerrainRegion>

public abstract class TerrainRegion
extends Object
implements IEquatable<TerrainRegion>

A region of terrain. Terrain regions are the unit of caching used by TerrainCache and TerrainCacheGroup.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TerrainRegion(TerrainCache cache) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
abstract boolean	equalsType(TerrainRegion other) Indicates whether another instance of this type is exactly equal to this instance.
TerrainCache	getCache() Gets the cache associated with this region.
boolean	getIsLockedInMemory() Gets a value indicating whether this region is locked in memory.
TerrainCacheTimeStamp	getLastAccess() Gets the time stamp of the last time this region was accessed.
abstract long	getSize() Gets the approximate size, in bytes, of this region.
TerrainRegionStatus	getStatus() Gets the current status of this region.
abstract int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
void	setIsLockedInMemory(boolean value) Sets a value indicating whether this region is locked in memory.
void	setStatus(TerrainRegionStatus value) Sets the current status of this region.
void	updateLastAccess() Updates the last access time of this terrain region with the current time stamp of the cache group associated with this region.

Methods inherited from class java.lang.Object

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

Constructor Detail

TerrainRegion

protected TerrainRegion(@Nonnull
                        TerrainCache cache)

Initializes a new instance.

Parameters:

cache - The cache that owns this region.

Throws:

ArgumentNullException - Thrown when cache is null.

Method Detail

getCache

@Nonnull
public final TerrainCache getCache()

Gets the cache associated with this region.

getLastAccess

@Nonnull
public final TerrainCacheTimeStamp getLastAccess()

Gets the time stamp of the last time this region was accessed.

updateLastAccess

public final void updateLastAccess()

Updates the last access time of this terrain region with the current time stamp of the cache group associated with this region.

getStatus

@Nonnull
public final TerrainRegionStatus getStatus()

Gets the current status of this region. Only the cache associated with this region should set the value of this property.

setStatus

public final void setStatus(@Nonnull
                            TerrainRegionStatus value)

Sets the current status of this region. Only the cache associated with this region should set the value of this property.

getIsLockedInMemory

public final boolean getIsLockedInMemory()

Gets a value indicating whether this region is locked in memory. A locked region will not be unloaded, even if the cache is full and this is the least recently used region.

setIsLockedInMemory

public final void setIsLockedInMemory(boolean value)

Sets a value indicating whether this region is locked in memory. A locked region will not be unloaded, even if the cache is full and this is the least recently used region.

getSize

public abstract long getSize()

Gets the approximate size, in bytes, of this region. This size is generally only useful for comparing the size of regions.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

hashCode

public abstract int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equalsType

public abstract boolean equalsType(TerrainRegion other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<TerrainRegion>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.