Terrain Object

The Terrain object is used to model terrain features in FreeFlyer. Terrain can be considered when computing the height of a location on the Earth and when computing line-of-sight visibility between two objects, whether they are orbiting in space, or stationary or moving objects on the ground. See the Terrain Modeling Guide for more information.

Available In Editions:

Timing Precision Mode

Name	Description	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Filenames	The filenames for each of the terrain data files that have been added to this object. Files can be added using the Terrain.AddFiles() or Terrain.AddFilesInDirectory() methods. FreeFlyer will search for the required matching FreeFlyer Terrain Index File in the same directory as the raw terrain data file, but with the FreeFlyer Terrain Index File extension (.ffidx). Note: If any of the indices for the Terrain Filenames cannot be found, FreeFlyer will report an error saying that the Terrain object configuration is invalid because one or more index files couldn't be found.	Type: StringArray Access: Read-Only
HeightQueryCacheSize	Maximum number of records that will be saved in a cache for terrain height queries. The size of a record is a function of the loaded terrain file sizes. For a typical terrain file containing 3601x3601 pixels, a record contains a 16x16 region of pixels. Attempting to change this value after the cache is already in use will result in an error.	Type: Variable Access: Read/Write
MeshCacheSize	Maximum number of records that will be saved in a cache for evaluating line of sight visibility with occulting terrain. The size of a record is a function of the resolution of the FreeFlyer Terrain Index File. For example, when using an index resolution of 8, a record contains a 256x256 region of pixels. Attempting to change this value after the cache is already in use will result in an error.	Type: Variable Access: Read/Write
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only

Name	Description
AddFiles	Add terrain files to the Terrainobject. Terrain raster files need to be pre-processed with the FreeFlyer Terrain Index Generator before they can be used in FreeFlyer.
AddFilesInDirectory	Add all the files with the specified file extension in the specified directory to the Terrain object. Terrain raster files need to be pre-processed with the FreeFlyer Terrain Index Generator before they can be used in FreeFlyer.
ClearSavedStates	Clears previous saved states for this object.
ContainsLocation	Returns true if the provided latitude and longitude are contained in any of the terrain data files with this dataset.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
GetHeight	Returns the terrain height with respect to the Earth ellipsoid at the specified latitude and longitude. The Earth uses the WGS84 ellipsoid by default. This method will raise an error if the provided latitude and longitude are outside the bounds of any available terrain data. The Terrain.ContainsLocation() method can be used to check whether a location is within the bounds of any of the available terrain data.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
RemoveAllFiles	Remove all terrain data files from the Terrain object.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.

Terrain Object

Description

Available In Editions:

Timing Precision Mode