Package gaiasky.data

Class OctreeLoader

java.lang.Object

gaiasky.data.AbstractSceneLoader

gaiasky.data.OctreeLoader

All Implemented Interfaces:

IOctantLoader, ISceneLoader, IObserver

public class OctreeLoader
extends AbstractSceneLoader
implements IObserver, IOctantLoader

Loads Gaia Sky LOD datasets backed by an octree.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	OctreeLoader.OctreeLoaderThread	The daemon loader thread.

Field Summary

Fields

Modifier and Type	Field	Description
protected OctreeLoader.OctreeLoaderThread	daemon	Daemon thread that gets the data loading requests and serves them.
protected String	description
protected int	idxLoadedIds
static OctreeLoader	instance
protected long	lastQueueClearMs	Last time of a queue clear event went through.
protected static final int	LOAD_QUEUE_MAX_SIZE	Maximum load queue size.
protected long[]	loadedIds	Loaded octant ids, for logging.
protected int	loadedObjects
protected boolean	loadingPaused	Whether loading is paused or not.
protected static final int	MAX_LOAD_CHUNK	Maximum number of pages to send to load every batch.
protected int	maxLoadedIds
protected final long	maxLoadedStars	Max number of stars loaded at once.
protected String	metadata
protected static final long	MIN_QUEUE_CLEAR_MS	Minimum time to pass to be able to clear the queue again.
protected String	name
protected int	nLoadedStars	Current number of stars that are loaded.
protected Map<String,Object>	params
protected String	particles
protected static final int	PRELOAD_DEPTH	Data will be preloaded at startup down to this octree depth.
protected Queue<OctreeNode>	toLoadQueue	The octant loading queue.
protected Queue<OctreeNode>	toUnloadQueue	This queue is sorted ascending by access date, so that we know which element to release if needed (oldest).

Fields inherited from class gaiasky.data.AbstractSceneLoader

datasetDirectory, dataSource, filePaths, index, loggedArchetypes, parentName, scene

Constructor Summary

Constructors

Constructor	Description
OctreeLoader()

Method Summary

Modifier and Type	Method	Description
void	abortCurrentLoading()	Tells the daemon to immediately stop the loading of octants and wait for new data
protected void	addLoadedInfo(long id, int nobjects)
void	addToQueue(OctreeNode octant)
void	clearQueue()	Clears the current load queue.
void	emptyLoadQueue()	Removes all octants from the current load queue.
protected void	flushLoadedIds()
void	flushLoadQueue()	Tells the loader to start loading the octants in the queue.
int	getLoadQueueSize()
int	getNLoadedStars()
void	initialize(String[] files, Scene scene)
void	initialize(String[] files, String dsLocation, Scene scene)
com.badlogic.gdx.utils.Array<com.badlogic.ashley.core.Entity>	loadData()	Performs the loading and returns an array with the entities loaded.
void	loadLod(Integer lod, com.badlogic.ashley.core.Entity octreeWrapper)	Loads all the levels of detail until the given one.
boolean	loadOctant(OctreeNode octant, com.badlogic.ashley.core.Entity octreeWrapper, boolean fullInit)	Loads the data of the given octant.
void	loadOctant(OctreeNode octant, com.badlogic.ashley.core.Entity octreeWrapper, Integer level)	Loads the data of the given octant and its children down to the given level.
void	loadOctants(com.badlogic.gdx.utils.Array<OctreeNode> octants, com.badlogic.ashley.core.Entity octreeWrapper, AtomicBoolean abort)	Loads the objects of the given octants.
protected com.badlogic.ashley.core.Entity	loadOctreeData()	Loads the nodes and the octree.
void	notify(Event event, Object source, Object... data)	Event notification call.
void	queue(OctreeNode octant)	Adds the octant to the load queue.
void	setDescription(String description)
void	setEpoch(Double epoch)
void	setEpoch(Long epoch)
void	setName(String name)
void	setParams(Map<String,Object> params)
void	touch(OctreeNode octant)	Moves the octant to the end of the unload queue.
void	touchOctant(OctreeNode octant)	Puts it at the end of the toUnloadQueue.
void	unloadOctant(OctreeNode octant, com.badlogic.ashley.core.Entity octreeWrapper)	Unloads the given octant.

Methods inherited from class gaiasky.data.AbstractSceneLoader

initialize, setIndex, setParentName

Methods inherited from class java.lang.Object

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

Field Details

PRELOAD_DEPTH

protected static final int PRELOAD_DEPTH

Data will be preloaded at startup down to this octree depth.

See Also:

• Constant Field Values

LOAD_QUEUE_MAX_SIZE

protected static final int LOAD_QUEUE_MAX_SIZE

Maximum load queue size.

See Also:

• Constant Field Values

MIN_QUEUE_CLEAR_MS

protected static final long MIN_QUEUE_CLEAR_MS

Minimum time to pass to be able to clear the queue again.

See Also:

• Constant Field Values

MAX_LOAD_CHUNK

protected static final int MAX_LOAD_CHUNK

Maximum number of pages to send to load every batch.

See Also:

• Constant Field Values

instance

public static OctreeLoader instance

maxLoadedStars

protected final long maxLoadedStars

Max number of stars loaded at once.

nLoadedStars

protected int nLoadedStars

Current number of stars that are loaded.

toLoadQueue

