TerrainRegion Class

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

Inheritance Hierarchy

SystemObject
AGI.Foundation.TerrainTerrainRegion

Namespace: AGI.Foundation.Terrain
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

public abstract class TerrainRegion : IEquatable<TerrainRegion>

Public MustInherit Class TerrainRegion
	Implements IEquatable(Of TerrainRegion)

public ref class TerrainRegion abstract : IEquatable<TerrainRegion^>

[<AbstractClassAttribute>]
type TerrainRegion =  
    class
        interface IEquatable<TerrainRegion>
    end

The TerrainRegion type exposes the following members.

Constructors

	Name	Description
	TerrainRegion	Initializes a new instance.

Properties

	Name	Description
	Cache	Gets the cache associated with this region.
	IsLockedInMemory	Gets or 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.
	LastAccess	Gets the time stamp of the last time this region was accessed.
	Size	Gets the approximate size, in bytes, of this region. This size is generally only useful for comparing the size of regions.
	Status	Gets or sets the current status of this region. Only the cache associated with this region should set the value of this property.

Methods

	Name	Description
	Equals(Object)	Indicates whether another object is exactly equal to this instance. (Overrides ObjectEquals(Object).)
	Equals(TerrainRegion)	Indicates whether another instance of this type is exactly equal to this instance.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateLastAccess	Updates the last access time of this terrain region with the current time stamp of the cache group associated with this region.