Package com.seibel.distanthorizons.api.objects.data

Interface IDhApiFullDataSource

public interface IDhApiFullDataSource

Represents a single full LOD backed by Distant Horizons' ID system.

Since:

API 4.0.0

See Also:

• IDhApiWorldGenerator

Method Summary

Modifier and Type	Method	Description
List<DhApiTerrainDataPoint>	getApiDataPointColumn(int relX, int relZ)
int	getWidthInDataColumns()
List<DhApiTerrainDataPoint>	setApiDataPointColumn(int relX, int relZ, List<DhApiTerrainDataPoint> columnDataPoints)	Sets the data column at the relative X and Z position to the list given.

Method Details

getWidthInDataColumns

int getWidthInDataColumns()

Returns:

how many data columns wide this data source is

setApiDataPointColumn

List<DhApiTerrainDataPoint> setApiDataPointColumn(int relX,
 int relZ,
 List<DhApiTerrainDataPoint> columnDataPoints)
                                           throws IndexOutOfBoundsException,
IllegalArgumentException

Sets the data column at the relative X and Z position to the list given. The given list may be resorted based on the internal format DH requires.

Parameters:

relX - can be in the range 0 to getWidthInDataColumns()-1 (both inclusive)

relZ - can be in the range 0 to getWidthInDataColumns()-1 (both inclusive)

Returns:

the same columnDataPoints list after it has been imported into the data source. The returned list and contained objects can then be re-used.

Throws:

IndexOutOfBoundsException - if the relative positions are negative or outside the bounds of this data source.

IllegalArgumentException

getApiDataPointColumn

List<DhApiTerrainDataPoint> getApiDataPointColumn(int relX,
 int relZ)
                                           throws IndexOutOfBoundsException

Parameters:

relX - can be in the range 0 to getWidthInDataColumns()-1 (both inclusive)

relZ - can be in the range 0 to getWidthInDataColumns()-1 (both inclusive)

Returns:

a List of DhApiTerrainDataPoint representing the data for the given relative position.

Throws:

IndexOutOfBoundsException - if the relative positions are negative or outside the bounds of this data source.