protected Queue<OctreeNode> toLoadQueue

The octant loading queue.

loadingPaused

protected boolean loadingPaused

Whether loading is paused or not.

lastQueueClearMs

protected long lastQueueClearMs

Last time of a queue clear event went through.

name

protected String name

description

protected String description

params

protected Map<String,Object> params

toUnloadQueue

protected Queue<OctreeNode> toUnloadQueue

This queue is sorted ascending by access date, so that we know which element to release if needed (oldest).

loadedIds

protected long[] loadedIds

Loaded octant ids, for logging.

loadedObjects

protected int loadedObjects

maxLoadedIds

protected int maxLoadedIds

idxLoadedIds

protected int idxLoadedIds

metadata

protected String metadata

particles

protected String particles

daemon

protected OctreeLoader.OctreeLoaderThread daemon

Daemon thread that gets the data loading requests and serves them.

Constructor Details

OctreeLoader

public OctreeLoader()

Method Details

initialize

public void initialize(String[] files,
 String dsLocation,
 Scene scene)
                throws RuntimeException

Specified by:

initialize in interface ISceneLoader

Overrides:

initialize in class AbstractSceneLoader

Throws:

RuntimeException

initialize

public void initialize(String[] files,
 Scene scene)
                throws RuntimeException

Specified by:

initialize in interface ISceneLoader

Overrides:

initialize in class AbstractSceneLoader

Throws:

RuntimeException

loadOctreeData

protected com.badlogic.ashley.core.Entity loadOctreeData()

Loads the nodes and the octree.

setEpoch

public void setEpoch(Double epoch)

setEpoch

public void setEpoch(Long epoch)

loadData

public com.badlogic.gdx.utils.Array<com.badlogic.ashley.core.Entity> loadData()

Description copied from interface: ISceneLoader

Performs the loading and returns an array with the entities loaded.

Specified by:

loadData in interface ISceneLoader

Returns:

The loaded entities.

addLoadedInfo

protected void addLoadedInfo(long id,
 int nobjects)

flushLoadedIds

protected void flushLoadedIds()

queue

public void queue(OctreeNode octant)

Adds the octant to the load queue.

Specified by:

queue in interface IOctantLoader

clearQueue

public void clearQueue()

Clears the current load queue.

Specified by:

clearQueue in interface IOctantLoader

getLoadQueueSize

public int getLoadQueueSize()

Specified by:

getLoadQueueSize in interface IOctantLoader

getNLoadedStars

public int getNLoadedStars()

Specified by:

getNLoadedStars in interface IOctantLoader

touch

public void touch(OctreeNode octant)

Moves the octant to the end of the unload queue.

Specified by:

touch in interface IOctantLoader

emptyLoadQueue

public void emptyLoadQueue()

Removes all octants from the current load queue. This happens when the camera viewport changes radically (velocity is high, direction changes a lot, etc.) so that the old octants are dropped and newly observed octants are loaded right away.

addToQueue

public void addToQueue(OctreeNode octant)

touchOctant

public void touchOctant(OctreeNode octant)

Puts it at the end of the toUnloadQueue.

flushLoadQueue

public void flushLoadQueue()

Tells the loader to start loading the octants in the queue.

abortCurrentLoading

public void abortCurrentLoading()

Tells the daemon to immediately stop the loading of octants and wait for new data

loadLod

public void loadLod(Integer lod,
 com.badlogic.ashley.core.Entity octreeWrapper)
             throws IOException

Loads all the levels of detail until the given one.

Parameters:

lod - The level of detail to load.

octreeWrapper - The octree wrapper entity.

Throws:

IOException - When any of the level's files fails to load.

loadOctant

public void loadOctant(OctreeNode octant,
 com.badlogic.ashley.core.Entity octreeWrapper,
 Integer level)

Loads the data of the given octant and its children down to the given level.

Parameters:

octant - The octant to load.

octreeWrapper - The octree wrapper.

level - The depth to load.

loadOctants

public void loadOctants(com.badlogic.gdx.utils.Array<OctreeNode> octants,
 com.badlogic.ashley.core.Entity octreeWrapper,
 AtomicBoolean abort)

Loads the objects of the given octants.

Parameters:

octants - The list holding the octants to load.

octreeWrapper - The octree wrapper.

abort - State variable that will be set to true if an abort is called.

loadOctant

public boolean loadOctant(OctreeNode octant,
 com.badlogic.ashley.core.Entity octreeWrapper,
 boolean fullInit)

Loads the data of the given octant.

Parameters:

octant - The octant to load.

octreeWrapper - The octree wrapper entity.

fullInit - Whether to fully initialise the objects (on-demand load) or not (startup)

Returns:

True if the octant was loaded, false otherwise

unloadOctant

public void unloadOctant(OctreeNode octant,
 com.badlogic.ashley.core.Entity octreeWrapper)

Unloads the given octant.

notify

public void notify(Event event,
 Object source,
 Object... data)

Description copied from interface: IObserver

Event notification call.

Specified by:

notify in interface IObserver

Parameters:

event - The event type.

source - The source object, if any.

data - The data associated with this event.

setName

public void setName(String name)

Specified by:

setName in interface ISceneLoader

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface ISceneLoader

setParams

public void setParams(Map<String,Object> params)

Specified by:

setParams in interface ISceneLoader