Package gaiasky.script

Class EventScriptingInterface

java.lang.Object

gaiasky.script.EventScriptingInterface

All Implemented Interfaces:

IObserver, IScriptingInterface

public class EventScriptingInterface
extends Object
implements IScriptingInterface, IObserver

Constructor Summary

Constructors

Constructor	Description
EventScriptingInterface(com.badlogic.gdx.assets.AssetManager manager, CatalogManager catalogManager)

Method Summary

Modifier and Type	Method	Description
void	activateRealTimeFrame()	Sets the current time frame to real time.
void	activateSimulationTimeFrame()	Sets the current time frame to simulation time.
com.badlogic.ashley.core.Entity	addLineObject(String name, double[] points, double[] color, double lineWidth, int primitive, boolean arrowCaps, double trailMap, String archetypeName)
com.badlogic.ashley.core.Entity	addLineObject(String name, List<?> points, List<?> color, double lineWidth, int primitive, boolean arrowCaps, double trailMap, String archetypeName)
void	addPolyline(String name, double[] points, double[] color)	Adds a new polyline with the given name, points and color.
void	addPolyline(String name, double[] points, double[] color, double lineWidth)	Adds a new polyline with the given name, points, color and line width.
void	addPolyline(String name, double[] points, double[] color, double lineWidth, boolean arrowCaps)	Adds a new polyline with the given name, points, color and line width.
void	addPolyline(String name, double[] points, double[] color, double lineWidth, int primitive)	Adds a new polyline with the given name, points, color, line width and primitive.
void	addPolyline(String name, double[] points, double[] color, double lineWidth, int primitive, boolean arrowCaps)	Adds a new polyline with the given name, points, color, line width, primitive and arrow caps.
void	addPolyline(String name, double[] points, double[] color, int lineWidth)
void	addPolyline(String name, double[] points, double[] color, int lineWidth, int primitive)
void	addPolyline(String name, List<?> points, List<?> color)
void	addPolyline(String name, List<?> points, List<?> color, float lineWidth)
void	addPolyline(String name, List<?> points, List<?> color, float lineWidth, boolean arrowCaps)
void	addPolyline(String name, List<?> points, List<?> color, float lineWidth, int primitive)
void	addPolyline(String name, List<?> points, List<?> color, float lineWidth, int primitive, boolean arrowCaps)
void	addPolyline(String name, List<?> points, List<?> color, int lineWidth)
void	addPolyline(String name, List<?> points, List<?> color, int lineWidth, boolean arrowCaps)
void	addPolyline(String name, List<?> points, List<?> color, int lineWidth, int primitive)
void	addPolyline(String name, List<?> points, List<?> color, int lineWidth, int primitive, boolean arrowCaps)
void	addShapeAroundObject(String shapeName, String shapeType, String primitive, double size, String objectName, float r, float g, float b, float a, boolean showLabel, boolean trackObject)	Creates a shape object of the given type with the given size around the object with the given name.
void	addTrajectoryLine(String name, double[] points, double[] color)	Adds a new trajectory object with the given name, points and color.
void	addTrajectoryLine(String name, double[] points, double[] color, double trailMap)	Adds a new trajectory object with the given name, points and color.
void	addTrajectoryLine(String name, List<?> points, List<?> color)
void	addTrajectoryLine(String name, List<?> points, List<?> color, double trailMap)
void	cameraCenter()	Centers the camera to the focus, removing any deviation of the line of sight.
void	cameraForward(double cameraForward)	Adds a forward movement to the camera with the given value.
void	cameraForward(long value)
void	cameraPitch(double amount)	Adds a pitch to the camera.
void	cameraPitch(long amount)
void	cameraRoll(double roll)	Adds a roll force to the camera.
void	cameraRoll(long roll)
void	cameraRotate(double deltaX, double deltaY)	Adds a rotation movement to the camera around the current focus, or a pitch/yaw if in free mode.
void	cameraRotate(double deltaX, long deltaY)
void	cameraRotate(long deltaX, double deltaY)
void	cameraStop()	Stops all camera motion.
void	cameraTransition(double[] camPos, double[] camDir, double[] camUp, double seconds)	Creates a smooth transition from the current camera state to the given camera state {camPos, camDir, camUp} in the given number of seconds.
void	cameraTransition(double[] camPos, double[] camDir, double[] camUp, double seconds, boolean sync)	Creates a smooth transition from the current camera state to the given camera state {camPos, camDir, camUp} in the given number of seconds.
void	cameraTransition(double[] camPos, double[] camDir, double[] camUp, long seconds)
void	cameraTransition(double[] camPos, String units, double[] camDir, double[] camUp, double seconds)	Creates a smooth transition from the current camera state to the given camera state {camPos, camDir, camUp} in the given number of seconds.
void	cameraTransition(double[] camPos, String units, double[] camDir, double[] camUp, double seconds, boolean sync)	Creates a smooth transition from the current camera state to the given camera state {camPos, camDir, camUp} in the given number of seconds.
void	cameraTransition(double[] camPos, String units, double[] camDir, double[] camUp, long seconds)
void	cameraTransition(List<?> camPos, String units, List<?> camDir, List<?> camUp, double seconds)
void	cameraTransition(List<?> camPos, String units, List<?> camDir, List<?> camUp, double seconds, boolean sync)
void	cameraTransition(List<?> camPos, String units, List<?> camDir, List<?> camUp, long seconds)
void	cameraTransition(List<?> camPos, String units, List<?> camDir, List<?> camUp, long seconds, boolean sync)
void	cameraTransition(List<?> camPos, List<?> camDir, List<?> camUp, double seconds)
void	cameraTransition(List<?> camPos, List<?> camDir, List<?> camUp, double seconds, boolean sync)
void	cameraTransition(List<?> camPos, List<?> camDir, List<?> camUp, long seconds)
void	cameraTransition(List<?> camPos, List<?> camDir, List<?> camUp, long seconds, boolean sync)
void	cameraTransitionKm(double[] camPos, double[] camDir, double[] camUp, double seconds)	Same as IScriptingInterface.cameraTransition(double[], double[], double[], double) but the camera position is given in Km.
void	cameraTransitionKm(List<?> camPos, List<?> camDir, List<?> camUp, double seconds)
void	cameraTransitionKm(List<?> camPos, List<?> camDir, List<?> camUp, long seconds)
void	cameraTurn(double deltaX, double deltaY)	Adds a turn force to the camera (yaw and/or pitch).
void	cameraTurn(double deltaX, long deltaY)
void	cameraTurn(long deltaX, double deltaY)
void	cameraTurn(long deltaX, long deltaY)
void	cameraYaw(double amount)	Adds a yaw to the camera.
void	cameraYaw(long amount)
void	clearAllMessages()	Clears both the subhead and the headline messages.
void	clearHeadlineMessage()	Clears the headline messge.
void	clearSubheadMessage()	Clears the subhead message.
void	collapseGuiComponent(String name)	Collapses the component with the given name.
void	configureFrameOutput(int width, int height, double fps, String directory, String namePrefix)	Configures the frame output system, setting the resolution of the images, the target frames per second, the output directory and the image name prefix.
void	configureFrameOutput(int width, int height, int fps, String directory, String namePrefix)	Configures the frame output system, setting the resolution of the images, the target frames per second, the output directory and the image name prefix.
void	configureRenderOutput(int width, int height, int fps, String directory, String namePrefix)	Configures the frame output system, setting the resolution of the images, the target frames per second, the output directory and the image name prefix.
void	configureScreenshots(int width, int height, String directory, String namePrefix)	Configures the screenshot system, setting the resolution of the images, the output directory and the image name prefix.
double[]	cross3(double[] vec1, double[] vec2)	Computes the cross product between the two 3D vectors.
double[]	cross3(List<?> vec1, List<?> vec2)
void	disableGui()	Disables the GUI rendering.
void	disableInput()	Disables all input events from mouse, keyboard, touchscreen, etc.
void	displayImageObject(int id, String path, double x, double y, double[] color)	Same as IScriptingInterface.displayImageObject(int, String, float, float, float, float, float, float) but using a double array for the color instead of each component separately.
void	displayImageObject(int id, String path, double x, double y, List<?> color)
void	displayImageObject(int id, String path, float x, float y)	Adds a new image object at the given coordinates.
void	displayImageObject(int id, String path, float x, float y, float r, float g, float b, float a)	Adds a new image object at the given coordinates.
void	displayMessageObject(int id, String message, double x, double y, double[] color, double fontSize)	Same as IScriptingInterface.displayImageObject(int, String, float, float, float, float, float, float) but using an array for the color instead of giving each component separately.
void	displayMessageObject(int id, String message, double x, double y, List<?> color, double fontSize)
void	displayMessageObject(int id, String message, float x, float y, float r, float g, float b, float a, float fontSize)	Adds a new one-line message in the screen with the given id and the given coordinates.
void	displayMessageObject(int id, String message, float x, float y, float r, float g, float b, float a, int fontSize)
void	displayPopupNotification(String message)	Displays a popup notification on the screen for the default duration.
void	displayPopupNotification(String message, float duration)	Displays a popup notification on the screen for the given duration.
void	displayPopupNotification(String message, Double duration)
void	displayTextObject(int id, String text, float x, float y, float maxWidth, float maxHeight, float r, float g, float b, float a, float fontSize)	Adds a new multi-line text in the screen with the given id, coordinates and size.
void	displayTextObject(int id, String text, float x, float y, float maxWidth, float maxHeight, float r, float g, float b, float a, int fontSize)
double	dot3(double[] vec1, double[] vec2)	Computes the dot product between the two 3D vectors.
double	dot3(List<?> vec1, List<?> vec2)
double[]	eclipticToEquatorial(double[] ecl)	Converts ecliptic cartesian coordinates (in the internal reference system) to equatorial cartesian coordinates.
double[]	eclipticToEquatorial(List<?> ecl)
double[]	eclipticToInternalCartesian(double l, double b, double r)	Converts ecliptic coordinates to the internal cartesian coordinate system.
double[]	eclipticToInternalCartesian(int l, int b, int r)
void	enableGui()	Enables the GUI rendering.
void	enableInput()	Enables all input events.
double[]	equatorialCartesianToInternalCartesian(double[] eq, double kmFactor)	Converts regular cartesian coordinates, where XY is the equatorial plane, with X pointing to the vernal equinox (ra=0) and Y points to ra=90, and Z pointing to the celestial north pole (dec=90) to internal cartesian coordinates with internal units.
double[]	equatorialCartesianToInternalCartesian(List<?> eq, double kmFactor)
double[]	equatorialToEcliptic(double[] eq)	Converts equatorial cartesian coordinates (in the internal reference system) to ecliptic cartesian coordinates.
double[]	equatorialToEcliptic(List<?> eq)
double[]	equatorialToGalactic(double[] eq)	Converts equatorial cartesian coordinates (in the internal reference system) to galactic cartesian coordinates.
double[]	equatorialToGalactic(List<?> eq)
double[]	equatorialToInternalCartesian(double ra, double dec, double r)	Converts equatorial coordinates to the internal cartesian coordinate system.
double[]	equatorialToInternalCartesian(int ra, int dec, int r)
void	error(String message)	Log an error using the internal logging system.
void	expandGuiComponent(String name)	Expands the component with the given name.
void	forceUpdateScene()	Forcefully triggers an update of the scene and the positions of all the objects.
double[]	galacticToEquatorial(double[] gal)	Converts galactic cartesian coordinates (in the internal reference system) to equatorial cartesian coordinates.
double[]	galacticToEquatorial(List<?> gal)
double[]	galacticToInternalCartesian(double l, double b, double r)	Converts galactic coordinates to the internal cartesian coordinate system.
double[]	galacticToInternalCartesian(int l, int b, int r)
String	getAssetsLocation()	Gets the location of the assets folder.
double[]	getCameraDirection()	Gets the current camera direction vector.
double[]	getCameraPosition()	Gets the current camera position, in km.
double[]	getCameraPosition(String units)	Gets the current camera position, in the requested units.
double	getCameraSpeed()	Gets the current physical speed of the camera in km/h.
double[]	getCameraUp()	Gets the current camera up vector.
IFocus	getClosestObjectToCamera()	Returns the closest object to the camera in this instant as a IFocus.
boolean	getComponentTypeVisibility(String key)	Gets the visibility of the component type described by the key.
String	getConfigDir()	Gets the absolute path to the location of the configuration directory
long	getCurrentFrameNumber()	Gets the current frame number.
String	getDataDir()	Gets the absolute path of the local data directory, configured in your config.yaml file.
String	getDefaultCameraDir()	Gets the absolute path of the default directory where the camera files are saved.
String	getDefaultFramesDir()	Gets the absolute path of the default directory where the still frames are saved.
String	getDefaultMappingsDir()	Gets the absolute path to the location of the inputListener mappings.
String	getDefaultMusicDir()	Gets the absolute path to the location of the music files
String	getDefaultScreenshotsDir()	Gets the absolute path of the default directory where the screenshots are saved.
double	getDistanceTo(String name)	Returns the distance to the surface of the object identified with the given name.
com.badlogic.ashley.core.Entity	getEntity(String name)
com.badlogic.ashley.core.Entity	getEntity(String name, double timeOutSeconds)
boolean	getForceDisplayLabel(String name)	Gets the value of the force display label flag for the object identified with the given name.
long	getFrameNumber()	Gets the current frame number.
double	getFrameOutputFps()	Gets the current FPS setting in the frame output system.
float	getGuiScaleFactor()	Gets the current scale factor applied to the UI.
double	getInternalUnitToMeterConversion()	Returns the internal unit to meter conversion factor.
VertsView	getLineObject(String name)	Gets a Verts object from the scene by name.
VertsView	getLineObject(String name, double timeOutSeconds)	Gets a Verts object from the scene by name.
String	getLocalDataDir()	Returns the default data directory.
double	getMeterToInternalUnitConversion()	Returns the meter to internal unit conversion factor.
float	getMinStarOpacity()
FocusView	getObject(String name)	Gets an object from the scene graph by name or id (HIP, TYC, Gaia SourceId).
FocusView	getObject(String name, double timeOutSeconds)	Gets an object by name or id (HIP, TYC, Gaia SourceID), optionally waiting until the object is available, with a timeout.
double[]	getObjectPosition(String name)	Gets the current position of the object identified by name in the internal coordinate system and internal units.
double[]	getObjectPosition(String name, String units)	Gets the current position of the object identified by name in the internal coordinate system and the requested distance units.
double[]	getObjectPredictedPosition(String name)	Gets the predicted position of the object identified by name in the internal coordinate system and internal units.
double[]	getObjectPredictedPosition(String name, String units)	Gets the predicted position of the object identified by name in the internal coordinate system and the requested distance units.
double	getObjectRadius(String name)	Gets the size of the object identified by name, in Km, by name or id (HIP, TYC, sourceId).
boolean	getObjectVisibility(String name)	Gets the visibility of a particular object.
float[]	getPositionAndSizeGui(String name)	Returns the size and position of the GUI element that goes by the given name or null if such element does not exist.
long	getProperMotionsMaxNumber()	Returns the current maximum number of velocity vectors per star group.
double	getRenderOutputFps()	Gets the current FPS setting in the frame output system.
int	getScreenHeight()	Returns the screen height in pixels.
int	getScreenWidth()	Returns the screen width in pixels.
long	getSimulationTime()	Returns the current simulation time as the number of milliseconds since 1970-01-01T00:00:00Z (UTC).
int[]	getSimulationTimeArr()	Returns the current UTC simulation time in an array.
float	getStarBrightness()	Gets the star brightness value.
float	getStarMinOpacity()	Gets the minimum star opacity.
double[]	getStarParameters(String id)	Returns the star parameters given its identifier or name, if the star exists and it is loaded.
float	getStarSize()	Gets the current star size value in pixels.
String	getVersionNumber()	Returns the version number string.
void	goToObject(com.badlogic.ashley.core.Entity object, double solidAngle, int waitTimeSeconds, AtomicBoolean stop)
void	goToObject(String name)	Runs a seamless trip to the object with the name focusName until the object view angle is 20 degrees.
void	goToObject(String name, double angle)	Runs a seamless trip to the object with the name focusName until the object view angle viewAngle is met.
void	goToObject(String name, double solidAngle, float waitTimeSeconds)	Runs a seamless trip to the object with the name focusName until the object view angle viewAngle is met.
void	goToObject(String name, double solidAngle, int waitTimeSeconds)
void	goToObject(String name, double solidAngle, int waitTimeSeconds, AtomicBoolean stop)
void	goToObject(String name, long solidAngle, float waitTimeSeconds)
void	goToObject(String name, long solidAngle, int waitTimeSeconds)
void	goToObjectInstant(String name)	Sets the camera in focus mode with the given focus object and instantly moves the camera next to the focus object.
boolean	hasDataset(String dsName)	Checks whether the dataset identified by the given name is loaded
boolean	hideDataset(String dsName)	Hides the dataset identified by the given name, if it exists and is not hidden.
boolean	highlightDataset(String dsName, boolean highlight)	Enables or disables the dataset highlight using a plain color chosen by the system.
boolean	highlightDataset(String dsName, float r, float g, float b, float a, boolean highlight)	Enables or disables the dataset highlight, using a given plain color.
boolean	highlightDataset(String dsName, int colorIndex, boolean highlight)	Enables or disables the dataset highlight, using a plain color given by the color index: 0 - blue 1 - red 2 - yellow 3 - green 4 - pink 5 - orange 6 - purple 7 - brown 8 - magenta
boolean	highlightDataset(String dsName, String attributeName, String colorMap, double minMap, double maxMap, boolean highlight)	Enables or disables the dataset highlight, using the given color map on the given attribute with the given maximum and minimum mapping values.
double[]	internalCartesianToEquatorial(double x, double y, double z)	Converts internal cartesian coordinates to equatorial [ra, dec, distance] coordinates.
double[]	internalCartesianToEquatorial(int x, int y, int z)
double	internalUnitsToKilometres(double internalUnits)	Converts the value in internal units to Kilometers.
double[]	internalUnitsToKilometres(double[] internalUnits)	Converts the array in internal units to Kilometers.
double[]	internalUnitsToKilometres(List<?> internalUnits)
double	internalUnitsToMetres(double internalUnits)	Converts the value in internal units to metres.
double	internalUnitsToParsecs(double internalUnits)	Converts the value in internal units to parsecs.
double[]	internalUnitsToParsecs(double[] internalUnits)	Converts the array in internal units to parsecs.
boolean	isFrameOutputActive()	Is the frame output system on?
boolean	isRenderOutputActive()	Is the frame output system on?
boolean	isSimulationTimeOn()	Queries whether the time is on or not.
double	kilometersToInternalUnits(double kilometres)
double	kilometresToInternalUnits(double kilometres)	Converts the kilometres to internal units.
void	landAtObjectLocation(com.badlogic.ashley.core.Entity object, String locationName, AtomicBoolean stop)
void	landAtObjectLocation(String name, double longitude, double latitude)	Lands on the object with the given name, if it is a planet or moon, at the location specified in by [latitude, longitude], in degrees.
void	landAtObjectLocation(String name, String locationName)	Lands on the object with the given name, if it is a planet or moon, at the location with the given name, if it exists.
void	landAtObjectLocation(String name, String locationName, AtomicBoolean stop)
void	landOnObject(String name)	Lands on the object with the given name, if it is a planet or moon.
List<String>	listDatasets()	Returns the names of all datasets currently loaded.
boolean	loadDataset(String dsName, String absolutePath)	Loads a VOTable, FITS, CSV or JSON dataset file with the given name.
boolean	loadDataset(String dsName, String path, boolean sync)	Loads a VOTable, FITS, CSV or JSON dataset file with the given name.
boolean	loadDataset(String dsName, String path, CatalogInfo.CatalogInfoSource type, boolean sync)
boolean	loadDataset(String dsName, String path, CatalogInfo.CatalogInfoSource type, DatasetOptions datasetOptions, boolean sync)	Loads a VOTable, FITS, CSV or JSON dataset file with the given name.
boolean	loadDataset(String dsName, uk.ac.starlink.util.DataSource ds, CatalogInfo.CatalogInfoSource type, DatasetOptions datasetOptions, boolean sync)
boolean	loadJsonCatalog(String dsName, String path)	Loads a Gaia Sky JSON dataset file asynchronously.
boolean	loadJsonDataset(String dsName, String path)	Loads a JSON Gaia Sky dataset file asynchronously.
boolean	loadJsonDataset(String dsName, String pathString, boolean sync)	Loads a Gaia Sky JSON dataset file in a synchronous or asynchronous manner.
boolean	loadParticleDataset(String dsName, String path, double profileDecay, double[] particleColor, double colorNoise, double[] labelColor, double particleSize, double[] sizeLimits, ComponentTypes.ComponentType ct, double[] fadeIn, double[] fadeOut, boolean sync)
boolean	loadParticleDataset(String dsName, String path, double profileDecay, double[] particleColor, double colorNoise, double[] labelColor, double particleSize, double[] sizeLimits, String ct, double[] fadeIn, double[] fadeOut, boolean sync)	Loads a particle dataset (point cloud) from a VOTable, a CSV or a FITS file.
boolean	loadParticleDataset(String dsName, String path, double profileDecay, double[] particleColor, double colorNoise, double[] labelColor, double particleSize, String ct, boolean sync)	Loads a particle dataset (point cloud) from a VOTable, a CSV or a FITS file.
boolean	loadParticleDataset(String dsName, String path, double profileDecay, double[] particleColor, double colorNoise, double[] labelColor, double particleSize, String ct, double[] fadeIn, double[] fadeOut, boolean sync)	Loads a particle dataset (point cloud) from a VOTable, a CSV or a FITS file.
boolean	loadParticleDataset(String dsName, String path, double profileDecay, List<?> particleColor, double colorNoise, List<?> labelColor, double particleSize, String ct, boolean sync)
boolean	loadParticleDataset(String dsName, String path, double profileDecay, List<?> particleColor, double colorNoise, List<?> labelColor, double particleSize, String ct, List<?> fadeIn, List<?> fadeOut, boolean sync)
boolean	loadParticleDataset(String dsName, String path, double profileDecay, List<?> particleColor, double colorNoise, List<?> labelColor, double particleSize, List<?> sizeLimits, String ct, List<?> fadeIn, List<?> fadeOut, boolean sync)
boolean	loadParticleDataset(String dsName, String path, CatalogInfo.CatalogInfoSource type, double profileDecay, double[] particleColor, double colorNoise, double[] labelColor, double particleSize, double[] sizeLimits, ComponentTypes.ComponentType ct, double[] fadeIn, double[] fadeOut, boolean sync)
boolean	loadStarClusterDataset(String dsName, String path, double[] particleColor, double[] fadeIn, double[] fadeOut, boolean sync)	Loads a star cluster dataset from a CSV, VOTable or FITS file.
boolean	loadStarClusterDataset(String dsName, String path, double[] particleColor, double[] labelColor, double[] fadeIn, double[] fadeOut, boolean sync)	Loads a star cluster dataset from a CSV, VOTable or FITS file.
boolean	loadStarClusterDataset(String dsName, String path, double[] particleColor, double[] labelColor, String ct, double[] fadeIn, double[] fadeOut, boolean sync)	Loads a star cluster dataset from a CSV, VOTable or FITS file.
boolean	loadStarClusterDataset(String dsName, String path, double[] particleColor, String ct, double[] fadeIn, double[] fadeOut, boolean sync)	Loads a star cluster dataset from a CSV, VOTable or FITS file.
boolean	loadStarClusterDataset(String dsName, String path, List<?> particleColor, String ct, List<?> fadeIn, List<?> fadeOut, boolean sync)
boolean	loadStarClusterDataset(String dsName, String path, List<?> particleColor, List<?> labelColor, String ct, List<?> fadeIn, List<?> fadeOut, boolean sync)
boolean	loadStarClusterDataset(String dsName, String path, List<?> particleColor, List<?> fadeIn, List<?> fadeOut, boolean sync)
boolean	loadStarClusterDataset(String dsName, String path, List<?> particleColor, List<?> labelColor, List<?> fadeIn, List<?> fadeOut, boolean sync)
boolean	loadStarDataset(String dsName, String path, boolean sync)	Loads a star dataset from a VOTable, a CSV or a FITS file.
boolean	loadStarDataset(String dsName, String path, double magnitudeScale, boolean sync)	Loads a star dataset from a VOTable, a CSV or a FITS file.
boolean	loadStarDataset(String dsName, String path, double magnitudeScale, double[] labelColor, boolean sync)	Loads a star dataset from a VOTable, a CSV or a FITS file.
boolean	loadStarDataset(String dsName, String path, double magnitudeScale, double[] labelColor, double[] fadeIn, double[] fadeOut, boolean sync)	Loads a star dataset from a VOTable, a CSV or a FITS file.
boolean	loadStarDataset(String dsName, String path, double magnitudeScale, List<?> labelColor, boolean sync)
boolean	loadStarDataset(String dsName, String path, double magnitudeScale, List<?> labelColor, List<?> fadeIn, List<?> fadeOut, boolean sync)
boolean	loadStarDataset(String dsName, String path, CatalogInfo.CatalogInfoSource type, double magnitudeScale, double[] labelColor, double[] fadeIn, double[] fadeOut, boolean sync)
boolean	loadVariableStarDataset(String dsName, String path, double magnitudeScale, double[] labelColor, double[] fadeIn, double[] fadeOut, boolean sync)	Loads a variable star dataset from a VOTable, CSV or FITS file.
boolean	loadVariableStarDataset(String dsName, String path, CatalogInfo.CatalogInfoSource type, double magnitudeScale, double[] labelColor, double[] fadeIn, double[] fadeOut, boolean sync)
void	log(String message)	Print text using the internal logging system.
void	maximizeInterfaceWindow()	Maximizes the interface window.
double	metresToInternalUnits(double metres)	Converts the metres to internal units.
void	minimizeInterfaceWindow()	Minimizes the interface window.
void	notify(Event event, Object source, Object... data)	Event notification call.
void	parkCameraRunnable(String id, Runnable runnable)	Parks a camera update Runnable to the main loop thread, and keeps it running every frame until it finishes or it is unparked by IScriptingInterface.unparkRunnable(String).
void	parkRunnable(String id, Runnable runnable)	See IScriptingInterface.parkSceneRunnable(String, Runnable).
void	parkSceneRunnable(String id, Runnable runnable)	Parks an update Runnable to the main loop thread, and keeps it running every frame until it finishes or it is unparked by IScriptingInterface.unparkRunnable(String).
double	parsecsToInternalUnits(double parsecs)	Converts the parsecs to internal units.
void	playCameraPath(String file)	Alias for IScriptingInterface.runCameraPath(String)
void	playCameraPath(String file, boolean sync)	Alias for IScriptingInterface.runCameraPath(String, boolean)
void	pointAtSkyCoordinate(double ra, double dec)	Sets the camera in free mode and points it to the given coordinates in equatorial system.
void	pointAtSkyCoordinate(long ra, long dec)
void	postRunnable(Runnable runnable)	Posts a Runnable to the main loop thread that runs once after the update-scene stage, and before the render stage.
void	preloadTexture(String path)	Pre-loads the given image as a texture for later use.
void	preloadTextures(String[] paths)	Pre-loads the given images as textures for later use.
void	print(String message)	Print text using the internal logging system.
void	quit()	Initiates the quit action to terminate the program.
void	refreshAllOrbits()	Forces all orbits to refresh immediately.
void	refreshObjectOrbit(String name)	Forces the refresh of the orbit of the object identified by name.
void	removeAllObjects()	Removes all objects.
void	removeCameraTrackingObject()	Removes the tracking object from the camera, if any.
boolean	removeDataset(String dsName)	Removes the dataset identified by the given name, if it exists.
void	removeModelObject(String name)	Removes the model object identified by the given name from the internal scene graph model of Gaia Sky, if it exists.
void	removeObject(int id)	Removes the item with the given id.
void	removeObjectCoordinatesProvider(String name)	Removes the current coordinates provider from the object with the given name.
void	removeObjects(int[] ids)	Removes the items with the given ids.
void	removeObjects(List<?> ids)
void	removeRunnable(String id)	Removes the runnable with the given id, if any.
void	resetImageSequenceNumber()	Resets to zero the image sequence number used to generate the file names of the frame output images.
double[]	rotate2(double[] vector, double angle)	Rotates a 2D vector by the specified angle in degrees, counter-clockwise assuming that the y axis points up.
double[]	rotate2(double[] vector, long angle)
double[]	rotate2(List<?> vector, double angle)
double[]	rotate2(List<?> vector, long angle)
double[]	rotate3(double[] vector, double[] axis, double angle)	Rotates a 3D vector around the given axis by the specified angle in degrees.
double[]	rotate3(double[] vector, double[] axis, long angle)
double[]	rotate3(List<?> vector, List<?> axis, double angle)
double[]	rotate3(List<?> vector, List<?> axis, long angle)
void	runCameraPath(String file)	Runs a .gsc camera path file and returns immediately.
void	runCameraPath(String file, boolean sync)	Runs a .gsc camera path file and returns immediately.
void	runCameraRecording(String file)	Runs the camera recording file with the given path.
void	saveScreenshot()	Takes a screenshot of the current frame and saves it to the configured location (see IScriptingInterface.configureScreenshots(int, int, String, String)).
void	setAmbientLight(float ambientLight)	Sets the ambient light to a certain value.
void	setAmbientLight(int value)
void	setBackBufferScale(float scale)	Sets the scaling factor for the back-buffer.
void	setBloom(float value)	Sets the strength value for the bloom effect.
void	setBloom(int level)
void	setBrightnessLevel(double level)	Sets the brightness level of the render system.
void	setBrightnessLevel(long level)
void	setCameraCenterFocus(boolean centerFocus)	Whether to look for the focus constantly when in focus mode and center it in the view or whether the view must be free.
void	setCameraDirection(double[] direction)	Sets the camera direction vector to the given vector, in the internal reference system.
void	setCameraDirection(double[] direction, boolean immediate)	Sets the camera direction vector to the given vector, in the internal reference system.
void	setCameraDirection(List<?> dir)
void	setCameraDirection(List<?> dir, boolean immediate)
void	setCameraFocus(String focusName)	Sets the camera in focus mode with the focus object that bears the given focusName.
void	setCameraFocus(String focusName, float waitTimeSeconds)	Sets the camera in focus mode with the focus object that bears the given focusName.
void	setCameraFocus(String focusName, int waitTimeSeconds)
void	setCameraFocusInstant(String focusName)	Sets the camera in focus mode with the given focus object.
void	setCameraFocusInstantAndGo(String focusName)	Sets the camera in focus mode with the given focus object and instantly moves the camera next to the focus object.
void	setCameraFocusInstantAndGo(String focusName, boolean sleep)
void	setCameraFov1()	Sets the camera in FoV1 mode.
void	setCameraFov1and2()	Sets the camera in Fov1 and 2 mode.
void	setCameraFov2()	Sets the camera in FoV2 mode.
void	setCameraFree()	Sets the camera in free mode.
void	setCameraLock(boolean lock)	Activates or deactivates the camera lock to the focus reference system when in focus mode.
void	setCameraOrientationLock(boolean lock)	Locks or unlocks the orientation of the camera to the focus object's rotation.
void	setCameraPosition(double[] position)	Sets the camera position to the given coordinates, in the internal reference system and kilometres.
void	setCameraPosition(double[] position, boolean immediate)	Sets the camera position to the given coordinates, in the internal reference system and kilometres.
void	setCameraPosition(double[] position, String units)	Sets the camera position to the given coordinates, in the internal reference system and the given units.
void	setCameraPosition(double[] position, String units, boolean immediate)	Sets the camera position to the given coordinates, in the internal reference system and in the requested units.
void	setCameraPosition(double x, double y, double z)	Component-wise version of IScriptingInterface.setCameraPosition(double[]).
void	setCameraPosition(double x, double y, double z, boolean immediate)	Component-wise version of IScriptingInterface.setCameraPosition(double[], boolean).
void	setCameraPosition(double x, double y, double z, String units)	Component-wise version of IScriptingInterface.setCameraPosition(double[], String).
void	setCameraPosition(double x, double y, double z, String units, boolean immediate)	Component-wise version of IScriptingInterface.setCameraPosition(double[], String, boolean).
void	setCameraPosition(List<?> vec)
void	setCameraPosition(List<?> vec, boolean immediate)
void	setCameraPosition(List<?> vec, String units)
void	setCameraPositionAndFocus(String focus, String other, double rotation, double solidAngle)	Sets the focus and instantly moves the camera to a point in the line defined by focus-other and rotated rotation degrees around focus using the camera up vector as a rotation axis.

Methods inherited from class java.lang.Object

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

Constructor Details

EventScriptingInterface

public EventScriptingInterface(com.badlogic.gdx.assets.AssetManager manager,
 CatalogManager catalogManager)

Method Details

activateRealTimeFrame

public void activateRealTimeFrame()

Description copied from interface: IScriptingInterface

Sets the current time frame to real time. All the commands executed after this command becomes active will be in the real time frame (clock ticks).

Specified by:

activateRealTimeFrame in interface IScriptingInterface

activateSimulationTimeFrame

public void activateSimulationTimeFrame()

Description copied from interface: IScriptingInterface

Sets the current time frame to simulation time. All the commands executed after this command becomes active will be in the simulation time frame (simulation clock in the app).

Specified by:

activateSimulationTimeFrame in interface IScriptingInterface

displayPopupNotification

public void displayPopupNotification(String message)

Description copied from interface: IScriptingInterface

Displays a popup notification on the screen for the default duration.

Specified by:

displayPopupNotification in interface IScriptingInterface

Parameters:

message - The message text.

displayPopupNotification

public void displayPopupNotification(String message,
 float duration)

Description copied from interface: IScriptingInterface

Displays a popup notification on the screen for the given duration.

Specified by:

displayPopupNotification in interface IScriptingInterface

Parameters:

message - The message text.

duration - The duration in seconds until the notification is removed.

displayPopupNotification

public void displayPopupNotification(String message,
 Double duration)

setHeadlineMessage

public void setHeadlineMessage(String headline)

Description copied from interface: IScriptingInterface

Sets a headline message that will appear in a big font in the screen.

Specified by:

setHeadlineMessage in interface IScriptingInterface

Parameters:

headline - The headline text.

setSubheadMessage

public void setSubheadMessage(String subhead)

Description copied from interface: IScriptingInterface

Sets a subhead message that will appear in a small font below the headline.

Specified by:

setSubheadMessage in interface IScriptingInterface

Parameters:

subhead - The subhead text.

clearHeadlineMessage

public void clearHeadlineMessage()

Description copied from interface: IScriptingInterface

Clears the headline messge.

Specified by:

clearHeadlineMessage in interface IScriptingInterface

clearSubheadMessage

public void clearSubheadMessage()

Description copied from interface: IScriptingInterface

Clears the subhead message.

Specified by:

clearSubheadMessage in interface IScriptingInterface

clearAllMessages

public void clearAllMessages()

Description copied from interface: IScriptingInterface

Clears both the subhead and the headline messages.

Specified by:

clearAllMessages in interface IScriptingInterface

disableInput

public void disableInput()

Description copied from interface: IScriptingInterface

Disables all input events from mouse, keyboard, touchscreen, etc.

Specified by:

disableInput in interface IScriptingInterface

enableInput

public void enableInput()

Description copied from interface: IScriptingInterface

Enables all input events.

Specified by:

enableInput in interface IScriptingInterface

setCinematicCamera

public void setCinematicCamera(boolean cinematic)

Description copied from interface: IScriptingInterface

Enables or disables the cinematic camera mode.

Specified by:

setCinematicCamera in interface IScriptingInterface

Parameters:

cinematic - Whether to enable or disable the cinematic mode.

setCameraFocus

public void setCameraFocus(String focusName)

Description copied from interface: IScriptingInterface

Sets the camera in focus mode with the focus object that bears the given focusName. It returns immediately, so it does not wait for the camera direction to point to the focus.

Specified by:

setCameraFocus in interface IScriptingInterface

Parameters:

focusName - The name of the new focus object.

setCameraFocus

public void setCameraFocus(String focusName,
 float waitTimeSeconds)

Description copied from interface: IScriptingInterface

Sets the camera in focus mode with the focus object that bears the given focusName. The amount of time to block and wait for the camera to face the focus can also be specified in waitTimeSeconds.

Specified by:

setCameraFocus in interface IScriptingInterface

Parameters:

focusName - The name of the new focus object.

waitTimeSeconds - Maximum time in seconds to wait for the camera to face the focus. If negative, we wait indefinitely.

setCameraFocus

public void setCameraFocus(String focusName,
 int waitTimeSeconds)

setCameraFocusInstant

public void setCameraFocusInstant(String focusName)

Description copied from interface: IScriptingInterface

Sets the camera in focus mode with the given focus object. It also instantly sets the camera direction vector to point towards the focus.

Specified by:

setCameraFocusInstant in interface IScriptingInterface

Parameters:

focusName - The name of the new focus object.

setCameraFocusInstantAndGo

public void setCameraFocusInstantAndGo(String focusName)

Description copied from interface: IScriptingInterface

Sets the camera in focus mode with the given focus object and instantly moves the camera next to the focus object.

Specified by:

setCameraFocusInstantAndGo in interface IScriptingInterface

Parameters:

focusName - The name of the new focus object.

setCameraFocusInstantAndGo

public void setCameraFocusInstantAndGo(String focusName,
 boolean sleep)

setCameraLock

public void setCameraLock(boolean lock)

Description copied from interface: IScriptingInterface

Activates or deactivates the camera lock to the focus reference system when in focus mode.

Specified by:

setCameraLock in interface IScriptingInterface

Parameters:

lock - Activate or deactivate the lock.

setCameraCenterFocus

public void setCameraCenterFocus(boolean centerFocus)

Description copied from interface: IScriptingInterface

Whether to look for the focus constantly when in focus mode and center it in the view or whether the view must be free. Use True to center the focus (default behaviour) and False to set it to a free view.

Specified by:

setCameraCenterFocus in interface IScriptingInterface

Parameters:

centerFocus - Whether to center the focus or not.

setCameraFree

public void setCameraFree()

Description copied from interface: IScriptingInterface

Sets the camera in free mode.

Specified by:

setCameraFree in interface IScriptingInterface

setCameraFov1

public void setCameraFov1()

Description copied from interface: IScriptingInterface

Sets the camera in FoV1 mode. The camera is positioned in Gaia's focal plane and observes what Gaia observes through its field of view 1.

Specified by:

setCameraFov1 in interface IScriptingInterface

setCameraFov2

public void setCameraFov2()

Description copied from interface: IScriptingInterface

Sets the camera in FoV2 mode. The camera is positioned in Gaia's focal plane and observes what Gaia observes through its field of view 2.

Specified by:

setCameraFov2 in interface IScriptingInterface

setCameraFov1and2

public void setCameraFov1and2()

Description copied from interface: IScriptingInterface

Sets the camera in Fov1 and 2 mode. The camera is positioned in Gaia's focal plane and observes what Gaia observes through its two fields of view.

Specified by:

setCameraFov1and2 in interface IScriptingInterface

setCameraPostion

public void setCameraPostion(double[] vec)

Description copied from interface: IScriptingInterface

Sets the camera position to the given coordinates, in Km, equatorial system.

Specified by:

setCameraPostion in interface IScriptingInterface

Parameters:

vec - Vector of three components in internal coordinates and Km.

setCameraPosition

public void setCameraPosition(double x,
 double y,
 double z)

Description copied from interface: IScriptingInterface

Component-wise version of IScriptingInterface.setCameraPosition(double[]).

Specified by:

setCameraPosition in interface IScriptingInterface

setCameraPosition

public void setCameraPosition(double x,
 double y,
 double z,
 String units)

Description copied from interface: IScriptingInterface

Component-wise version of IScriptingInterface.setCameraPosition(double[], String).

Specified by:

setCameraPosition in interface IScriptingInterface

setCameraPosition

public void setCameraPosition(double x,
 double y,
 double z,
 boolean immediate)

Description copied from interface: IScriptingInterface

Component-wise version of IScriptingInterface.setCameraPosition(double[], boolean).

Specified by:

setCameraPosition in interface IScriptingInterface

setCameraPosition

public void setCameraPosition(double x,
 double y,
 double z,
 String units,
 boolean immediate)

Description copied from interface: IScriptingInterface

Component-wise version of IScriptingInterface.setCameraPosition(double[], String, boolean).

Specified by:

setCameraPosition in interface IScriptingInterface

setCameraPosition

public void setCameraPosition(List<?> vec,
 boolean immediate)

setCameraPosition

public void setCameraPosition(double[] position,
 boolean immediate)

Description copied from interface: IScriptingInterface

Sets the camera position to the given coordinates, in the internal reference system and kilometres. The immediate parameter enables setting the camera state immediately without waiting for the possible current update operation to finish. Set this to true if you run this function from within a parked runnable.

Specified by:

setCameraPosition in interface IScriptingInterface

Parameters:

position - Vector of three components in internal coordinates and Km.

immediate - Whether to apply the changes immediately, or wait for the next frame.

setCameraPosition

public void setCameraPosition(double[] position,
 String units,
 boolean immediate)

Description copied from interface: IScriptingInterface

Sets the camera position to the given coordinates, in the internal reference system and in the requested units. The immediate parameter enables setting the camera state immediately without waiting for the possible current update operation to finish. Set this to true if you run this function from within a parked runnable.

Specified by:

setCameraPosition in interface IScriptingInterface

Parameters:

position - Vector of three components in internal coordinates and the requested units.

units - The distance units to use. One of "m", "km", "au", "ly", "pc", "internal".

immediate - Whether to apply the changes immediately, or wait for the next frame.

getCameraPosition

public double[] getCameraPosition()

Description copied from interface: IScriptingInterface

Gets the current camera position, in km.

Specified by:

getCameraPosition in interface IScriptingInterface

Returns:

The camera position coordinates in the internal reference system, in km.

getCameraPosition

public double[] getCameraPosition(String units)

Description copied from interface: IScriptingInterface

Gets the current camera position, in the requested units.

Specified by:

getCameraPosition in interface IScriptingInterface

Parameters:

units - The distance units to use. One of "m", "km", "au", "ly", "pc", "internal".

Returns:

The camera position coordinates in the internal reference system and in the requested units.

setCameraPosition

public void setCameraPosition(double[] position)

Description copied from interface: IScriptingInterface

Sets the camera position to the given coordinates, in the internal reference system and kilometres. The default behavior of this method posts a runnable to update the camera after the current frame. If you need to call this method from within a parked runnable, use IScriptingInterface.setCameraPosition(double[], boolean), with the boolean set to true.

Specified by:

setCameraPosition in interface IScriptingInterface

Parameters:

position - Vector of three components in internal coordinates and Km.

setCameraPosition

public void setCameraPosition(double[] position,
 String units)

Description copied from interface: IScriptingInterface

Sets the camera position to the given coordinates, in the internal reference system and the given units. The default behavior of this method posts a runnable to update the camera after the current frame. If you need to call this method from within a parked runnable, use IScriptingInterface.setCameraPosition(double[], boolean), with the boolean set to true.

Specified by:

setCameraPosition in interface IScriptingInterface

Parameters:

position - Vector of three components in internal coordinates and the given units.

units - The distance units to use. One of "m", "km", "au", "ly", "pc", "internal".

setCameraPosition

public void setCameraPosition(List<?> vec)

setCameraPosition

public void setCameraPosition(List<?> vec,
 String units)

setCameraDirection

public void setCameraDirection(List<?> dir,
 boolean immediate)

setCameraDirection

public void setCameraDirection(double[] direction,
 boolean immediate)

Description copied from interface: IScriptingInterface

Sets the camera direction vector to the given vector, in the internal reference system. The immediate parameter enables setting the camera state immediately without waiting for the possible current update operation to finish. Set this to true if you run this function from within a parked runnable.

Specified by:

setCameraDirection in interface IScriptingInterface

Parameters:

direction - The direction vector in the internal reference system.

immediate - Whether to apply the changes immediately, or wait for the next frame.

getCameraDirection

public double[] getCameraDirection()

Description copied from interface: IScriptingInterface

Gets the current camera direction vector.

Specified by:

getCameraDirection in interface IScriptingInterface

Returns:

The camera direction vector in the internal reference system.

setCameraDirection

public void setCameraDirection(double[] direction)

Description copied from interface: IScriptingInterface

Sets the camera direction vector to the given vector, in the internal reference system. You can convert from spherical coordinates using IScriptingInterface.equatorialCartesianToInternalCartesian(double[], double), IScriptingInterface.galacticToInternalCartesian(double, double, double) and IScriptingInterface.eclipticToInternalCartesian(double, double, double). The default behavior of this method posts a runnable to update the camera after the current frame. If you need to call this method from within a parked runnable, use IScriptingInterface.setCameraDirection(double[], boolean), with the boolean set to true.

Specified by:

setCameraDirection in interface IScriptingInterface

Parameters:

direction - The direction vector in equatorial cartesian coordinates.

setCameraDirection

public void setCameraDirection(List<?> dir)

setCameraUp

public void setCameraUp(List<?> up,
 boolean immediate)

setCameraUp

public void setCameraUp(double[] up,
 boolean immediate)

Description copied from interface: IScriptingInterface

Sets the camera up vector to the given vector, in the internal reference system. The immediate parameter enables setting the camera state immediately without waiting for the possible current update operation to finish. Set this to true if you run this function from within a parked runnable.

Specified by:

setCameraUp in interface IScriptingInterface

Parameters:

up - The up vector in equatorial coordinates.

immediate - Whether to apply the changes immediately, or wait for the next frame.

getCameraUp

public double[] getCameraUp()

Description copied from interface: IScriptingInterface

Gets the current camera up vector.

Specified by:

getCameraUp in interface IScriptingInterface

Returns:

The camera up vector in the internal reference system.

setCameraUp

public void setCameraUp(double[] up)

Description copied from interface: IScriptingInterface

Sets the camera up vector to the given vector, in the internal reference system. The default behavior of this method posts a runnable to update the camera after the current frame. If you need to call this method from within a parked runnable, use IScriptingInterface.setCameraUp(double[], boolean), with the boolean set to true.

Specified by:

setCameraUp in interface IScriptingInterface

Parameters:

up - The up vector in equatorial coordinates.

setCameraUp

public void setCameraUp(List<?> up)

setCameraPositionAndFocus

public void setCameraPositionAndFocus(String focus,
 String other,
 double rotation,
 double solidAngle)

Description copied from interface: IScriptingInterface

Sets the focus and instantly moves the camera to a point in the line defined by focus-other and rotated rotation degrees around focus using the camera up vector as a rotation axis.

Specified by:

setCameraPositionAndFocus in interface IScriptingInterface

Parameters:

focus - The name of the focus object.

other - The name of the other object, to the fine a line from this to foucs. Usually a light source.

rotation - The rotation angle, in degrees.

solidAngle - The target solid angle which determines the distance, in degrees.

setCameraPositionAndFocus

public void setCameraPositionAndFocus(String focus,
 String other,
 long rotation,
 long solidAngle)

pointAtSkyCoordinate

public void pointAtSkyCoordinate(double ra,
 double dec)

Description copied from interface: IScriptingInterface

Sets the camera in free mode and points it to the given coordinates in equatorial system.

Specified by:

pointAtSkyCoordinate in interface IScriptingInterface

Parameters:

ra - Right ascension in degrees.

dec - Declination in degrees.

pointAtSkyCoordinate

public void pointAtSkyCoordinate(long ra,
 long dec)

getCameraSpeed

public double getCameraSpeed()

Description copied from interface: IScriptingInterface

Gets the current physical speed of the camera in km/h.

Specified by:

getCameraSpeed in interface IScriptingInterface

Returns:

The current speed of the camera in km/h.

setCameraSpeed

public void setCameraSpeed(float speed)

Description copied from interface: IScriptingInterface

Changes the speed multiplier of the camera and its acceleration.

Specified by:

setCameraSpeed in interface IScriptingInterface

Parameters:

speed - The new speed, from 0 to 100.

setCameraSpeed

public void setCameraSpeed(int speed)

setCameraRotationSpeed

public void setCameraRotationSpeed(float speed)

Description copied from interface: IScriptingInterface

Changes the speed of the camera when it rotates around a focus.

Specified by:

setCameraRotationSpeed in interface IScriptingInterface

Parameters:

speed - The new rotation speed in [0,100]

setCameraRotationSpeed

public void setCameraRotationSpeed(int speed)

setRotationCameraSpeed

public void setRotationCameraSpeed(float speed)

Description copied from interface: IScriptingInterface

Changes the speed of the camera when it rotates around a focus.

Specified by:

setRotationCameraSpeed in interface IScriptingInterface

Parameters:

speed - The new rotation speed in [0,100]

setRotationCameraSpeed

public void setRotationCameraSpeed(int speed)

setCameraTurningSpeed

public void setCameraTurningSpeed(float speed)

Description copied from interface: IScriptingInterface

Changes the turning speed of the camera.

Specified by:

setCameraTurningSpeed in interface IScriptingInterface

Parameters:

speed - The new turning speed, from 1 to 100.

setCameraTurningSpeed

public void setCameraTurningSpeed(int speed)

setTurningCameraSpeed

public void setTurningCameraSpeed(float speed)

Description copied from interface: IScriptingInterface

Changes the turning speed of the camera.

Specified by:

setTurningCameraSpeed in interface IScriptingInterface

Parameters:

speed - The new turning speed, from 1 to 100.

setTurningCameraSpeed

public void setTurningCameraSpeed(int speed)

setCameraSpeedLimit

public void setCameraSpeedLimit(int index)

Description copied from interface: IScriptingInterface

Sets the speed limit of the camera given an index. The index corresponds to the following:

• 0 - 1 Km/h
• 1 - 10 Km/h
• 2 - 100 Km/h
• 3 - 1000 Km/h
• 4 - 1 Km/s
• 5 - 10 Km/s
• 6 - 100 Km/s
• 7 - 1000 Km/s
• 8 - 0.01 c
• 9 - 0.1 c
• 10 - 0.5 c
• 11 - 0.8 c
• 12 - 0.9 c
• 13 - 0.99 c
• 14 - 0.99999 c
• 15 - 1 c
• 16 - 2 c
• 17 - 10 c
• 18 - 1e3 c
• 19 - 1 AU/s
• 20 - 10 AU/s
• 21 - 1000 AU/s
• 22 - 10000 AU/s
• 23 - 1 pc/s
• 24 - 2 pc/s
• 25 - 10 pc/s
• 26 - 1000 pc/s
• 27 - unlimited

Specified by:

setCameraSpeedLimit in interface IScriptingInterface

Parameters:

index - The index of the top speed.

setCameraTrackingObject

public void setCameraTrackingObject(String objectName)

Description copied from interface: IScriptingInterface

Sets the camera to track the object with the given name. In this mode, the position of the camera is still dependent on the focus object (if any), but its direction points to the tracking object.

Specified by:

setCameraTrackingObject in interface IScriptingInterface

Parameters:

objectName - The name of the new tracking object.

removeCameraTrackingObject

public void removeCameraTrackingObject()

Description copied from interface: IScriptingInterface

Removes the tracking object from the camera, if any.

Specified by:

removeCameraTrackingObject in interface IScriptingInterface

setCameraOrientationLock

public void setCameraOrientationLock(boolean lock)

Description copied from interface: IScriptingInterface

Locks or unlocks the orientation of the camera to the focus object's rotation.

Specified by:

setCameraOrientationLock in interface IScriptingInterface

Parameters:

lock - Whether to lock or unlock the camera orientation to the focus.

cameraForward

public void cameraForward(double cameraForward)

Description copied from interface: IScriptingInterface

Adds a forward movement to the camera with the given value. If value is negative the movement is backwards.

Specified by:

cameraForward in interface IScriptingInterface

Parameters:

cameraForward - The magnitude of the movement, between -1 and 1.

cameraForward

public void cameraForward(long value)

cameraRotate

public void cameraRotate(double deltaX,
 double deltaY)

Description copied from interface: IScriptingInterface

Adds a rotation movement to the camera around the current focus, or a pitch/yaw if in free mode.

If the camera is not using the cinematic behaviour (IScriptingInterface.setCinematicCamera(boolean), the rotation movement will not be permanent. Use the cinematic behaviour to have the camera continue to rotate around the focus.

Specified by:

cameraRotate in interface IScriptingInterface

Parameters:

deltaX - The x component, between 0 and 1. Positive is right and negative is left.

deltaY - The y component, between 0 and 1. Positive is up and negative is down.

cameraRotate

public void cameraRotate(double deltaX,
 long deltaY)

cameraRotate

public void cameraRotate(long deltaX,
 double deltaY)

cameraRoll

public void cameraRoll(double roll)

Description copied from interface: IScriptingInterface

Adds a roll force to the camera.

Specified by:

cameraRoll in interface IScriptingInterface

Parameters:

roll - The intensity of the roll.

cameraRoll

public void cameraRoll(long roll)

cameraTurn

public void cameraTurn(double deltaX,
 double deltaY)

Description copied from interface: IScriptingInterface

Adds a turn force to the camera (yaw and/or pitch). If the camera is in focus mode, it permanently deviates the line of sight from the focus until centered again. If the camera is not using the cinematic behaviour (IScriptingInterface.setCinematicCamera(boolean), the turn will not be permanent. Use the cinematic behaviour to have the turn persist in time.

Specified by:

cameraTurn in interface IScriptingInterface

Parameters:

deltaX - The x component, between 0 and 1. Positive is right and negative is left.

deltaY - The y component, between 0 and 1. Positive is up and negative is down.

cameraTurn

public void cameraTurn(double deltaX,
 long deltaY)

cameraTurn

public void cameraTurn(long deltaX,
 double deltaY)

cameraTurn

public void cameraTurn(long deltaX,
 long deltaY)

cameraYaw

public void cameraYaw(double amount)

Description copied from interface: IScriptingInterface

Adds a yaw to the camera. Same as IScriptingInterface.cameraTurn(double, double) with deltaY set to zero.

Specified by:

cameraYaw in interface IScriptingInterface

Parameters:

amount - The amount.

cameraYaw

public void cameraYaw(long amount)

cameraPitch

public void cameraPitch(double amount)

Description copied from interface: IScriptingInterface

Adds a pitch to the camera. Same as IScriptingInterface.cameraTurn(double, double) with deltaX set to zero.

Specified by:

cameraPitch in interface IScriptingInterface

Parameters:

amount - The amount.

cameraPitch

public void cameraPitch(long amount)

cameraStop

public void cameraStop()

Description copied from interface: IScriptingInterface

Stops all camera motion.

Specified by:

cameraStop in interface IScriptingInterface

cameraCenter

public void cameraCenter()

Description copied from interface: IScriptingInterface

Centers the camera to the focus, removing any deviation of the line of sight. Useful to center the focus object again after turning.

Specified by:

cameraCenter in interface IScriptingInterface

getClosestObjectToCamera

public IFocus getClosestObjectToCamera()

Description copied from interface: IScriptingInterface

Returns the closest object to the camera in this instant as a IFocus.

Specified by:

getClosestObjectToCamera in interface IScriptingInterface

Returns:

The closest object to the camera.

setFov

public void setFov(float newFov)

Description copied from interface: IScriptingInterface

Changes the field of view of the camera.

Specified by:

setFov in interface IScriptingInterface

Parameters:

newFov - The new field of view value in degrees, between Constants.MIN_FOV and Constants.MAX_FOV.

setFov

public void setFov(int newFov)

setVisibility

public void setVisibility(String key,
 boolean visible)

Description copied from interface: IScriptingInterface

See IScriptingInterface.setComponentTypeVisibility(String, boolean).

Specified by:

setVisibility in interface IScriptingInterface

setComponentTypeVisibility

public void setComponentTypeVisibility(String key,
 boolean visible)

Description copied from interface: IScriptingInterface

Sets the component described by the given name visible or invisible.

Specified by:

setComponentTypeVisibility in interface IScriptingInterface

Parameters:

key - The key of the component: "element.stars", "element.planets", "element.moons", etc. See ComponentTypes.ComponentType.

visible - The visible value.

getComponentTypeVisibility

public boolean getComponentTypeVisibility(String key)

Description copied from interface: IScriptingInterface

Gets the visibility of the component type described by the key. Examples of keys are "element.stars", "element.planets" or "element.moons". See ComponentTypes.ComponentType.

Specified by:

getComponentTypeVisibility in interface IScriptingInterface

Parameters:

key - The key of the component type to query.

Returns:

The visibility of the component type.

setObjectVisibility

public boolean setObjectVisibility(String name,
 boolean visible)

Description copied from interface: IScriptingInterface

Sets the visibility of a particular object. Use this method to hide individual objects. Changes to the individual object visibility are not persisted on restart.

Specified by:

setObjectVisibility in interface IScriptingInterface

Parameters:

name - The name of the object. Must be an instance of IVisibilitySwitch.

visible - The visible status to set. Set to false in order to hide the object. True to make it visible.

Returns:

True if the visibility was set successfully, false if there were errors.

getObjectVisibility

public boolean getObjectVisibility(String name)

Description copied from interface: IScriptingInterface

Gets the visibility of a particular object.

Specified by:

getObjectVisibility in interface IScriptingInterface

Parameters:

name - The name of the object. Must be an instance of IVisibilitySwitch.

Returns:

The visibility status of the object, if it exists.

setLabelSizeFactor

public void setLabelSizeFactor(float factor)

Description copied from interface: IScriptingInterface

Sets the label size factor. The label size will be multiplied by this.

Specified by:

setLabelSizeFactor in interface IScriptingInterface

Parameters:

factor - Factor in Constants.MIN_LABEL_SIZE and Constants.MAX_LABEL_SIZE.

setForceDisplayLabel

public void setForceDisplayLabel(String name,
 boolean forceLabel)

Description copied from interface: IScriptingInterface

Forces the label to display for the given object, bypassing the solid angle requirements that are usually in place and determine label visibility. This setting does not override the visibility of the object itself, or of the label visibility component element. Changes to the force display label flag are not persisted on restart.

Specified by:

setForceDisplayLabel in interface IScriptingInterface

Parameters:

name - The object name.

forceLabel - Whether to force the label to render for this object or not.

setLabelColor

public void setLabelColor(String name,
 double[] color)

Description copied from interface: IScriptingInterface

Sets the label color of the object identified by the given name. The label color must be an array of RGBA values in [0,1].

Specified by:

setLabelColor in interface IScriptingInterface

Parameters:

name - The object name.

color - The label color as an array of RGBA (red, green, blue, alpha) values in [0,1].

setLabelColor

public void setLabelColor(String name,
 List<?> color)

getForceDisplayLabel

public boolean getForceDisplayLabel(String name)

Description copied from interface: IScriptingInterface

Gets the value of the force display label flag for the object identified with the given name.

Specified by:

getForceDisplayLabel in interface IScriptingInterface

Parameters:

name - The name of the object.

Returns:

The value of the force display label flag of the object, if it exists.

setLabelSizeFactor

public void setLabelSizeFactor(int factor)

setLineWidthFactor

public void setLineWidthFactor(float factor)

Description copied from interface: IScriptingInterface

Sets the line width factor. The line width will be multiplied by this.

Specified by:

setLineWidthFactor in interface IScriptingInterface

Parameters:

factor - Factor in Constants.MIN_LINE_WIDTH and Constants.MAX_LINE_WIDTH.

setLineWidthFactor

public void setLineWidthFactor(int factor)

setProperMotionsNumberFactor

public void setProperMotionsNumberFactor(float factor)

Description copied from interface: IScriptingInterface

Sets the number factor of proper motion vectors that are visible. In [1,100].

Specified by:

setProperMotionsNumberFactor in interface IScriptingInterface

Parameters:

factor - Factor in [1,100].

setProperMotionsColorMode

public void setProperMotionsColorMode(int mode)

Description copied from interface: IScriptingInterface

Sets the color mode of proper motion vectors.

Specified by:

setProperMotionsColorMode in interface IScriptingInterface

Parameters:

mode - The color mode:

• 0 - direction: the normalised cartesian velocity components XYZ are mapped to the color channels RGB.
• 1 - magnitude (speed): the magnitude of the velocity vector is mapped using a rainbow scheme (blue-green-yellow-red) with the color map limit at 100 Km/s.
• 2 - has radial velocity: blue for stars with radial velocity, red for stars without.
• 3 - redshift from Sun: blue stars have negative radial velocity (from the Sun), red stars have positive radial velocity (from the Sun). Blue is mapped to -100 Km/s, red is mapped to 100 Km/s.
• 4 - redshift from camera: blue stars have negative radial velocity (from the camera), red stars have positive radial velocity (from the camera). Blue is mapped to -100 Km/s, red is mapped to 100 Km/s.
• 5 - single color: same color for all velocity vectors.

setProperMotionsArrowheads

public void setProperMotionsArrowheads(boolean arrowheadsEnabled)

Description copied from interface: IScriptingInterface

Sets whether to show arrowheads or not for the velocity vectors.

Specified by:

setProperMotionsArrowheads in interface IScriptingInterface

Parameters:

arrowheadsEnabled - Whether to show the velocity vectors with arrowheads.

setProperMotionsNumberFactor

public void setProperMotionsNumberFactor(int factor)

setUnfilteredProperMotionsNumberFactor

public void setUnfilteredProperMotionsNumberFactor(float factor)

setProperMotionsLengthFactor

public void setProperMotionsLengthFactor(float factor)

Description copied from interface: IScriptingInterface

Sets the length of the proper motion vectors, in [500,30000].

Specified by:

setProperMotionsLengthFactor in interface IScriptingInterface

Parameters:

factor - Factor in [500,30000].

setProperMotionsLengthFactor

public void setProperMotionsLengthFactor(int factor)

getProperMotionsMaxNumber

public long getProperMotionsMaxNumber()

Description copied from interface: IScriptingInterface

Returns the current maximum number of velocity vectors per star group.

Specified by:

getProperMotionsMaxNumber in interface IScriptingInterface

Returns:

Max number of velocity vectors per star group.

setProperMotionsMaxNumber

public void setProperMotionsMaxNumber(long maxNumber)

Description copied from interface: IScriptingInterface

Sets the maximum number of proper motion vectors to add per star group.

Specified by:

setProperMotionsMaxNumber in interface IScriptingInterface

Parameters:

maxNumber - The maximum number of proper motion vectors per star group.

setCrosshairVisibility

public void setCrosshairVisibility(boolean visible)

Description copied from interface: IScriptingInterface

Sets the visibility of all cross-hairs.

Specified by:

setCrosshairVisibility in interface IScriptingInterface

Parameters:

visible - The visibility state, which applies to all cross-hairs.

setFocusCrosshairVisibility

public void setFocusCrosshairVisibility(boolean visible)

Description copied from interface: IScriptingInterface

Sets the visibility of the focus object crosshair.

Specified by:

setFocusCrosshairVisibility in interface IScriptingInterface

Parameters:

visible - The visibility state.

setClosestCrosshairVisibility

public void setClosestCrosshairVisibility(boolean visible)

Description copied from interface: IScriptingInterface

Sets the visibility of the closest object crosshair.

Specified by:

setClosestCrosshairVisibility in interface IScriptingInterface

Parameters:

visible - The visibility state.

setHomeCrosshairVisibility

public void setHomeCrosshairVisibility(boolean visible)

Description copied from interface: IScriptingInterface

Sets the visibility of the home object crosshair.

Specified by:

setHomeCrosshairVisibility in interface IScriptingInterface

Parameters:

visible - The visibility state.

setMinimapVisibility

public void setMinimapVisibility(boolean visible)

Description copied from interface: IScriptingInterface

Shows or hides the minimap.

Specified by:

setMinimapVisibility in interface IScriptingInterface

Parameters:

visible - The visibility state.

setAmbientLight

public void setAmbientLight(float ambientLight)

Description copied from interface: IScriptingInterface

Sets the ambient light to a certain value.

Specified by:

setAmbientLight in interface IScriptingInterface

Parameters:

ambientLight - The value of the ambient light in [0,1].

setAmbientLight

public void setAmbientLight(int value)

setSimulationTime

public void setSimulationTime(int year,
 int month,
 int day,
 int hour,
 int min,
 int sec,
 int millisec)

Description copied from interface: IScriptingInterface

Sets the time of the application, in UTC.

Specified by:

setSimulationTime in interface IScriptingInterface

Parameters:

year - The year to represent.

month - The month-of-year to represent, from 1 (January) to 12 (December).

day - The day-of-month to represent, from 1 to 31.

hour - The hour-of-day to represent, from 0 to 23.

min - The minute-of-hour to represent, from 0 to 59.

sec - The second-of-minute to represent, from 0 to 59.

millisec - The millisecond-of-second, from 0 to 999.

getSimulationTime

public long getSimulationTime()

Description copied from interface: IScriptingInterface

Returns the current simulation time as the number of milliseconds since 1970-01-01T00:00:00Z (UTC).

Specified by:

getSimulationTime in interface IScriptingInterface

Returns:

Number of milliseconds since the epoch (Jan 1, 1970 00:00:00 UTC).

setSimulationTime

public void setSimulationTime(long time)

Description copied from interface: IScriptingInterface

Sets the time of the application. The long value represents specified number of milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.

Specified by:

setSimulationTime in interface IScriptingInterface

Parameters:

time - Number of milliseconds since the epoch (Jan 1, 1970).

getSimulationTimeArr

public int[] getSimulationTimeArr()

Description copied from interface: IScriptingInterface

Returns the current UTC simulation time in an array.

Specified by:

getSimulationTimeArr in interface IScriptingInterface

Returns:

The current simulation time in an array with the given indices.

• 0 - The year.
• 1 - The month, from 1 (January) to 12 (December).
• 2 - The day-of-month, from 1 to 31.
• 3 - The hour-of-day, from 0 to 23.
• 4 - The minute-of-hour, from 0 to 59.
• 5 - The second-of-minute, from 0 to 59.
• 6 - The millisecond-of-second, from 0 to 999.

startSimulationTime

public void startSimulationTime()

Description copied from interface: IScriptingInterface

Starts the simulation.

Specified by:

startSimulationTime in interface IScriptingInterface

stopSimulationTime

public void stopSimulationTime()

Description copied from interface: IScriptingInterface

Stops the simulation time.

Specified by:

stopSimulationTime in interface IScriptingInterface

isSimulationTimeOn

public boolean isSimulationTimeOn()

Description copied from interface: IScriptingInterface

Queries whether the time is on or not.

Specified by:

isSimulationTimeOn in interface IScriptingInterface

Returns:

True if the time is on, false otherwise.

setSimulationPace

public void setSimulationPace(double warp)

Description copied from interface: IScriptingInterface

Deprecated, use IScriptingInterface.setTimeWarp(double) instead.

Specified by:

setSimulationPace in interface IScriptingInterface

setSimulationPace

public void setSimulationPace(long warp)

setTimeWarp

public void setTimeWarp(double warp)

Description copied from interface: IScriptingInterface

Sets the simulation time warp factor.

Specified by:

setTimeWarp in interface IScriptingInterface

Parameters:

warp - The warp as a factor of real physical time pace. 2.0 sets the time to be twice as fast as real time.

setTimeWarp

public void setTimeWarp(long warp)

setTargetTime

public void setTargetTime(long ms)

Description copied from interface: IScriptingInterface

Sets a time bookmark in the global clock that, when reached, the clock automatically stops.

Specified by:

setTargetTime in interface IScriptingInterface

Parameters:

ms - The time as the number of milliseconds since the epoch (Jan 1, 1970).

setTargetTime

public void setTargetTime(int year,
 int month,
 int day,
 int hour,
 int min,
 int sec,
 int millisec)

Description copied from interface: IScriptingInterface

Sets a time bookmark in the global clock that, when reached, the clock automatically stops.

Specified by:

setTargetTime in interface IScriptingInterface

Parameters:

year - The year to represent.

month - The month-of-year to represent, from 1 (January) to 12 (December).

day - The day-of-month to represent, from 1 to 31.

hour - The hour-of-day to represent, from 0 to 23.

min - The minute-of-hour to represent, from 0 to 59.

sec - The second-of-minute to represent, from 0 to 59.

millisec - The millisecond-of-second, from 0 to 999.

unsetTargetTime

public void unsetTargetTime()

Description copied from interface: IScriptingInterface

Unsets the target time bookmark from the global clock, if any.

Specified by:

unsetTargetTime in interface IScriptingInterface

setStarBrightnessPower

public void setStarBrightnessPower(float power)

Description copied from interface: IScriptingInterface

Sets the star brightness power profile value. This allows for adjusting the shape of the curve: brightness = brightness^power. Default value is 0.6.

Specified by:

setStarBrightnessPower in interface IScriptingInterface

Parameters:

power - The power value.

setStarGlowFactor

public void setStarGlowFactor(float glowFactor)

Description copied from interface: IScriptingInterface

Sets the star glow factor level value. This controls the amount of glow light when the camera is close to stars. Must be between Constants.MIN_STAR_GLOW_FACTOR and Constants.MAX_STAR_GLOW_FACTOR. Default is 0.06.

Specified by:

setStarGlowFactor in interface IScriptingInterface

Parameters:

glowFactor - The new glow factor value.

getStarBrightness

public float getStarBrightness()

Description copied from interface: IScriptingInterface

Gets the star brightness value.

Specified by:

getStarBrightness in interface IScriptingInterface

Returns:

The brightness value, between 0 and 100.

setStarBrightness

public void setStarBrightness(float brightness)

Description copied from interface: IScriptingInterface

Sets the star brightness value.

Specified by:

setStarBrightness in interface IScriptingInterface

Parameters:

brightness - The brightness value, between 0 and 100.

setStarBrightness

public void setStarBrightness(int brightness)

getStarSize

public float getStarSize()

Description copied from interface: IScriptingInterface

Gets the current star size value in pixels.

Specified by:

getStarSize in interface IScriptingInterface

Returns:

The size value, in pixels.

setStarSize

public void setStarSize(float size)

Description copied from interface: IScriptingInterface

Sets the size of the rasterized stars, in pixels.

Specified by:

setStarSize in interface IScriptingInterface

Parameters:

size - The size value in pixels, between Constants.MIN_STAR_POINT_SIZE and Constants.MAX_STAR_POINT_SIZE.

setStarSize

public void setStarSize(int size)

getStarMinOpacity

public float getStarMinOpacity()

Description copied from interface: IScriptingInterface

Gets the minimum star opacity.

Specified by:

getStarMinOpacity in interface IScriptingInterface

Returns:

The minimum opacity value.

setStarMinOpacity

public void setStarMinOpacity(float minOpacity)

Description copied from interface: IScriptingInterface

Sets the minimum star opacity.

Specified by:

setStarMinOpacity in interface IScriptingInterface

Parameters:

minOpacity - The minimum opacity value, between Constants.MIN_STAR_MIN_OPACITY and Constants.MAX_STAR_MIN_OPACITY.

getMinStarOpacity

public float getMinStarOpacity()

setMinStarOpacity

public void setMinStarOpacity(float minOpacity)

setMinStarOpacity

public void setMinStarOpacity(int opacity)

setStarTextureIndex

public void setStarTextureIndex(int index)

Description copied from interface: IScriptingInterface

Sets the star texture index, in [1, 4]

1 - horizontal spike 2 - god rays 3 - horizontal and vertical spikes 4 - simple radial profile

Specified by:

setStarTextureIndex in interface IScriptingInterface

Parameters:

index - The new star texture index

setStarGroupNearestNumber

public void setStarGroupNearestNumber(int n)

Description copied from interface: IScriptingInterface

Sets the number of nearest stars to be processed for each star group. This will limit the number of stars that are rendered with billboards, labels and velocity vectors.

Specified by:

setStarGroupNearestNumber in interface IScriptingInterface

Parameters:

n - The new number of nearest stars

setStarGroupBillboard

public void setStarGroupBillboard(boolean flag)

Description copied from interface: IScriptingInterface

Enable or disable the rendering of close stars as billboards.

Specified by:

setStarGroupBillboard in interface IScriptingInterface

Parameters:

flag - The state flag

setOrbitSolidAngleThreshold

public void setOrbitSolidAngleThreshold(float angleDeg)

Description copied from interface: IScriptingInterface

Sets the solid angle below which orbits fade and disappear.

Specified by:

setOrbitSolidAngleThreshold in interface IScriptingInterface

Parameters:

angleDeg - The threshold angle in degrees

setProjectionYaw

public void setProjectionYaw(float yaw)

Description copied from interface: IScriptingInterface

Sets the projection yaw angle (if this is a slave instance), in degrees. The yaw angle turns the camera to the right. This function is intended for multi-projector setups, to configure slaves without restarting Gaia Sky.

Specified by:

setProjectionYaw in interface IScriptingInterface

Parameters:

yaw - The yaw angle in degrees.

setProjectionPitch

public void setProjectionPitch(float pitch)

Description copied from interface: IScriptingInterface

Sets the projection pitch angle (if this is a slave instance), in degrees. The pitch angle turns the camera up. This function is intended for multi-projector setups, to configure slaves without restarting Gaia Sky.

Specified by:

setProjectionPitch in interface IScriptingInterface

Parameters:

pitch - The pitch angle in degrees.

setProjectionRoll

public void setProjectionRoll(float roll)

Description copied from interface: IScriptingInterface

Sets the projection roll angle (if this is a slave instance), in degrees. The roll angle rolls the camera clockwise. This function is intended for multi-projector setups, to configure slaves without restarting Gaia Sky.

Specified by:

setProjectionRoll in interface IScriptingInterface

Parameters:

roll - The roll angle in degrees.

setProjectionFov

public void setProjectionFov(float newFov)

Description copied from interface: IScriptingInterface

Same as IScriptingInterface.setFov(float), but bypassing the restriction of an active projection in the slave (slaves that have an active projection do not accept fov modification events).

Specified by:

setProjectionFov in interface IScriptingInterface

Parameters:

newFov - The field of view angle.

setLimitFps

public void setLimitFps(double limitFps)

Description copied from interface: IScriptingInterface

Limits the frame rate of Gaia Sky.

Specified by:

setLimitFps in interface IScriptingInterface

Parameters:

limitFps - The new maximum frame rate as a double-precision floating point number. Set zero or negative to unlimited.

setLimitFps

public void setLimitFps(int limitFps)

Description copied from interface: IScriptingInterface

Limits the frame rate of Gaia Sky.

Specified by:

setLimitFps in interface IScriptingInterface

Parameters:

limitFps - The new maximum frame rate as an integer number. Set zero or negative to unlimited.

configureScreenshots

public void configureScreenshots(int width,
 int height,
 String directory,
 String namePrefix)

Description copied from interface: IScriptingInterface

Configures the screenshot system, setting the resolution of the images, the output directory and the image name prefix.

Specified by:

configureScreenshots in interface IScriptingInterface

Parameters:

width - Width of images.

height - Height of images.

directory - The output directory path.

namePrefix - The file name prefix.

setScreenshotsMode

public void setScreenshotsMode(String screenshotMode)

Description copied from interface: IScriptingInterface

Sets the screenshot mode. Possible values are 'simple' and 'advanced'. The simple mode is faster and just outputs the last frame rendered to the Gaia Sky window, with the same resolution and containing the UI elements. The advanced mode redraws the last frame using the resolution configured using IScriptingInterface.configureScreenshots(int, int, String, String) and it does not draw the UI.

Specified by:

setScreenshotsMode in interface IScriptingInterface

Parameters:

screenshotMode - The screenshot mode. 'simple' or 'advanced'.

saveScreenshot

public void saveScreenshot()

Description copied from interface: IScriptingInterface

Takes a screenshot of the current frame and saves it to the configured location (see IScriptingInterface.configureScreenshots(int, int, String, String)).

Specified by:

saveScreenshot in interface IScriptingInterface

takeScreenshot

public void takeScreenshot()

Description copied from interface: IScriptingInterface

Alias to IScriptingInterface.saveScreenshot().

Specified by:

takeScreenshot in interface IScriptingInterface

configureFrameOutput

public void configureFrameOutput(int width,
 int height,
 int fps,
 String directory,
 String namePrefix)

Description copied from interface: IScriptingInterface

Configures the frame output system, setting the resolution of the images, the target frames per second, the output directory and the image name prefix. This function sets the frame output mode to 'advanced'.

Specified by:

configureFrameOutput in interface IScriptingInterface

Parameters:

width - Width of images.

height - Height of images.

fps - Target frames per second (number of images per second).

directory - The output directory path.

namePrefix - The file name prefix.

configureFrameOutput

public void configureFrameOutput(int width,
 int height,
 double fps,
 String directory,
 String namePrefix)

Description copied from interface: IScriptingInterface

Configures the frame output system, setting the resolution of the images, the target frames per second, the output directory and the image name prefix. This function sets the frame output mode to 'advanced'.

Specified by:

configureFrameOutput in interface IScriptingInterface

Parameters:

width - Width of images.

height - Height of images.

fps - Target frames per second (number of images per second).

directory - The output directory path.

namePrefix - The file name prefix.

configureRenderOutput

public void configureRenderOutput(int width,
 int height,
 int fps,
 String directory,
 String namePrefix)

Description copied from interface: IScriptingInterface

Configures the frame output system, setting the resolution of the images, the target frames per second, the output directory and the image name prefix.

Specified by:

configureRenderOutput in interface IScriptingInterface

Parameters:

width - Width of images.

height - Height of images.

fps - Target frames per second (number of images per second).

directory - The output directory path.

namePrefix - The file name prefix.

setFrameOutputMode

public void setFrameOutputMode(String screenshotMode)

Description copied from interface: IScriptingInterface

Sets the frame output mode. Possible values are 'simple' and 'advanced'. The simple mode is faster and just outputs the last frame rendered to the Gaia Sky window, with the same resolution and containing the UI elements. The advanced mode redraws the last frame using the resolution configured using IScriptingInterface.configureFrameOutput(int, int, int, String, String) and it does not draw the UI.

Specified by:

setFrameOutputMode in interface IScriptingInterface

Parameters:

screenshotMode - The screenshot mode. 'simple' or 'advanced'.

isFrameOutputActive

public boolean isFrameOutputActive()

Description copied from interface: IScriptingInterface

Is the frame output system on?

Specified by:

isFrameOutputActive in interface IScriptingInterface

Returns:

True if the render output is active.

isRenderOutputActive

public boolean isRenderOutputActive()

Description copied from interface: IScriptingInterface

Is the frame output system on?

Specified by:

isRenderOutputActive in interface IScriptingInterface

Returns:

True if the frame output is active.

getFrameOutputFps

public double getFrameOutputFps()

Description copied from interface: IScriptingInterface

Gets the current FPS setting in the frame output system.

Specified by:

getFrameOutputFps in interface IScriptingInterface

Returns:

The FPS setting.

getRenderOutputFps

public double getRenderOutputFps()

Description copied from interface: IScriptingInterface

Gets the current FPS setting in the frame output system.

Specified by:

getRenderOutputFps in interface IScriptingInterface

Returns:

The FPS setting.

setFrameOutput

public void setFrameOutput(boolean active)

Description copied from interface: IScriptingInterface

Activates or deactivates the image output system. If called with true, the system starts outputting images right away.

Specified by:

setFrameOutput in interface IScriptingInterface

Parameters:

active - Whether to activate or deactivate the frame output system.

getObject

public FocusView getObject(String name)

Description copied from interface: IScriptingInterface

Gets an object from the scene graph by name or id (HIP, TYC, Gaia SourceId).

Specified by:

getObject in interface IScriptingInterface

Parameters:

name - The name or id (HIP, TYC, Gaia SourceId) of the object.

Returns:

The object as a FocusView, or null if it does not exist.

getObject

public FocusView getObject(String name,
 double timeOutSeconds)

Description copied from interface: IScriptingInterface

Gets an object by name or id (HIP, TYC, Gaia SourceID), optionally waiting until the object is available, with a timeout.

Specified by:

getObject in interface IScriptingInterface

Parameters:

name - The name or id (HIP, TYC, Gaia SourceId) of the object.

timeOutSeconds - The timeout in seconds to wait until returning. If negative, it waits indefinitely.

Returns:

The object if it exists, or null if it does not and block is false, or if block is true and the timeout has passed.

getLineObject

public VertsView getLineObject(String name)

Description copied from interface: IScriptingInterface

Gets a Verts object from the scene by name.

Specified by:

getLineObject in interface IScriptingInterface

Parameters:

name - The name of the line object.

Returns:

The line object as a VertsView, or null if it does not exist.

getLineObject

public VertsView getLineObject(String name,
 double timeOutSeconds)

Description copied from interface: IScriptingInterface

Gets a Verts object from the scene by name.

Specified by:

getLineObject in interface IScriptingInterface

Parameters:

name - The name of the line object.

timeOutSeconds - The timeout in seconds to wait until returning. If negative, it waits indefinitely.

Returns:

The line object as a VertsView, or null if it does not exist.

getEntity

public com.badlogic.ashley.core.Entity getEntity(String name)

getEntity

public com.badlogic.ashley.core.Entity getEntity(String name,
 double timeOutSeconds)

setObjectSizeScaling

public void setObjectSizeScaling(String name,
 double scalingFactor)

Description copied from interface: IScriptingInterface

Sets the given size scaling factor to the object identified by name. This method will only work with model objects such as planets, asteroids, satellites, etc. It will not work with orbits, stars or any other types.

Also, use this with caution, as scaling the size of objects can have unintended side effects, and remember to set the scaling back to 1.0 at the end of your script.

Specified by:

setObjectSizeScaling in interface IScriptingInterface

Parameters:

name - The name or id of the object.

scalingFactor - The scaling factor to scale the size of that object.

setObjectSizeScaling

public void setObjectSizeScaling(com.badlogic.ashley.core.Entity object,
 double scalingFactor)

setOrbitCoordinatesScaling

public void setOrbitCoordinatesScaling(String name,
 double scalingFactor)

Description copied from interface: IScriptingInterface

Sets the given orbit coordinates scaling factor to the AbstractOrbitCoordinates identified by name. See AbstractOrbitCoordinates and its subclasses.

Also, use this with caution, as scaling coordinates may have unintended side effects, and remember to set the scaling back to 1.0 at the end of your script. Additionally, use either IScriptingInterface.refreshAllOrbits() or IScriptingInterface.refreshObjectOrbit(String) right after this call in order to immediately refresh the scaled orbits.

Specified by:

setOrbitCoordinatesScaling in interface IScriptingInterface

Parameters:

name - The name of the coordinates object (OrbitLintCoordinates, EclipticCoordinates, SaturnVSOP87, UranusVSOP87, EarthVSOP87, MercuryVSOP87, ..., PlutoCoordinates, HeliotropicOribtCoordinates, MoonAACoordinates). Optionally, you can append ':objectName' to select a single object. For instance, both Gaia and JWST have heliotropic orbit coordinates. To only select the Gaia orbit provider, use "HeliotropicOrbitCoordinates:Gaia".

scalingFactor - The scaling factor.

refreshAllOrbits

public void refreshAllOrbits()

Description copied from interface: IScriptingInterface

Forces all orbits to refresh immediately.

Specified by:

refreshAllOrbits in interface IScriptingInterface

forceUpdateScene

public void forceUpdateScene()

Description copied from interface: IScriptingInterface

Forcefully triggers an update of the scene and the positions of all the objects. Useful to call after operations that modify the position of objects.

Specified by:

forceUpdateScene in interface IScriptingInterface

refreshObjectOrbit

public void refreshObjectOrbit(String name)

Description copied from interface: IScriptingInterface

Forces the refresh of the orbit of the object identified by name. This should generally be called after a call to IScriptingInterface.setOrbitCoordinatesScaling(String, double).

Specified by:

refreshObjectOrbit in interface IScriptingInterface

getObjectRadius

public double getObjectRadius(String name)

Description copied from interface: IScriptingInterface

Gets the size of the object identified by name, in Km, by name or id (HIP, TYC, sourceId).

Specified by:

getObjectRadius in interface IScriptingInterface

Parameters:

name - The name or id (HIP, TYC, sourceId) of the object.

Returns:

The radius of the object in Km. If the object identifed by name or id (HIP, TYC, sourceId). does not exist, it returns a negative value.

goToObject

public void goToObject(String name)

Description copied from interface: IScriptingInterface

Runs a seamless trip to the object with the name focusName until the object view angle is 20 degrees.

Specified by:

goToObject in interface IScriptingInterface

Parameters:

name - The name or id (HIP, TYC, sourceId) of the object.

goToObject

public void goToObject(String name,
 double angle)

Description copied from interface: IScriptingInterface

Runs a seamless trip to the object with the name focusName until the object view angle viewAngle is met. If angle is negative, the default angle is 20 degrees.

Specified by:

goToObject in interface IScriptingInterface

Parameters:

name - The name or id (HIP, TYC, sourceId) of the object.

angle - The target solid angle of the object, in degrees. The angle gets larger and larger as we approach the object.

goToObject

public void goToObject(String name,
 double solidAngle,
 float waitTimeSeconds)

Description copied from interface: IScriptingInterface

Runs a seamless trip to the object with the name focusName until the object view angle viewAngle is met. If angle is negative, the default angle is 20 degrees. If waitTimeSeconds is positive, it indicates the number of seconds to wait (block the function) for the camera to face the focus before starting the forward movement. This very much depends on the turn velocity of the camera. See IScriptingInterface.setTurningCameraSpeed(float).

Specified by:

goToObject in interface IScriptingInterface

Parameters:

name - The name or id (HIP, TYC, sourceId) of the object.

solidAngle - The target solid angle of the object, in degrees. The angle gets larger and larger as we approach the object.

waitTimeSeconds - The seconds to wait for the camera direction vector and the vector from the camera position to the target object to be aligned.

goToObject

public void goToObject(String name,
 double solidAngle,
 int waitTimeSeconds)

goToObject

public void goToObject(String name,
 long solidAngle,
 int waitTimeSeconds)

goToObject

public void goToObject(String name,
 long solidAngle,
 float waitTimeSeconds)

goToObject

public void goToObject(String name,
 double solidAngle,
 int waitTimeSeconds,
 AtomicBoolean stop)

goToObject

public void goToObject(com.badlogic.ashley.core.Entity object,
 double solidAngle,
 int waitTimeSeconds,
 AtomicBoolean stop)

goToObjectInstant

public void goToObjectInstant(String name)

Description copied from interface: IScriptingInterface

Sets the camera in focus mode with the given focus object and instantly moves the camera next to the focus object.

Specified by:

goToObjectInstant in interface IScriptingInterface

Parameters:

name - The name of the new focus object.

landOnObject

public void landOnObject(String name)

Description copied from interface: IScriptingInterface

Lands on the object with the given name, if it is a planet or moon. The land location is determined by the line of sight from the current position of the camera to the object.

Specified by:

landOnObject in interface IScriptingInterface

Parameters:

name - The proper name of the object.

landAtObjectLocation

public void landAtObjectLocation(String name,
 String locationName)

Description copied from interface: IScriptingInterface

Lands on the object with the given name, if it is a planet or moon, at the location with the given name, if it exists.

Specified by:

landAtObjectLocation in interface IScriptingInterface

Parameters:

name - The proper name of the object.

locationName - The name of the location to land on

landAtObjectLocation

public void landAtObjectLocation(String name,
 String locationName,
 AtomicBoolean stop)

landAtObjectLocation

public void landAtObjectLocation(com.badlogic.ashley.core.Entity object,
 String locationName,
 AtomicBoolean stop)

landAtObjectLocation

public void landAtObjectLocation(String name,
 double longitude,
 double latitude)

Description copied from interface: IScriptingInterface

Lands on the object with the given name, if it is a planet or moon, at the location specified in by [latitude, longitude], in degrees.

Specified by:

landAtObjectLocation in interface IScriptingInterface

Parameters:

name - The proper name of the object.

longitude - The location longitude, in degrees.

latitude - The location latitude, in degrees.

getDistanceTo

public double getDistanceTo(String name)

Description copied from interface: IScriptingInterface

Returns the distance to the surface of the object identified with the given name. If the object is an abstract node or does not exist, it returns a negative distance.

Specified by:

getDistanceTo in interface IScriptingInterface

Parameters:

name - The name or id (HIP, TYC, sourceId) of the object.

Returns:

The distance to the object in km if it exists, a negative value otherwise.

getStarParameters

public double[] getStarParameters(String id)

Description copied from interface: IScriptingInterface

Returns the star parameters given its identifier or name, if the star exists and it is loaded.

Specified by:

getStarParameters in interface IScriptingInterface

Parameters:

id - The star identifier or name.

Returns:

An array with (ra [deg], dec [deg], parallax [mas], pmra [mas/yr], pmdec [mas/yr], radvel [km/s], appmag [mag], red [0,1], green [0,1], blue [0,1]) if the star exists and is loaded, null otherwise.

getObjectPosition

public double[] getObjectPosition(String name)

Description copied from interface: IScriptingInterface

Gets the current position of the object identified by name in the internal coordinate system and internal units. If the object does not exist, it returns null.

Specified by:

getObjectPosition in interface IScriptingInterface

Parameters:

name - The name or id (HIP, TYC, sourceId) of the object.

Returns:

A 3-vector with the object's position in internal units and the internal reference system.

getObjectPosition

public double[] getObjectPosition(String name,
 String units)

Description copied from interface: IScriptingInterface

Gets the current position of the object identified by name in the internal coordinate system and the requested distance units. If the object does not exist, it returns null.

Specified by:

getObjectPosition in interface IScriptingInterface

Parameters:

name - The name or id (HIP, TYC, sourceId) of the object.

units - The distance units to use. One of "m", "km", "au", "ly", "pc", "internal".

Returns:

A 3-vector with the object's position in the requested units and internal reference system.

getObjectPredictedPosition

public double[] getObjectPredictedPosition(String name)

Description copied from interface: IScriptingInterface

Gets the predicted position of the object identified by name in the internal coordinate system and internal units. If the object does not exist, it returns null. The predicted position is the position of the object in the next update cycle, and may be useful to compute the camera state.

Specified by:

getObjectPredictedPosition in interface IScriptingInterface

Parameters:

name - The name or id (HIP, TYC, sourceId) of the object.

Returns:

A 3-vector with the object's predicted position in the internal reference system.

getObjectPredictedPosition

public double[] getObjectPredictedPosition(String name,
 String units)

Description copied from interface: IScriptingInterface

Gets the predicted position of the object identified by name in the internal coordinate system and the requested distance units. If the object does not exist, it returns null. The predicted position is the position of the object in the next update cycle, and may be useful to compute the camera state.

Specified by:

getObjectPredictedPosition in interface IScriptingInterface

Parameters:

name - The name or id (HIP, TYC, sourceId) of the object.

units - The distance units to use. One of "m", "km", "au", "ly", "pc", "internal".

Returns:

A 3-vector with the object's predicted position in the requested units and in the internal reference system.

setObjectPosition

public void setObjectPosition(String name,
 double[] position)

Description copied from interface: IScriptingInterface

Sets the internal position of the object identified by name. Note that depending on the object type, the position may be already calculated and set elsewhere in the update stage, so use with care.

Specified by:

setObjectPosition in interface IScriptingInterface

Parameters:

name - The name of the object.

position - The position in the internal reference system and internal units.

setObjectPosition

public void setObjectPosition(String name,
 double[] position,
 String units)

Description copied from interface: IScriptingInterface

Sets the internal position of the object identified by name. Note that depending on the object type, the position may be already calculated and set elsewhere in the update stage, so use with care.

Specified by:

setObjectPosition in interface IScriptingInterface

Parameters:

name - The name of the object.

position - The position in the internal reference system and the given units.

units - The distance units to use. One of "m", "km", "au", "ly", "pc", "internal".

setObjectPosition

public void setObjectPosition(String name,
 List<?> position)

setObjectPosition

public void setObjectPosition(String name,
 List<?> position,
 String units)

setObjectPosition

public void setObjectPosition(FocusView object,
 double[] position)

Description copied from interface: IScriptingInterface

Sets the internal position of the given entity object. Note that depending on the object type, the position may be already calculated and set elsewhere in the update stage, so use with care.

Specified by:

setObjectPosition in interface IScriptingInterface

Parameters:

object - The object in a focus view wrapper.

position - The position in the internal reference system and internal units.

setObjectPosition

public void setObjectPosition(FocusView object,
 double[] position,
 String units)

Description copied from interface: IScriptingInterface

Sets the internal position of the given entity object. Note that depending on the object type, the position may be already calculated and set elsewhere in the update stage, so use with care.

Specified by:

setObjectPosition in interface IScriptingInterface

Parameters:

object - The object in a focus view wrapper.

position - The position in the internal reference system and the given units.

units - The distance units to use. One of "m", "km", "au", "ly", "pc", "internal".

setObjectPosition

public void setObjectPosition(FocusView object,
 List<?> position)

setObjectPosition

public void setObjectPosition(FocusView object,
 List<?> position,
 String units)

setObjectPosition

public void setObjectPosition(com.badlogic.ashley.core.Entity object,
 double[] position)

Description copied from interface: IScriptingInterface

Sets the internal position of the given entity object. Note that depending on the object type, the position may be already calculated and set elsewhere in the update stage, so use with care.

Specified by:

setObjectPosition in interface IScriptingInterface

Parameters:

object - The object entity.

position - The position in the internal reference system and internal units.

setObjectPosition

public void setObjectPosition(com.badlogic.ashley.core.Entity object,
 double[] position,
 String units)

Description copied from interface: IScriptingInterface

Sets the internal position of the given entity object. Note that depending on the object type, the position may be already calculated and set elsewhere in the update stage, so use with care.

Specified by:

setObjectPosition in interface IScriptingInterface

Parameters:

object - The object entity.

position - The position in the internal reference system and the given units.

units - The distance units to use. One of "m", "km", "au", "ly", "pc", "internal".

setObjectCoordinatesProvider

public void setObjectCoordinatesProvider(String name,
 IPythonCoordinatesProvider provider)

Description copied from interface: IScriptingInterface

Sets the coordinates provider for the object identified with the given name, if possible. The provider object must implement IPythonCoordinatesProvider, and in particular the method IPythonCoordinatesProvider.getEquatorialCartesianCoordinates(Object, Object), which takes in a julian date and outputs the object coordinates in the internal cartesian system.

Specified by:

setObjectCoordinatesProvider in interface IScriptingInterface

Parameters:

name - The name of the object.

provider - The coordinate provider instance.

removeObjectCoordinatesProvider

public void removeObjectCoordinatesProvider(String name)

Description copied from interface: IScriptingInterface

Removes the current coordinates provider from the object with the given name. This method must be called before shutting down the gateway if the coordinates provider has been previously set for the given object from Python with IScriptingInterface.setObjectCoordinatesProvider(String, IPythonCoordinatesProvider). Otherwise, Gaia Sky will crash due to the missing connection to Python.

Specified by:

removeObjectCoordinatesProvider in interface IScriptingInterface

Parameters:

name - The name of the object for which to remove the coordinate provider.

setObjectPosition

public void setObjectPosition(com.badlogic.ashley.core.Entity object,
 List<?> position)

setGuiScrollPosition

public void setGuiScrollPosition(float pixelY)

Description copied from interface: IScriptingInterface

Sets the vertical scroll position in the GUI.

Specified by:

setGuiScrollPosition in interface IScriptingInterface

Parameters:

pixelY - The pixel to set the scroll position to.

setGuiScrollPosition

public void setGuiScrollPosition(int pixelY)

enableGui

public void enableGui()

Description copied from interface: IScriptingInterface

Enables the GUI rendering. This makes the user interface to be rendered and updated again if it was previously disabled. Otherwise, it has no effect.

Specified by:

enableGui in interface IScriptingInterface

disableGui

public void disableGui()

Description copied from interface: IScriptingInterface

Disables the GUI rendering. This causes the user interface to no longer be rendered or updated.

Specified by:

disableGui in interface IScriptingInterface

getGuiScaleFactor

public float getGuiScaleFactor()

Description copied from interface: IScriptingInterface

Gets the current scale factor applied to the UI.

Specified by:

getGuiScaleFactor in interface IScriptingInterface

Returns:

The scale factor.

displayMessageObject

public void displayMessageObject(int id,
 String message,
 float x,
 float y,
 float r,
 float g,
 float b,
 float a,
 float fontSize)

Description copied from interface: IScriptingInterface

Adds a new one-line message in the screen with the given id and the given coordinates. If an object already exists with the given id, it is removed. However, if a message object already exists with the same id, its properties are updated. The messages placed with this method will not appear in the screenshots/frames in advanced mode. This is intended for running interactively only.

Specified by:

displayMessageObject in interface IScriptingInterface

Parameters:

id - A unique identifier, used to identify this message when you want to remove it.

message - The string message, to be displayed in one line. But explicit newline breaks the line.

x - The x coordinate of the bottom-left corner, in [0,1] from left to right. This is not resolution-dependant.

y - The y coordinate of the bottom-left corner, in [0,1] from bottom to top. This is not resolution-dependant.

r - The red component of the color in [0,1].

g - The green component of the color in [0,1].

b - The blue component of the color in [0,1].

a - The alpha component of the color in [0,1].

fontSize - The size of the font. The system will use the existing font closest to the chosen size and scale it up or down to match the desired size. Scaling can cause artifacts, so to ensure the best font quality, stick to the existing sizes.

displayMessageObject

public void displayMessageObject(int id,
 String message,
 double x,
 double y,
 double[] color,
 double fontSize)

Description copied from interface: IScriptingInterface

Same as IScriptingInterface.displayImageObject(int, String, float, float, float, float, float, float) but using an array for the color instead of giving each component separately.

Specified by:

displayMessageObject in interface IScriptingInterface

Parameters:

id - A unique identifier, used to identify this message when you want to remove it.

message - The string message, to be displayed in one line. But explicit newline breaks the line.

x - The x coordinate of the bottom-left corner, in [0,1] from left to right. This is not resolution-dependant.

y - The y coordinate of the bottom-left corner, in [0,1] from bottom to top. This is not resolution-dependant.

color - The color as an array of RGBA (red, green, blue, alpha) values in [0,1].

fontSize - The size of the font. The system will use the existing font closest to the chosen size and scale it up or down to match the desired size. Scaling can cause artifacts, so to ensure the best font quality, stick to the existing sizes.

displayMessageObject

public void displayMessageObject(int id,
 String message,
 double x,
 double y,
 List<?> color,
 double fontSize)

displayMessageObject

public void displayMessageObject(int id,
 String message,
 float x,
 float y,
 float r,
 float g,
 float b,
 float a,
 int fontSize)

displayTextObject

public void displayTextObject(int id,
 String text,
 float x,
 float y,
 float maxWidth,
 float maxHeight,
 float r,
 float g,
 float b,
 float a,
 float fontSize)

Description copied from interface: IScriptingInterface

Adds a new multi-line text in the screen with the given id, coordinates and size. If an object already exists with the given id, it is removed. However, if a text object already exists with the same id, its properties are updated. The texts placed with this method will not appear in the screenshots/frames in advanced mode. This is intended for running interactively only.

Specified by:

displayTextObject in interface IScriptingInterface

Parameters:

id - A unique identifier, used to identify this message when you want to remove it.

text - The string message, to be displayed line-wrapped in the box defined by maxWidth and maxHeight. Explicit newline still breaks the line.

x - The x coordinate of the bottom-left corner, in [0,1] from left to right. This is not resolution-dependant.

y - The y coordinate of the bottom-left corner, in [0,1] from bottom to top. This is not resolution-dependant.

maxWidth - The maximum width in screen percentage [0,1]. Set to 0 to let the system decide.

maxHeight - The maximum height in screen percentage [0,1]. Set to 0 to let the system decide.

r - The red component of the color in [0,1].

g - The green component of the color in [0,1].

b - The blue component of the color in [0,1].

a - The alpha component of the color in [0,1].

fontSize - The size of the font. The system will use the existing font closest to the chosen size.

displayTextObject

public void displayTextObject(int id,
 String text,
 float x,
 float y,
 float maxWidth,
 float maxHeight,
 float r,
 float g,
 float b,
 float a,
 int fontSize)

displayImageObject

public void displayImageObject(int id,
 String path,
 float x,
 float y,
 float r,
 float g,
 float b,
 float a)

Description copied from interface: IScriptingInterface

Adds a new image object at the given coordinates. If an object already exists with the given id, it is removed. However, if an image object already exists with the same id, its properties are updated.
Warning: This method will only work in the asynchronous mode. Run the script with the "asynchronous" check box activated!

Specified by:

displayImageObject in interface IScriptingInterface

Parameters:

id - A unique identifier, used to identify this message when you want to remove it.

path - The path to the image. It can either be an absolute path (not recommended) or a path relative to the Gaia Sky work directory.

x - The x coordinate of the bottom-left corner, in [0,1] from left to right. This is not resolution-dependant.

y - The y coordinate of the bottom-left corner, in [0,1] from bottom to top. This is not resolution-dependant.

r - The red component of the color in [0,1].

g - The green component of the color in [0,1].

b - The blue component of the color in [0,1].

a - The alpha component of the color in [0,1].

displayImageObject

public void displayImageObject(int id,
 String path,
 double x,
 double y,
 double[] color)

Description copied from interface: IScriptingInterface

Same as IScriptingInterface.displayImageObject(int, String, float, float, float, float, float, float) but using a double array for the color instead of each component separately.

Specified by:

displayImageObject in interface IScriptingInterface

Parameters:

id - A unique identifier, used to identify this message when you want to remove it.

path - The path to the image. It can either be an absolute path (not recommended) or a path relative to the Gaia Sky work directory.

x - The x coordinate of the bottom-left corner, in [0,1] from left to right. This is not resolution-dependant.

y - The y coordinate of the bottom-left corner, in [0,1] from bottom to top. This is not resolution-dependant.

color - The color as an array of RGBA (red, green, blue, alpha) values in [0,1].

displayImageObject

public void displayImageObject(int id,
 String path,
 double x,
 double y,
 List<?> color)

displayImageObject

public void displayImageObject(int id,
 String path,
 float x,
 float y)

Description copied from interface: IScriptingInterface

Adds a new image object at the given coordinates. If an object already exists with the given id, it is removed. However, if an image object already exists with the same id, its properties are updated.
The messages placed with this method will not appear in the screenshots/frames in advanced mode. This is intended for running interactively only.

Specified by:

displayImageObject in interface IScriptingInterface

Parameters:

id - A unique identifier, used to identify this message when you want to remove it.

path - The path to the image. It can either be an absolute path (not recommended) or a path relative to the Gaia Sky work directory.

x - The x coordinate of the bottom-left corner, in [0,1] from left to right. This is not resolution-dependant.

y - The y coordinate of the bottom-left corner, in [0,1] from bottom to top. This is not resolution-dependant.

removeAllObjects

public void removeAllObjects()

Description copied from interface: IScriptingInterface

Removes all objects.

Specified by:

removeAllObjects in interface IScriptingInterface

removeObject

public void removeObject(int id)

Description copied from interface: IScriptingInterface

Removes the item with the given id.

Specified by:

removeObject in interface IScriptingInterface

Parameters:

id - Integer with the integer id of the object to remove.

removeObjects

public void removeObjects(int[] ids)

Description copied from interface: IScriptingInterface

Removes the items with the given ids. They can either messages, images or whatever else.

Specified by:

removeObjects in interface IScriptingInterface

Parameters:

ids - Vector with the integer ids of the objects to remove

removeObjects

public void removeObjects(List<?> ids)

maximizeInterfaceWindow

public void maximizeInterfaceWindow()

Description copied from interface: IScriptingInterface

Maximizes the interface window.

Specified by:

maximizeInterfaceWindow in interface IScriptingInterface

minimizeInterfaceWindow

public void minimizeInterfaceWindow()

Description copied from interface: IScriptingInterface

Minimizes the interface window.

Specified by:

minimizeInterfaceWindow in interface IScriptingInterface

setGuiPosition

public void setGuiPosition(float x,
 float y)

Description copied from interface: IScriptingInterface

Moves the interface window to a new position.

Specified by:

setGuiPosition in interface IScriptingInterface

Parameters:

x - The new x coordinate of the new top-left corner of the window, in [0,1] from left to right.

y - The new y coordinate of the new top-left corner of the window, in [0,1] from bottom to top.

setGuiPosition

public void setGuiPosition(int x,
 int y)

setGuiPosition

public void setGuiPosition(float x,
 int y)

setGuiPosition

public void setGuiPosition(int x,
 float y)

waitForInput

public void waitForInput()

Description copied from interface: IScriptingInterface

Blocks the execution until any kind of input (keyboard, mouse, etc.) is received.

Specified by:

waitForInput in interface IScriptingInterface

waitForEnter

public void waitForEnter()

Description copied from interface: IScriptingInterface

Blocks the execution until the Enter key is pressed.

Specified by:

waitForEnter in interface IScriptingInterface

waitForInput

public void waitForInput(int keyCode)

Description copied from interface: IScriptingInterface

Blocks the execution until the given key or button is pressed.

Specified by:

waitForInput in interface IScriptingInterface

Parameters:

keyCode - The key or button code. Please see Input.

getScreenWidth

public int getScreenWidth()

Description copied from interface: IScriptingInterface

Returns the screen width in pixels.

Specified by:

getScreenWidth in interface IScriptingInterface

Returns:

The screen width in pixels.

getScreenHeight

public int getScreenHeight()

Description copied from interface: IScriptingInterface

Returns the screen height in pixels.

Specified by:

getScreenHeight in interface IScriptingInterface

Returns:

The screen height in pixels.

getPositionAndSizeGui

public float[] getPositionAndSizeGui(String name)

Description copied from interface: IScriptingInterface

Returns the size and position of the GUI element that goes by the given name or null if such element does not exist. Warning> This will only work in asynchronous mode.

Specified by:

getPositionAndSizeGui in interface IScriptingInterface

Parameters:

name - The name of the gui element.

Returns:

A vector of floats with the position (0, 1) of the bottom left corner in pixels from the bottom-left of the screen and the size (2, 3) in pixels of the element.

expandGuiComponent

public void expandGuiComponent(String name)

Description copied from interface: IScriptingInterface

Expands the component with the given name.

Specified by:

expandGuiComponent in interface IScriptingInterface

Parameters:

name - The name, as in `CameraComponent` or `ObjectsComponent`

collapseGuiComponent

public void collapseGuiComponent(String name)

Description copied from interface: IScriptingInterface

Collapses the component with the given name.

Specified by:

collapseGuiComponent in interface IScriptingInterface

Parameters:

name - The name, as in `CameraComponent` or `ObjectsComponent`

getVersionNumber

public String getVersionNumber()

Description copied from interface: IScriptingInterface

Returns the version number string.

Specified by:

getVersionNumber in interface IScriptingInterface

Returns:

The version number string.

waitFocus

public boolean waitFocus(String name,
 long timeoutMs)

Description copied from interface: IScriptingInterface

Blocks the script until the focus is the object indicated by the name. There is an optional time out.

Specified by:

waitFocus in interface IScriptingInterface

Parameters:

name - The name of the focus to wait for.

timeoutMs - Timeout in ms to wait. Set negative to disable timeout.

Returns:

True if the timeout ran out. False otherwise.

setCameraRecorderFps

public void setCameraRecorderFps(double targetFps)

Description copied from interface: IScriptingInterface

Sets the target frame rate of the camera recorder. This will cap the frame rate of Gaia Sky to this value while the camera is recording. When playing the camera file back, you are responsible to set the right frame rate.

Specified by:

setCameraRecorderFps in interface IScriptingInterface

Parameters:

targetFps - The target frame rate for the camera recorder.

preloadTexture

public void preloadTexture(String path)

Description copied from interface: IScriptingInterface

Pre-loads the given image as a texture for later use. The texture will be cached for later use.

Specified by:

preloadTexture in interface IScriptingInterface

Parameters:

path - The path of the image file to preload.

getAssetsLocation

public String getAssetsLocation()

Description copied from interface: IScriptingInterface

Gets the location of the assets folder.

Specified by:

getAssetsLocation in interface IScriptingInterface

preloadTextures

public void preloadTextures(String[] paths)

Description copied from interface: IScriptingInterface

Pre-loads the given images as textures for later use. They will be cached for the subsequent uses.

Specified by:

preloadTextures in interface IScriptingInterface

Parameters:

paths - The texture paths.

startRecordingCameraPath

public void startRecordingCameraPath()

Description copied from interface: IScriptingInterface

Starts recording the camera path to an auto-generated file in the default camera directory. This command has no effect if the camera is already being recorded.

Specified by:

startRecordingCameraPath in interface IScriptingInterface

startRecordingCameraPath

public void startRecordingCameraPath(String fileName)

Description copied from interface: IScriptingInterface

Starts recording a camera path with the given filename. The filename is without extension or path. The final path with the camera file, after invoking IScriptingInterface.stopRecordingCameraPath(), is:

IScriptingInterface.getDefaultCameraDir() + "/" + filename + ".gsc"

This command has no effect if the camera is already being recorded.

Specified by:

startRecordingCameraPath in interface IScriptingInterface

stopRecordingCameraPath

public void stopRecordingCameraPath()

Description copied from interface: IScriptingInterface

Stops the current camera recording. This command has no effect if the camera was not being recorded.

Specified by:

stopRecordingCameraPath in interface IScriptingInterface

playCameraPath

public void playCameraPath(String file,
 boolean sync)

Description copied from interface: IScriptingInterface

Alias for IScriptingInterface.runCameraPath(String, boolean)

Specified by:

playCameraPath in interface IScriptingInterface

runCameraPath

public void runCameraPath(String file,
 boolean sync)

Description copied from interface: IScriptingInterface

Runs a .gsc camera path file and returns immediately. This function accepts a boolean indicating whether to wait for the camera path file to finish or not.

Specified by:

runCameraPath in interface IScriptingInterface

Parameters:

file - The path to the camera file. Path is relative to the application's root directory or absolute.

sync - If true, the call is synchronous and waits for the camera file to finish. Otherwise, it returns immediately.

playCameraPath

public void playCameraPath(String file)

Description copied from interface: IScriptingInterface

Alias for IScriptingInterface.runCameraPath(String)

Specified by:

playCameraPath in interface IScriptingInterface

runCameraPath

public void runCameraPath(String file)

Description copied from interface: IScriptingInterface

Runs a .gsc camera path file and returns immediately. This function does not wait for the camera file to finish playing.

Specified by:

runCameraPath in interface IScriptingInterface

Parameters:

file - The path to the camera file. Path is relative to the application's root directory or absolute.

runCameraRecording

public void runCameraRecording(String file)

Description copied from interface: IScriptingInterface

Runs the camera recording file with the given path. Does not wait for the camera file to finish playing.

Specified by:

runCameraRecording in interface IScriptingInterface

Parameters:

file - The path of the camera file. Path is relative to the application's root directory or absolute.

cameraTransitionKm

public void cameraTransitionKm(double[] camPos,
 double[] camDir,
 double[] camUp,
 double seconds)

Description copied from interface: IScriptingInterface

Same as IScriptingInterface.cameraTransition(double[], double[], double[], double) but the camera position is given in Km.

Specified by:

cameraTransitionKm in interface IScriptingInterface

Parameters:

camPos - The target camera position in Km.

camDir - The target camera direction vector.

camUp - The target camera up vector.

seconds - The duration of the transition in seconds.

cameraTransitionKm

public void cameraTransitionKm(List<?> camPos,
 List<?> camDir,
 List<?> camUp,
 double seconds)

cameraTransitionKm

public void cameraTransitionKm(List<?> camPos,
 List<?> camDir,
 List<?> camUp,
 long seconds)

cameraTransition

public void cameraTransition(double[] camPos,
 double[] camDir,
 double[] camUp,
 double seconds)

Description copied from interface: IScriptingInterface

Creates a smooth transition from the current camera state to the given camera state {camPos, camDir, camUp} in the given number of seconds. This function waits for the transition to finish and then returns control to the script. This function will put the camera in free mode, so make sure to change it afterwards if you need to. Also, this only works with the natural camera.

Specified by:

cameraTransition in interface IScriptingInterface

Parameters:

camPos - The target camera position in the internal reference system.

camDir - The target camera direction in the internal reference system.

camUp - The target camera up in the internal reference system.

seconds - The duration of the transition in seconds.

cameraTransition

public void cameraTransition(double[] camPos,
 String units,
 double[] camDir,
 double[] camUp,
 double seconds)

Description copied from interface: IScriptingInterface

Creates a smooth transition from the current camera state to the given camera state {camPos, camDir, camUp} in the given number of seconds. This function waits for the transition to finish and then returns control to the script. This function will put the camera in free mode, so make sure to change it afterward if you need to. Also, this only works with the natural camera.

Specified by:

cameraTransition in interface IScriptingInterface

Parameters:

camPos - The target camera position in the internal reference system and the given distance units.

units - The distance units to use. One of "m", "km", "au", "ly", "pc", "internal".

camDir - The target camera direction in the internal reference system.

camUp - The target camera up in the internal reference system.

seconds - The duration of the transition in seconds.

cameraTransition

public void cameraTransition(double[] camPos,
 double[] camDir,
 double[] camUp,
 long seconds)

cameraTransition

public void cameraTransition(double[] camPos,
 String units,
 double[] camDir,
 double[] camUp,
 long seconds)

cameraTransition

public void cameraTransition(List<?> camPos,
 List<?> camDir,
 List<?> camUp,
 double seconds)

cameraTransition

public void cameraTransition(List<?> camPos,
 String units,
 List<?> camDir,
 List<?> camUp,
 double seconds)

cameraTransition

public void cameraTransition(List<?> camPos,
 List<?> camDir,
 List<?> camUp,
 long seconds)

cameraTransition

public void cameraTransition(List<?> camPos,
 String units,
 List<?> camDir,
 List<?> camUp,
 long seconds)

cameraTransition

public void cameraTransition(double[] camPos,
 double[] camDir,
 double[] camUp,
 double seconds,
 boolean sync)

Description copied from interface: IScriptingInterface

Creates a smooth transition from the current camera state to the given camera state {camPos, camDir, camUp} in the given number of seconds. Optionally, the transition may be run synchronously or asynchronously to the current script. This function will put the camera in free mode, so make sure to change it afterward if you need to. Also, this only works with the natural camera.

Specified by:

cameraTransition in interface IScriptingInterface

Parameters:

camPos - The target camera position in the internal reference system.

camDir - The target camera direction in the internal reference system.

camUp - The target camera up in the internal reference system.

seconds - The duration of the transition in seconds.

sync - If true, the call waits for the transition to finish before returning, otherwise it returns immediately

cameraTransition

public void cameraTransition(double[] camPos,
 String units,
 double[] camDir,
 double[] camUp,
 double seconds,
 boolean sync)

Description copied from interface: IScriptingInterface

Creates a smooth transition from the current camera state to the given camera state {camPos, camDir, camUp} in the given number of seconds. Optionally, the transition may be run synchronously or asynchronously to the current script. This function will put the camera in free mode, so make sure to change it afterward if you need to. Also, this only works with the natural camera.

Specified by:

cameraTransition in interface IScriptingInterface

Parameters:

camPos - The target camera position in the internal reference system and the given distance units.

units - The distance units to use. One of "m", "km", "au", "ly", "pc", "internal".

camDir - The target camera direction in the internal reference system.

camUp - The target camera up in the internal reference system.

seconds - The duration of the transition in seconds.

sync - If true, the call waits for the transition to finish before returning, otherwise it returns immediately

cameraTransition

public void cameraTransition(List<?> camPos,
 List<?> camDir,
 List<?> camUp,
 double seconds,
 boolean sync)

cameraTransition

public void cameraTransition(List<?> camPos,
 String units,
 List<?> camDir,
 List<?> camUp,
 double seconds,
 boolean sync)

cameraTransition

public void cameraTransition(List<?> camPos,
 List<?> camDir,
 List<?> camUp,
 long seconds,
 boolean sync)

cameraTransition

public void cameraTransition(List<?> camPos,
 String units,
 List<?> camDir,
 List<?> camUp,
 long seconds,
 boolean sync)

sleep

public void sleep(float seconds)

Description copied from interface: IScriptingInterface

Sleeps for the given number of seconds in the application time (FPS), so if we are capturing frames and the frame rate is set to 30 FPS, the command sleep(1) will put the script to sleep for 30 frames.

Specified by:

sleep in interface IScriptingInterface

Parameters:

seconds - The number of seconds to wait.

sleep

public void sleep(int seconds)

sleepFrames

public void sleepFrames(long frames)

Description copied from interface: IScriptingInterface

Sleeps for a number of frames. The frame monitor is notified at the beginning of each frame, before the update-render cycle. When frames is 1, this method returns just before the processing of the next frame starts.

Specified by:

sleepFrames in interface IScriptingInterface

Parameters:

frames - The number of frames to wait.

galacticToInternalCartesian

public double[] galacticToInternalCartesian(double l,
 double b,
 double r)

Description copied from interface: IScriptingInterface

Converts galactic coordinates to the internal cartesian coordinate system.

Specified by:

galacticToInternalCartesian in interface IScriptingInterface

Parameters:

l - The galactic longitude in degrees.

b - The galactic latitude in degrees.

r - The distance in Km.

Returns:

An array of doubles containing [x, y, z] in the internal reference system, in internal units.

galacticToInternalCartesian

public double[] galacticToInternalCartesian(int l,
 int b,
 int r)

eclipticToInternalCartesian

public double[] eclipticToInternalCartesian(double l,
 double b,
 double r)

Description copied from interface: IScriptingInterface

Converts ecliptic coordinates to the internal cartesian coordinate system.

Specified by:

eclipticToInternalCartesian in interface IScriptingInterface

Parameters:

l - The ecliptic longitude in degrees.

b - The ecliptic latitude in degrees.

r - The distance in Km.

Returns:

An array of doubles containing [x, y, z] in the internal reference system, in internal units.

eclipticToInternalCartesian

public double[] eclipticToInternalCartesian(int l,
 int b,
 int r)

equatorialToInternalCartesian

public double[] equatorialToInternalCartesian(double ra,
 double dec,
 double r)

Description copied from interface: IScriptingInterface

Converts equatorial coordinates to the internal cartesian coordinate system.

Specified by:

equatorialToInternalCartesian in interface IScriptingInterface

Parameters:

ra - The right ascension in degrees.

dec - The declination in degrees.

r - The distance in Km.

Returns:

An array of doubles containing [x, y, z] in the internal reference system, in internal units.

equatorialToInternalCartesian

public double[] equatorialToInternalCartesian(int ra,
 int dec,
 int r)

internalCartesianToEquatorial

public double[] internalCartesianToEquatorial(double x,
 double y,
 double z)

Description copied from interface: IScriptingInterface

Converts internal cartesian coordinates to equatorial [ra, dec, distance] coordinates.

Specified by:

internalCartesianToEquatorial in interface IScriptingInterface

Parameters:

x - The x component, in any distance units.

y - The y component, in any distance units.

z - The z component, in any distance units.

Returns:

An array of doubles containing [ra, dec, distance] with ra and dec in degrees and distance in the same distance units as the input position.

internalCartesianToEquatorial

public double[] internalCartesianToEquatorial(int x,
 int y,
 int z)

equatorialCartesianToInternalCartesian

public double[] equatorialCartesianToInternalCartesian(double[] eq,
 double kmFactor)

Description copied from interface: IScriptingInterface

Converts regular cartesian coordinates, where XY is the equatorial plane, with X pointing to the vernal equinox (ra=0) and Y points to ra=90, and Z pointing to the celestial north pole (dec=90) to internal cartesian coordinates with internal units.

Specified by:

equatorialCartesianToInternalCartesian in interface IScriptingInterface

Parameters:

eq - Equatorial cartesian coordinates (X->[ra=0,dec=0], Y->[ra=90,dec=0], Z->[ra=0,dec=90])

kmFactor - Factor used to bring the input coordinate units to Kilometers, so that eq * factor = Km

Returns:

Internal coordinates ready to be fed in other scripting functions

equatorialCartesianToInternalCartesian

public double[] equatorialCartesianToInternalCartesian(List<?> eq,
 double kmFactor)

equatorialToGalactic

public double[] equatorialToGalactic(double[] eq)

Description copied from interface: IScriptingInterface

Converts equatorial cartesian coordinates (in the internal reference system) to galactic cartesian coordinates.

Specified by:

equatorialToGalactic in interface IScriptingInterface

Parameters:

eq - Vector with [x, y, z] equatorial cartesian coordinates

Returns:

Vector with [x, y, z] galactic cartesian coordinates

equatorialToGalactic

public double[] equatorialToGalactic(List<?> eq)

equatorialToEcliptic

public double[] equatorialToEcliptic(double[] eq)

Description copied from interface: IScriptingInterface

Converts equatorial cartesian coordinates (in the internal reference system) to ecliptic cartesian coordinates.

Specified by:

equatorialToEcliptic in interface IScriptingInterface

Parameters:

eq - Vector with [x, y, z] equatorial cartesian coordinates

Returns:

Vector with [x, y, z] ecliptic cartesian coordinates

equatorialToEcliptic

public double[] equatorialToEcliptic(List<?> eq)

galacticToEquatorial

public double[] galacticToEquatorial(double[] gal)

Description copied from interface: IScriptingInterface

Converts galactic cartesian coordinates (in the internal reference system) to equatorial cartesian coordinates.

Specified by:

galacticToEquatorial in interface IScriptingInterface

Parameters:

gal - Vector with [x, y, z] galactic cartesian coordinates

Returns:

Vector with [x, y, z] equatorial cartesian coordinates

galacticToEquatorial

public double[] galacticToEquatorial(List<?> gal)

eclipticToEquatorial

public double[] eclipticToEquatorial(double[] ecl)

Description copied from interface: IScriptingInterface

Converts ecliptic cartesian coordinates (in the internal reference system) to equatorial cartesian coordinates.

Specified by:

eclipticToEquatorial in interface IScriptingInterface

Parameters:

ecl - Vector with [x, y, z] ecliptic cartesian coordinates

Returns:

Vector with [x, y, z] equatorial cartesian coordinates

eclipticToEquatorial

public double[] eclipticToEquatorial(List<?> ecl)

setBrightnessLevel

public void setBrightnessLevel(double level)

Description copied from interface: IScriptingInterface

Sets the brightness level of the render system.

Specified by:

setBrightnessLevel in interface IScriptingInterface

Parameters:

level - The brightness level as a double precision floating point number in [-1,1]. The neutral value is 0.0.

setBrightnessLevel

public void setBrightnessLevel(long level)

setContrastLevel

public void setContrastLevel(double level)

Description copied from interface: IScriptingInterface

Sets the contrast level of the render system.

Specified by:

setContrastLevel in interface IScriptingInterface

Parameters:

level - The contrast level as a double precision floating point number in [0,2]. The neutral value is 1.0.

setContrastLevel

public void setContrastLevel(long level)

setHueLevel

public void setHueLevel(double level)

Description copied from interface: IScriptingInterface

Sets the hue level of the render system.

Specified by:

setHueLevel in interface IScriptingInterface

Parameters:

level - The hue level as a double precision floating point number in [0,2]. The neutral value is 1.0.

setHueLevel

public void setHueLevel(long level)

setSaturationLevel

public void setSaturationLevel(double level)

Description copied from interface: IScriptingInterface

Sets the saturation level of the render system.

Specified by:

setSaturationLevel in interface IScriptingInterface

Parameters:

level - The saturation level as a double precision floating point number in [0,2]. The neutral value is 1.0.

setSaturationLevel

public void setSaturationLevel(long level)

setGammaCorrectionLevel

public void setGammaCorrectionLevel(double level)

Description copied from interface: IScriptingInterface

Sets the gamma correction level.

Specified by:

setGammaCorrectionLevel in interface IScriptingInterface

Parameters:

level - The gamma correction level in [0,3] as a floating point number. The neutral value is 1.2.

setGammaCorrectionLevel

public void setGammaCorrectionLevel(long level)

setHDRToneMappingType

public void setHDRToneMappingType(String type)

Description copied from interface: IScriptingInterface

Sets the high dynamic range tone mapping algorithm type. The types can be:

• "auto" - performs an automatic HDR tone mapping based on the current luminosity of the scene
• "exposure" - performs an exposure-based HDR tone mapping. The exposure value must be set with IScriptingInterface.setExposureToneMappingLevel(double)
• "aces" - performs the ACES tone mapping
• "uncharted" - performs the tone mapping implemented in Uncharted
• "filmic" - performs a filmic tone mapping
• "none" - no HDR tone mapping

Specified by:

setHDRToneMappingType in interface IScriptingInterface

Parameters:

type - The HDR tone mapping type. One of ["auto"|"exposure"|"aces"|"uncharted"|"filmic"|"none"].

setExposureToneMappingLevel

public void setExposureToneMappingLevel(double level)

Description copied from interface: IScriptingInterface

Sets the exposure level.

Specified by:

setExposureToneMappingLevel in interface IScriptingInterface

Parameters:

level - The exposure level in [0,n]. Set to 0 to disable exposure tone mapping.

setExposureToneMappingLevel

public void setExposureToneMappingLevel(long level)

setCubemapMode

public void setCubemapMode(boolean state,
 String projection)

Description copied from interface: IScriptingInterface

Enables and disables the cubemap mode.

Specified by:

setCubemapMode in interface IScriptingInterface

Parameters:

state - The boolean state. True to activate, false to deactivate.

projection - The projection as a string.

setPanoramaMode

public void setPanoramaMode(boolean state)

Description copied from interface: IScriptingInterface

Enables or disables the panorama mode.

Specified by:

setPanoramaMode in interface IScriptingInterface

Parameters:

state - The boolean state. True to activate, false to deactivate.

setReprojectionMode

public void setReprojectionMode(String mode)

Description copied from interface: IScriptingInterface

Sets the re-projection mode. Possible modes are:

• "disabled"
• "default"
• "accurate"
• "stereographic_screen"
• "stereographic_long"
• "stereographic_short"
• "stereographic_180"
• "lambert_screen"
• "lambert_long"
• "lambert_short"
• "lambert_180"
• "orthographic_screen"
• "orthographic_long"
• "orthographic_short"
• "orthographic_180"

Specified by:

setReprojectionMode in interface IScriptingInterface

Parameters:

mode - The re-projection mode, as a string.

setBackBufferScale

public void setBackBufferScale(float scale)

Description copied from interface: IScriptingInterface

Sets the scaling factor for the back-buffer.

Specified by:

setBackBufferScale in interface IScriptingInterface

Parameters:

scale - The back-buffer scaling factor.

setIndexOfRefraction

public void setIndexOfRefraction(float ior)

Description copied from interface: IScriptingInterface

Sets index of refraction of celestial sphere in orthosphere view mode.

Specified by:

setIndexOfRefraction in interface IScriptingInterface

Parameters:

ior - The index of refraction.

setPlanetariumMode

public void setPlanetariumMode(boolean state)

Description copied from interface: IScriptingInterface

Enables or disables the planetarium mode.

Specified by:

setPlanetariumMode in interface IScriptingInterface

Parameters:

state - The boolean state. True to activate, false to deactivate.

setCubemapResolution

public void setCubemapResolution(int resolution)

Description copied from interface: IScriptingInterface

Sets the resolution (width and height are the same) of each side of the frame buffers used to capture each of the 6 directions that go into the cubemap to construct the equirectangular image for the 360 mode. This should roughly be 1/3 of the output resolution at which the 360 mode are to be captured (or screen resolution).

Specified by:

setCubemapResolution in interface IScriptingInterface

Parameters:

resolution - The resolution of each of the sides of the cubemap for the 360 mode.

setCubemapProjection

public void setCubemapProjection(String projection)

Description copied from interface: IScriptingInterface

Sets the cubemap projection to use. Accepted values are:

• "equirectangular" - spherical projection.
• "cylindrical" - cylindrical projection.
• "hammer" - Hammer projection.
• "orthographic" - orthographic projection, with the two hemispheres side-by-side.
• "orthosphere" - orthographic projection, with the two hemispheres overlaid. That gives an outside view of the camera's celestial sphere.
• "orthosphere_crosseye" - same as orthosphere, but duplicated to produce a stereoscopic cross-eye image (side by side).
• "azimuthal_equidistant" - azimuthal equidistant projection, used in Planetarium mode.

See CubmeapProjectionEffect for possible values.

Specified by:

setCubemapProjection in interface IScriptingInterface

Parameters:

projection - The projection, in ["equirectangular"|"cylindrical"|"hammer"|"orthographic"|"orthosphere"|"orthosphere_crossye"|"azimuthal_equidistant"].

setOrthosphereViewMode

public void setOrthosphereViewMode(boolean state)

Description copied from interface: IScriptingInterface

Enables or disables the orthosphere view mode.

Specified by:

setOrthosphereViewMode in interface IScriptingInterface

Parameters:

state - The state, true to activate and false to deactivate.

setStereoscopicMode

public void setStereoscopicMode(boolean state)

Description copied from interface: IScriptingInterface

Enables and disables the stereoscopic mode.

Specified by:

setStereoscopicMode in interface IScriptingInterface

Parameters:

state - The boolean state. True to activate, false to deactivate.

setStereoscopicProfile

public void setStereoscopicProfile(int index)

Description copied from interface: IScriptingInterface

Changes the stereoscopic profile.

Specified by:

setStereoscopicProfile in interface IScriptingInterface

Parameters:

index - The index of the new profile:

• 0 - VR_HEADSET
• 1 - HD_3DTV
• 2 - CROSSEYE
• 3 - PARALLEL_VIEW
• 4 - ANAGLYPHIC (red-cyan)

getCurrentFrameNumber

public long getCurrentFrameNumber()

Description copied from interface: IScriptingInterface

Gets the current frame number. Useful for timing actions in scripts.

Specified by:

getCurrentFrameNumber in interface IScriptingInterface

Returns:

The current frame number.

setLensFlare

public void setLensFlare(boolean state)

Description copied from interface: IScriptingInterface

Enables or disables the lens flare effect.

Specified by:

setLensFlare in interface IScriptingInterface

Parameters:

state - Activate (true) or deactivate (false).

setLensFlare

public void setLensFlare(double strength)

Description copied from interface: IScriptingInterface

Sets the strength of the lens flare effect, in [0,1]. Set to 0 to disable the effect.

Specified by:

setLensFlare in interface IScriptingInterface

Parameters:

strength - The strength or intensity of the lens flare, in [0,1].

setMotionBlur

public void setMotionBlur(boolean state)

Description copied from interface: IScriptingInterface

Enables or disables the motion blur effect.

Specified by:

setMotionBlur in interface IScriptingInterface

Parameters:

state - Activate (true) or deactivate (false).

setStarGlow

public void setStarGlow(boolean state)

Description copied from interface: IScriptingInterface

Enables or disables the stars glowing over objects.

Specified by:

setStarGlow in interface IScriptingInterface

Parameters:

state - Activate (true) or deactivate (false).

setStarGlowOverObjects

public void setStarGlowOverObjects(boolean state)

Description copied from interface: IScriptingInterface

Enables or disables stars' light glowing and spilling over closer objects.

Specified by:

setStarGlowOverObjects in interface IScriptingInterface

Parameters:

state - Enable (true) or disable (false).

setBloom

public void setBloom(float value)

Description copied from interface: IScriptingInterface

Sets the strength value for the bloom effect.

Specified by:

setBloom in interface IScriptingInterface

Parameters:

value - Bloom strength between 0 and 100. Set to 0 to deactivate the bloom.

setChromaticAberration

public void setChromaticAberration(float value)

Description copied from interface: IScriptingInterface

Sets the amount of chromatic aberration. Set to 0 to disable the effect.

Specified by:

setChromaticAberration in interface IScriptingInterface

Parameters:

value - Chromatic aberration amount in [0,0.05].

setBloom

public void setBloom(int level)

setSmoothLodTransitions

public void setSmoothLodTransitions(boolean value)

Description copied from interface: IScriptingInterface

Sets the value of smooth lod transitions, allowing or disallowing octant fade-ins of as they come into view.

Specified by:

setSmoothLodTransitions in interface IScriptingInterface

Parameters:

value - Activate (true) or deactivate (false).

rotate3

public double[] rotate3(double[] vector,
 double[] axis,
 double angle)

Description copied from interface: IScriptingInterface

Rotates a 3D vector around the given axis by the specified angle in degrees. Vectors are arrays with 3 components. If more components are there, they are ignored.

Specified by:

rotate3 in interface IScriptingInterface

Parameters:

vector - Vector to rotate, with at least 3 components.

axis - The axis, with at least 3 components.

angle - Angle in degrees.

Returns:

The new vector, rotated.

rotate3

public double[] rotate3(double[] vector,
 double[] axis,
 long angle)

rotate3

public double[] rotate3(List<?> vector,
 List<?> axis,
 double angle)

rotate3

public double[] rotate3(List<?> vector,
 List<?> axis,
 long angle)

rotate2

public double[] rotate2(double[] vector,
 double angle)

Description copied from interface: IScriptingInterface

Rotates a 2D vector by the specified angle in degrees, counter-clockwise assuming that the y axis points up.

Specified by:

rotate2 in interface IScriptingInterface

Parameters:

vector - Vector to rotate, with at least 2 components.

Returns:

The new vector, rotated.

rotate2

public double[] rotate2(double[] vector,
 long angle)

rotate2

public double[] rotate2(List<?> vector,
 double angle)

rotate2

public double[] rotate2(List<?> vector,
 long angle)

cross3

public double[] cross3(double[] vec1,
 double[] vec2)

Description copied from interface: IScriptingInterface

Computes the cross product between the two 3D vectors.

Specified by:

cross3 in interface IScriptingInterface

Parameters:

vec1 - First 3D vector.

vec2 - Second 3D vector.

Returns:

Cross product 3D vector.

cross3

public double[] cross3(List<?> vec1,
 List<?> vec2)

dot3

public double dot3(double[] vec1,
 double[] vec2)

Description copied from interface: IScriptingInterface

Computes the dot product between the two 3D vectors.

Specified by:

dot3 in interface IScriptingInterface

Parameters:

vec1 - First 3D vector.

vec2 - Second 3D vector.

Returns:

The dot product scalar.

dot3

public double dot3(List<?> vec1,
 List<?> vec2)

addTrajectoryLine

public void addTrajectoryLine(String name,
 double[] points,
 double[] color)

Description copied from interface: IScriptingInterface

Adds a new trajectory object with the given name, points and color. The trajectory is rendered using the 'line renderer' setting in the preferences dialog. This is a very similar call to IScriptingInterface.addPolyline(String, double[], double[]), but in this case the line can be rendered with higher quality polyline quadstrips.

Specified by:

addTrajectoryLine in interface IScriptingInterface

Parameters:

name - The name to identify the trajectory, to possibly remove it later.

points - The points of the trajectory. It is an array containing all the points as in [x0, y0, z0, x1, y1, z1, ..., xn, yn, zn] in the internal reference system.

color - The color of the trajectory as an array of RGBA (red, green, blue, alpha) values in [0,1].

addTrajectoryLine

public void addTrajectoryLine(String name,
 List<?> points,
 List<?> color)

addTrajectoryLine

public void addTrajectoryLine(String name,
 double[] points,
 double[] color,
 double trailMap)

Description copied from interface: IScriptingInterface

Adds a new trajectory object with the given name, points and color. The trajectory is rendered using the 'line renderer' setting in the preferences dialog. This is a very similar call to IScriptingInterface.addPolyline(String, double[], double[]), but in this case the line can be rendered with higher quality polyline quadstrips.

Specified by:

addTrajectoryLine in interface IScriptingInterface

Parameters:

name - The name to identify the trajectory, to possibly remove it later.

points - The points of the trajectory. It is an array containing all the points as in [x0, y0, z0, x1, y1, z1, ..., xn, yn, zn] in the internal reference system.

color - The color of the trajectory as an array of RGBA (red, green, blue, alpha) values in [0,1].

trailMap - The bottom mapping position for the trail. The orbit trail assigns an opacity value to each point of the orbit, where 1 is the location of the last point in the points list, and 0 is the first one. This mapping parameter defines the location in the orbit (in [0,1]) where we map the opacity value of 0. Set to 0 to have a full trail. Set to 0.5 to have a trail that spans half the orbit. Set to 1 to have no orbit at all. Set to negative to disable the trail.

addTrajectoryLine

public void addTrajectoryLine(String name,
 List<?> points,
 List<?> color,
 double trailMap)

addPolyline

public void addPolyline(String name,
 double[] points,
 double[] color)

Description copied from interface: IScriptingInterface

Adds a new polyline with the given name, points and color. The polyline will be created with the 'Others' component type, so you need to enable the visibility of 'Others' in order to see it. The default primitive of GL_LINE_STRIP is used.

Specified by:

addPolyline in interface IScriptingInterface

Parameters:

name - The name to identify the polyline, to possibly remove it later.

points - The points of the polyline. It is an array containing all the points as in [x0, y0, z0, x1, y1, z1, ..., xn, yn, zn] in the internal reference system.

color - The color of the polyline as an array of RGBA (red, green, blue, alpha) values in [0,1].

addPolyline

public void addPolyline(String name,
 List<?> points,
 List<?> color)

addPolyline

public void addPolyline(String name,
 double[] points,
 double[] color,
 double lineWidth)

Description copied from interface: IScriptingInterface

Adds a new polyline with the given name, points, color and line width. The polyline will be created with the 'Others' component type, so you need to enable the visibility of 'Others' in order to see it. The default primitive type of GL_LINE_STRIP is used.

Specified by:

addPolyline in interface IScriptingInterface

Parameters:

name - The name to identify the polyline, to possibly remove it later.

points - The points of the polyline. It is an array containing all the points as in [x0, y0, z0, x1, y1, z1, ..., xn, yn, zn].

color - The color of the polyline as an array of RGBA (red, green, blue, alpha) values in [0,1].

lineWidth - The line width. Usually a value between 1 (default) and 10.

addPolyline

public void addPolyline(String name,
 double[] points,
 double[] color,
 double lineWidth,
 boolean arrowCaps)

Description copied from interface: IScriptingInterface

Adds a new polyline with the given name, points, color and line width. The polyline will be created with the 'Others' component type, so you need to enable the visibility of 'Others' in order to see it. The default primitive type of GL_LINE_STRIP is used. This version enables the addition of arrow caps. In the case arrow caps are enabled, the line will be rendered in CPU mode (no VBO), making it slightly slower, especially for lines with many points. The arrow cap is added at the first point in the series.

Specified by:

addPolyline in interface IScriptingInterface

Parameters:

name - The name to identify the polyline, to possibly remove it later.

points - The points of the polyline. It is an array containing all the points as in [x0, y0, z0, x1, y1, z1, ..., xn, yn, zn].

color - The color of the polyline as an array of RGBA (red, green, blue, alpha) values in [0,1].

lineWidth - The line width. Usually a value between 1 (default) and 10.

arrowCaps - Whether to represent arrow caps. If enabled, the line is rendered in CPU mode, which is slower.

addPolyline

public void addPolyline(String name,
 double[] points,
 double[] color,
 double lineWidth,
 int primitive)

Description copied from interface: IScriptingInterface

Adds a new polyline with the given name, points, color, line width and primitive. The polyline will be created with the 'Others' component type, so you need to enable the visibility of 'Others' in order to see it.

Specified by:

addPolyline in interface IScriptingInterface

Parameters:

name - The name to identify the polyline, to possibly remove it later.

points - The points of the polyline. It is an array containing all the points as in [x0, y0, z0, x1, y1, z1, ..., xn, yn, zn].

color - The color of the polyline as an array of RGBA (red, green, blue, alpha) values in [0,1].

lineWidth - The line width. Usually a value between 1 (default) and 10.

primitive - The GL primitive: GL_LINES=1, GL_LINE_LOOP=2, GL_LINE_STRIP=3

addPolyline

public void addPolyline(String name,
 double[] points,
 double[] color,
 double lineWidth,
 int primitive,
 boolean arrowCaps)

Description copied from interface: IScriptingInterface

Adds a new polyline with the given name, points, color, line width, primitive and arrow caps. The polyline will be created with the 'Others' component type, so you need to enable the visibility of 'Others' in order to see it. This version enables the addition of arrow caps. In the case arrow caps are enabled, the line will be rendered in CPU mode (no VBO), making it slightly slower, especially for lines with many points. The arrow cap is added at the first point in the series.

Specified by:

addPolyline in interface IScriptingInterface

Parameters:

name - The name to identify the polyline, to possibly remove it later.

points - The points of the polyline. It is an array containing all the points as in [x0, y0, z0, x1, y1, z1, ..., xn, yn, zn].

color - The color of the polyline as an array of RGBA (red, green, blue, alpha) values in [0,1].

lineWidth - The line width. Usually a value between 1 (default) and 10.

primitive - The GL primitive: GL_LINES=1, GL_LINE_LOOP=2, GL_LINE_STRIP=3

arrowCaps - Whether to represent arrow caps. If enabled, the line is rendered in CPU mode, which is slower.

addLineObject

public com.badlogic.ashley.core.Entity addLineObject(String name,
 List<?> points,
 List<?> color,
 double lineWidth,
 int primitive,
 boolean arrowCaps,
 double trailMap,
 String archetypeName)

addLineObject

public com.badlogic.ashley.core.Entity addLineObject(String name,
 double[] points,
 double[] color,
 double lineWidth,
 int primitive,
 boolean arrowCaps,
 double trailMap,
 String archetypeName)

addPolyline

public void addPolyline(String name,
 double[] points,
 double[] color,
 int lineWidth)

addPolyline

public void addPolyline(String name,
 double[] points,
 double[] color,
 int lineWidth,
 int primitive)

addPolyline

public void addPolyline(String name,
 List<?> points,
 List<?> color,
 float lineWidth)

addPolyline

public void addPolyline(String name,
 List<?> points,
 List<?> color,
 float lineWidth,
 boolean arrowCaps)

addPolyline

public void addPolyline(String name,
 List<?> points,
 List<?> color,
 float lineWidth,
 int primitive)

addPolyline

public void addPolyline(String name,
 List<?> points,
 List<?> color,
 float lineWidth,
 int primitive,
 boolean arrowCaps)

addPolyline

public void addPolyline(String name,
 List<?> points,
 List<?> color,
 int lineWidth)

addPolyline

public void addPolyline(String name,
 List<?> points,
 List<?> color,
 int lineWidth,
 boolean arrowCaps)

addPolyline

public void addPolyline(String name,
 List<?> points,
 List<?> color,
 int lineWidth,
 int primitive)

addPolyline

public void addPolyline(String name,
 List<?> points,
 List<?> color,
 int lineWidth,
 int primitive,
 boolean arrowCaps)

removeModelObject

public void removeModelObject(String name)

Description copied from interface: IScriptingInterface

Removes the model object identified by the given name from the internal scene graph model of Gaia Sky, if it exists. If the object has children, they are removed recursively. Be careful with this function, as it can have unexpected side effects depending on what objects are removed. For example,

gs.removeModelObject("Earth")

removes the Earth, the Moon, Gaia and any dependent object from Gaia Sky.

Specified by:

removeModelObject in interface IScriptingInterface

Parameters:

name - The name of the object to remove.

postRunnable

public void postRunnable(Runnable runnable)

Description copied from interface: IScriptingInterface

Posts a Runnable to the main loop thread that runs once after the update-scene stage, and before the render stage.

Specified by:

postRunnable in interface IScriptingInterface

Parameters:

runnable - The runnable to run.

parkRunnable

public void parkRunnable(String id,
 Runnable runnable)

Description copied from interface: IScriptingInterface

See IScriptingInterface.parkSceneRunnable(String, Runnable).

Specified by:

parkRunnable in interface IScriptingInterface

parkSceneRunnable

public void parkSceneRunnable(String id,
 Runnable runnable)

Description copied from interface: IScriptingInterface

Parks an update Runnable to the main loop thread, and keeps it running every frame until it finishes or it is unparked by IScriptingInterface.unparkRunnable(String). This object runs after the update-scene stage and before the render stage, so it is intended for updating scene objects.

Be careful with this function, as it probably needs a cleanup before the script is finished. Otherwise, all parked runnables will keep running until Gaia Sky is restarted, so make sure to remove them with IScriptingInterface.unparkRunnable(String) if needed.

Specified by:

parkSceneRunnable in interface IScriptingInterface

Parameters:

id - The string id to identify the runnable.

runnable - The scene update runnable to park.

parkCameraRunnable

public void parkCameraRunnable(String id,
 Runnable runnable)

Description copied from interface: IScriptingInterface

Parks a camera update Runnable to the main loop thread, and keeps it running every frame until it finishes or it is unparked by IScriptingInterface.unparkRunnable(String). This object runs after the update-camera stage and before the update-scene, so it is intended for updating the camera only.

Be careful with this function, as it probably needs a cleanup before the script is finished. Otherwise, all parked runnables will keep running until Gaia Sky is restarted, so make sure to remove them with IScriptingInterface.unparkRunnable(String) if needed.

Specified by:

parkCameraRunnable in interface IScriptingInterface

Parameters:

id - The string id to identify the runnable.

runnable - The camera update runnable to park.

removeRunnable

public void removeRunnable(String id)

Description copied from interface: IScriptingInterface

Removes the runnable with the given id, if any. Use this method to remove previously parked scene and camera runnables.

Specified by:

removeRunnable in interface IScriptingInterface

Parameters:

id - The id of the runnable to remove.

unparkRunnable

public void unparkRunnable(String id)

Description copied from interface: IScriptingInterface

Removes the runnable with the given id, if any.

Specified by:

unparkRunnable in interface IScriptingInterface

Parameters:

id - The id of the runnable to remove.

setCameraState

public void setCameraState(double[] pos,
 double[] dir,
 double[] up)

Description copied from interface: IScriptingInterface

Sets the camera state (position, direction and up vector).

Specified by:

setCameraState in interface IScriptingInterface

Parameters:

pos - The position of the camera in internal units, not Km.

dir - The direction of the camera.

up - The up vector of the camera.

setCameraState

public void setCameraState(List<?> pos,
 List<?> dir,
 List<?> up)

setCameraStateAndTime

public void setCameraStateAndTime(double[] pos,
 double[] dir,
 double[] up,
 long time)

Description copied from interface: IScriptingInterface

Sets the camera state (position, direction and up vector) plus the current time.

Specified by:

setCameraStateAndTime in interface IScriptingInterface

Parameters:

pos - The position of the camera in internal units, not Km.

dir - The direction of the camera.

up - The up vector of the camera.

time - The new time of the camera as the number of milliseconds since the epoch (Jan 1, 1970).

setCameraStateAndTime

public void setCameraStateAndTime(List<?> pos,
 List<?> dir,
 List<?> up,
 long time)

resetImageSequenceNumber

public void resetImageSequenceNumber()

Description copied from interface: IScriptingInterface

Resets to zero the image sequence number used to generate the file names of the frame output images.

Specified by:

resetImageSequenceNumber in interface IScriptingInterface

loadDataset

public boolean loadDataset(String dsName,
 String absolutePath)

Description copied from interface: IScriptingInterface

Loads a VOTable, FITS, CSV or JSON dataset file with the given name. In this version, the loading happens synchronously, so the catalog is available to Gaia Sky immediately after this call returns. The actual loading process is carried out making educated guesses about semantics using UCDs and column names. Please check the official documentation for a complete reference on what can and what can't be loaded.

Specified by:

loadDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset, used to identify the subsequent operations on the dataset.

absolutePath - Absolute path (or relative to the working path of Gaia Sky) to the .vot file to load.

Returns:

False if the dataset could not be loaded, true otherwise.

loadDataset

public boolean loadDataset(String dsName,
 String path,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a VOTable, FITS, CSV or JSON dataset file with the given name. The call can be made synchronous or asynchronous.
If sync is true, the call acts exactly like IScriptingInterface.loadDataset(String, String).
If sync is false, the loading happens in a new thread and the call returns immediately. In this case, you can use IScriptingInterface.hasDataset(String) to check whether the dataset is already loaded and available. The actual loading process is carried out making educated guesses about semantics using UCDs and column names. Please check the official documentation for a complete reference on what can and what can't be loaded.

Specified by:

loadDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset, used to identify the subsequent operations on the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the file to load.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadDataset

public boolean loadDataset(String dsName,
 String path,
 CatalogInfo.CatalogInfoSource type,
 boolean sync)

loadDataset

public boolean loadDataset(String dsName,
 String path,
 CatalogInfo.CatalogInfoSource type,
 DatasetOptions datasetOptions,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a VOTable, FITS, CSV or JSON dataset file with the given name. The call can be made synchronous or asynchronous.
If sync is true, the call acts exactly like IScriptingInterface.loadDataset(String, String, boolean).
If sync is false, the loading happens in a new thread and the call returns immediately. In this case, you can use IScriptingInterface.hasDataset(String) to check whether the dataset is already loaded and available. The actual loading process is carried out making educated guesses about semantics using UCDs and column names. Please check the official documentation for a complete reference on what can and what can't be loaded. This version includes the catalog info type.

Specified by:

loadDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset, used to identify the subsequent operations on the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the file to load.

type - The CatalogInfo.CatalogInfoSource object to use as the dataset type.

datasetOptions - The DatasetOptions object holding the options for this dataset.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadDataset

public boolean loadDataset(String dsName,
 uk.ac.starlink.util.DataSource ds,
 CatalogInfo.CatalogInfoSource type,
 DatasetOptions datasetOptions,
 boolean sync)

loadStarDataset

public boolean loadStarDataset(String dsName,
 String path,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a star dataset from a VOTable, a CSV or a FITS file. The dataset does not have a label. The call can be made synchronous or asynchronous.
If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadStarDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadStarDataset

public boolean loadStarDataset(String dsName,
 String path,
 double magnitudeScale,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a star dataset from a VOTable, a CSV or a FITS file. The dataset does not have a label. The call can be made synchronous or asynchronous.
If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadStarDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

magnitudeScale - Scaling additive factor to apply to the star magnitudes, as in appmag = appmag - magnitudeScale.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadStarDataset

public boolean loadStarDataset(String dsName,
 String path,
 double magnitudeScale,
 double[] labelColor,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a star dataset from a VOTable, a CSV or a FITS file. The call can be made synchronous or asynchronous.
If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadStarDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

magnitudeScale - Scaling additive factor to apply to the star magnitudes, as in appmag = appmag - magnitudeScale.

labelColor - The color of the labels, as an array of RGBA (red, green, blue, alpha) values in [0,1].

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadStarDataset

public boolean loadStarDataset(String dsName,
 String path,
 double magnitudeScale,
 List<?> labelColor,
 boolean sync)

loadStarDataset

public boolean loadStarDataset(String dsName,
 String path,
 double magnitudeScale,
 double[] labelColor,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a star dataset from a VOTable, a CSV or a FITS file. The call can be made synchronous or asynchronous.
If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadStarDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

magnitudeScale - Scaling additive factor to apply to the star magnitudes, as in appmag = appmag - magnitudeScale.

labelColor - The color of the labels, as an array of RGBA (red, green, blue, alpha) values in [0,1].

fadeIn - Two values which represent the fade in mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

fadeOut - Two values which represent the fade out mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadStarDataset

public boolean loadStarDataset(String dsName,
 String path,
 double magnitudeScale,
 List<?> labelColor,
 List<?> fadeIn,
 List<?> fadeOut,
 boolean sync)

loadStarDataset

public boolean loadStarDataset(String dsName,
 String path,
 CatalogInfo.CatalogInfoSource type,
 double magnitudeScale,
 double[] labelColor,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

loadParticleDataset

public boolean loadParticleDataset(String dsName,
 String path,
 double profileDecay,
 double[] particleColor,
 double colorNoise,
 double[] labelColor,
 double particleSize,
 String ct,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a particle dataset (point cloud) from a VOTable, a CSV or a FITS file. The call can be made synchronous or asynchronous.
If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadParticleDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

profileDecay - The profile decay of the particles as in 1 - distCentre^decay.

particleColor - The base color of the particles, as an array of RGBA (red, green, blue, alpha) values in [0,1].

colorNoise - In [0,1], the noise to apply to the color so that each particle gets a slightly different tone. Set to 0 so that all particles get the same color.

labelColor - The color of the labels, as an array of RGBA (red, green, blue, alpha) values in [0,1].

particleSize - The size of the particles in pixels.

ct - The name of the component type to use like "Stars", "Galaxies", etc. (see ComponentTypes.ComponentType).

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadParticleDataset

public boolean loadParticleDataset(String dsName,
 String path,
 double profileDecay,
 List<?> particleColor,
 double colorNoise,
 List<?> labelColor,
 double particleSize,
 String ct,
 boolean sync)

loadParticleDataset

public boolean loadParticleDataset(String dsName,
 String path,
 double profileDecay,
 double[] particleColor,
 double colorNoise,
 double[] labelColor,
 double particleSize,
 String ct,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a particle dataset (point cloud) from a VOTable, a CSV or a FITS file. The call can be made synchronous or asynchronous.
If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadParticleDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

profileDecay - The profile decay of the particles as in 1 - distCentre^decay.

particleColor - The base color of the particles, as an array of RGBA (red, green, blue, alpha) values in [0,1].

colorNoise - In [0,1], the noise to apply to the color so that each particle gets a slightly different tone. Set to 0 so that all particles get the same color.

labelColor - The color of the labels, as an array of RGBA (red, green, blue, alpha) values in [0,1].

particleSize - The size of the particles in pixels.

ct - The name of the component type to use like "Stars", "Galaxies", etc. (see ComponentTypes.ComponentType).

fadeIn - Two values which represent the fade in mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

fadeOut - Two values which represent the fade out mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadParticleDataset

public boolean loadParticleDataset(String dsName,
 String path,
 double profileDecay,
 List<?> particleColor,
 double colorNoise,
 List<?> labelColor,
 double particleSize,
 String ct,
 List<?> fadeIn,
 List<?> fadeOut,
 boolean sync)

loadParticleDataset

public boolean loadParticleDataset(String dsName,
 String path,
 double profileDecay,
 double[] particleColor,
 double colorNoise,
 double[] labelColor,
 double particleSize,
 double[] sizeLimits,
 String ct,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a particle dataset (point cloud) from a VOTable, a CSV or a FITS file. The call can be made synchronous or asynchronous.
If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadParticleDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

profileDecay - The profile decay of the particles as in 1 - distCentre^decay.

particleColor - The base color of the particles, as an array of RGBA (red, green, blue, alpha) values in [0,1].

colorNoise - In [0,1], the noise to apply to the color so that each particle gets a slightly different tone. Set to 0 so that all particles get the same color.

labelColor - The color of the labels, as an array of RGBA (red, green, blue, alpha) values in [0,1].

particleSize - The size of the particles in pixels.

sizeLimits - The minimum and maximum size of the particles in pixels.

ct - The name of the component type to use like "Stars", "Galaxies", etc. (see ComponentTypes.ComponentType).

fadeIn - Two values which represent the fade in mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

fadeOut - Two values which represent the fade out mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadParticleDataset

public boolean loadParticleDataset(String dsName,
 String path,
 double profileDecay,
 List<?> particleColor,
 double colorNoise,
 List<?> labelColor,
 double particleSize,
 List<?> sizeLimits,
 String ct,
 List<?> fadeIn,
 List<?> fadeOut,
 boolean sync)

loadParticleDataset

public boolean loadParticleDataset(String dsName,
 String path,
 double profileDecay,
 double[] particleColor,
 double colorNoise,
 double[] labelColor,
 double particleSize,
 double[] sizeLimits,
 ComponentTypes.ComponentType ct,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

loadParticleDataset

public boolean loadParticleDataset(String dsName,
 String path,
 CatalogInfo.CatalogInfoSource type,
 double profileDecay,
 double[] particleColor,
 double colorNoise,
 double[] labelColor,
 double particleSize,
 double[] sizeLimits,
 ComponentTypes.ComponentType ct,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

loadStarClusterDataset

public boolean loadStarClusterDataset(String dsName,
 String path,
 double[] particleColor,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a star cluster dataset from a CSV, VOTable or FITS file. The file needs the columns with the following names: name, ra, dec, dist, pmra, pmdec, radius, radvel. Uses the same color for clusters and labels. The call can be made synchronous or asynchronous. If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadStarClusterDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

particleColor - The base color of the particles and labels, as an array of RGBA (red, green, blue, alpha) values in [0,1].

fadeIn - Two values which represent the fade in mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

fadeOut - Two values which represent the fade out mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadStarClusterDataset

public boolean loadStarClusterDataset(String dsName,
 String path,
 List<?> particleColor,
 List<?> fadeIn,
 List<?> fadeOut,
 boolean sync)

loadStarClusterDataset

public boolean loadStarClusterDataset(String dsName,
 String path,
 double[] particleColor,
 double[] labelColor,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a star cluster dataset from a CSV, VOTable or FITS file. The file needs the columns with the following names: name, ra, dec, dist, pmra, pmdec, radius, radvel. The call can be made synchronous or asynchronous. If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadStarClusterDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

particleColor - The base color of the particles, as an array of RGBA (red, green, blue, alpha) values in [0,1].

labelColor - The color of the labels, as an array of RGBA (red, green, blue, alpha) values in [0,1].

fadeIn - Two values which represent the fade in mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

fadeOut - Two values which represent the fade out mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadStarClusterDataset

public boolean loadStarClusterDataset(String dsName,
 String path,
 List<?> particleColor,
 List<?> labelColor,
 List<?> fadeIn,
 List<?> fadeOut,
 boolean sync)

loadStarClusterDataset

public boolean loadStarClusterDataset(String dsName,
 String path,
 double[] particleColor,
 String ct,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a star cluster dataset from a CSV, VOTable or FITS file. The file needs the columns with the following names: name, ra, dec, dist, pmra, pmdec, radius, radvel. Uses the same color for clusters and labels. The call can be made synchronous or asynchronous. If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadStarClusterDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

particleColor - The base color of the particles and labels, as an array of RGBA (red, green, blue, alpha) values in [0,1].

ct - The name of the component type to use (see ComponentTypes.ComponentType).

fadeIn - Two values which represent the fade in mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

fadeOut - Two values which represent the fade out mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadStarClusterDataset

public boolean loadStarClusterDataset(String dsName,
 String path,
 List<?> particleColor,
 String ct,
 List<?> fadeIn,
 List<?> fadeOut,
 boolean sync)

loadStarClusterDataset

public boolean loadStarClusterDataset(String dsName,
 String path,
 double[] particleColor,
 double[] labelColor,
 String ct,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a star cluster dataset from a CSV, VOTable or FITS file. The file needs the columns with the following names: name, ra, dec, dist, pmra, pmdec, radius, radvel. The call can be made synchronous or asynchronous. If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadStarClusterDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

particleColor - The base color of the particles and labels, as an array of RGBA (red, green, blue, alpha) values in [0,1].

labelColor - The color of the labels, as an array of RGBA (red, green, blue, alpha) values in [0,1].

ct - The name of the component type to use (see ComponentTypes.ComponentType).

fadeIn - Two values which represent the fade in mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

fadeOut - Two values which represent the fade out mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadVariableStarDataset

public boolean loadVariableStarDataset(String dsName,
 String path,
 double magnitudeScale,
 double[] labelColor,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a variable star dataset from a VOTable, CSV or FITS file. The variable star table must have the following columns representing the light curve:

• g_transit_time: list of times as Julian days since J2010 for each of the magnitudes
• g_transit_mag: list of magnitudes corresponding to the times in g_transit_times
• pf: the period in days

The call can be made synchronous or asynchronous.
If sync is true, the call waits until the dataset is loaded and then returns. If sync is false, the loading happens in a new thread and the call returns immediately. It includes some parameters to apply to the new star group.

Specified by:

loadVariableStarDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - Absolute path (or relative to the working path of Gaia Sky) to the .vot, .csv or .fits file to load.

magnitudeScale - Scaling additive factor to apply to the magnitudes in the light curve, as in appmag = appmag - magnitudeScale.

labelColor - The color of the labels, as an array of RGBA (red, green, blue, alpha) values in [0,1].

fadeIn - Two values which represent the fade in mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

fadeOut - Two values which represent the fade out mapping distances (in parsecs, as distance from camera to the Sun) of this dataset. Set to null to disable.

sync - Whether the load must happen synchronously or asynchronously.

Returns:

False if the dataset could not be loaded (sync mode). True if it could not be loaded (sync mode), or sync is false.

loadVariableStarDataset

public boolean loadVariableStarDataset(String dsName,
 String path,
 CatalogInfo.CatalogInfoSource type,
 double magnitudeScale,
 double[] labelColor,
 double[] fadeIn,
 double[] fadeOut,
 boolean sync)

loadStarClusterDataset

public boolean loadStarClusterDataset(String dsName,
 String path,
 List<?> particleColor,
 List<?> labelColor,
 String ct,
 List<?> fadeIn,
 List<?> fadeOut,
 boolean sync)

loadJsonCatalog

public boolean loadJsonCatalog(String dsName,
 String path)

Description copied from interface: IScriptingInterface

Loads a Gaia Sky JSON dataset file asynchronously. The call returns immediately, and the dataset becomes available when it finished loading. The Gaia Sky JSON data format is described here.

Specified by:

loadJsonCatalog in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - The absolute path, or the path in the data directory, of the dataset file.

Returns:

False if the dataset could not be loaded. True otherwise.

loadJsonDataset

public boolean loadJsonDataset(String dsName,
 String path)

Description copied from interface: IScriptingInterface

Loads a JSON Gaia Sky dataset file asynchronously. The call returns immediately, and the dataset becomes available when it finished loading. The Gaia Sky JSON data format is described here.

Specified by:

loadJsonDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

path - The absolute path, or the path in the data directory, of the dataset file.

Returns:

False if the dataset could not be loaded. True otherwise.

loadJsonDataset

public boolean loadJsonDataset(String dsName,
 String pathString,
 boolean sync)

Description copied from interface: IScriptingInterface

Loads a Gaia Sky JSON dataset file in a synchronous or asynchronous manner. The Gaia Sky JSON data format is described here.

Specified by:

loadJsonDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset.

pathString - The absolute path, or the path in the data directory, of the dataset file.

sync - If true, the call does not return until the dataset is loaded and available in Gaia Sky.

Returns:

False if the dataset could not be loaded. True otherwise.

hasDataset

public boolean hasDataset(String dsName)

Description copied from interface: IScriptingInterface

Checks whether the dataset identified by the given name is loaded

Specified by:

hasDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset to query.

Returns:

True if the dataset is loaded, false otherwise.

removeDataset

public boolean removeDataset(String dsName)

Description copied from interface: IScriptingInterface

Removes the dataset identified by the given name, if it exists.

Specified by:

removeDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset to remove.

Returns:

False if the dataset could not be found.

hideDataset

public boolean hideDataset(String dsName)

Description copied from interface: IScriptingInterface

Hides the dataset identified by the given name, if it exists and is not hidden.

Specified by:

hideDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset to hide.

Returns:

False if the dataset could not be found.

showDataset

public boolean showDataset(String dsName)

Description copied from interface: IScriptingInterface

Shows (un-hides) the dataset identified by the given name, if it exists and is hidden

Specified by:

showDataset in interface IScriptingInterface

Parameters:

dsName - The name of the dataset to show.

Returns:

False if the dataset could not be found.

highlightDataset

public boolean highlightDataset(String dsName,
 boolean highlight)

Description copied from interface: IScriptingInterface

Enables or disables the dataset highlight using a plain color chosen by the system.

Specified by:

highlightDataset in interface IScriptingInterface

Parameters:

dsName - The dataset name.

highlight - State.

Returns:

False if the dataset could not be found.

highlightDataset

public boolean highlightDataset(String dsName,
 int colorIndex,
 boolean highlight)

Description copied from interface: IScriptingInterface

Enables or disables the dataset highlight, using a plain color given by the color index:

• 0 - blue
• 1 - red
• 2 - yellow
• 3 - green
• 4 - pink
• 5 - orange
• 6 - purple
• 7 - brown
• 8 - magenta

Specified by:

highlightDataset in interface IScriptingInterface

Parameters:

dsName - The dataset name.

colorIndex - Color index in [0,8].

highlight - Whether to highlight or not.

Returns:

False if the dataset could not be found.

highlightDataset

public boolean highlightDataset(String dsName,
 float r,
 float g,
 float b,
 float a,
 boolean highlight)

Description copied from interface: IScriptingInterface

Enables or disables the dataset highlight, using a given plain color.

Specified by:

highlightDataset in interface IScriptingInterface

Parameters:

dsName - The dataset name.

r - Red component.

highlight - State.

Returns:

False if the dataset could not be found.

highlightDataset

public boolean highlightDataset(String dsName,
 String attributeName,
 String colorMap,
 double minMap,
 double maxMap,
 boolean highlight)

Description copied from interface: IScriptingInterface

Enables or disables the dataset highlight, using the given color map on the given attribute with the given maximum and minimum mapping values.

Specified by:

highlightDataset in interface IScriptingInterface

Parameters:

dsName - The dataset name.

attributeName - The attribute name. You can use basic attributes (please mind the case!):

• RA
• DEC
• Distance
• GalLatitude
• GalLongitude
• EclLatitude
• EclLongitude

Or star-only attributes (if your dataset contains stars, mind the case!):

• Mualpha
• Mudelta
• Radvel
• Absmag
• Appmag

Or even extra attributes (if you loaded the dataset yourself), matching by column name.

colorMap - The color map to use, in ["reds"|"greens"|"blues"|"rainbow18"|"rainbow"|"seismic"|"carnation"|"hotmeal"|"cool"].

minMap - The minimum mapping value.

maxMap - The maximum mapping value.

highlight - State.

Returns:

False if the dataset could not be found.

setDatasetHighlightSizeFactor

public boolean setDatasetHighlightSizeFactor(String dsName,
 float sizeFactor)

Description copied from interface: IScriptingInterface

Sets the size increase factor of this dataset when highlighted.

Specified by:

setDatasetHighlightSizeFactor in interface IScriptingInterface

Parameters:

dsName - The dataset name.

sizeFactor - The size factor to apply to the particles when highlighted, must be in [Constants.MIN_DATASET_SIZE_FACTOR, Constants.MAX_DATASET_SIZE_FACTOR].

Returns:

False if the dataset could not be found.

setDatasetHighlightAllVisible

public boolean setDatasetHighlightAllVisible(String dsName,
 boolean allVisible)

Description copied from interface: IScriptingInterface

Sets the 'all visible' property of datasets when highlighted. If set to true, all stars in the dataset have an increased minimum opacity when highlighted, so that they are all visible. Otherwise, stars retain their minimum opacity and base brightness.

Specified by:

setDatasetHighlightAllVisible in interface IScriptingInterface

Parameters:

dsName - The dataset name.

allVisible - Whether all stars in the dataset should be visible when highlighted or not.

Returns:

False if the dataset could not be found.

setDatasetPointSizeMultiplier

public void setDatasetPointSizeMultiplier(String dsName,
 double multiplier)

Description copied from interface: IScriptingInterface

Sets the dataset point size multiplier.

Specified by:

setDatasetPointSizeMultiplier in interface IScriptingInterface

Parameters:

dsName - The dataset name.

multiplier - The multiplier, as a positive floating point number.

addShapeAroundObject

public void addShapeAroundObject(String shapeName,
 String shapeType,
 String primitive,
 double size,
 String objectName,
 float r,
 float g,
 float b,
 float a,
 boolean showLabel,
 boolean trackObject)

Description copied from interface: IScriptingInterface

Creates a shape object of the given type with the given size around the object with the given name.

Specified by:

addShapeAroundObject in interface IScriptingInterface

Parameters:

shapeName - The name of the shape object.

shapeType - The shape type, one of

• sphere
• icosphere
• octahedronsphere
• ring
• cylinder
• cone

primitive - The primitive to use, one of

• lines
• triangles

. Use 'lines' to create a wireframe shape, use 'triangles' for a solid shape.

size - The size of the object in kilometers.

objectName - The name of the object to use as the position.

r - The red component of the color in [0,1].

g - The green component of the color in [0,1].

b - The blue component of the color in [0,1].

a - The alpha component of the color in [0,1].

showLabel - Whether to show a label with the name of the shape.

trackObject - Whether to track the object if/when it moves.

setMaximumSimulationTime

public void setMaximumSimulationTime(long years)

Description copied from interface: IScriptingInterface

Sets the maximum simulation time allowed, in years. This sets the maximum time in the future (years) and in the past (-years). This setting is not saved to the configuration and resets to 5 Myr after restart.

Specified by:

setMaximumSimulationTime in interface IScriptingInterface

Parameters:

years - The maximum year number to allow.

setMaximumSimulationTime

public void setMaximumSimulationTime(double years)

setMaximumSimulationTime

public void setMaximumSimulationTime(Long years)

setMaximumSimulationTime

public void setMaximumSimulationTime(Double years)

setMaximumSimulationTime

public void setMaximumSimulationTime(Integer years)

getMeterToInternalUnitConversion

public double getMeterToInternalUnitConversion()

Description copied from interface: IScriptingInterface

Returns the meter to internal unit conversion factor. Use this factor to multiply your coordinates in meters to get them in internal units.

Specified by:

getMeterToInternalUnitConversion in interface IScriptingInterface

Returns:

The factor M_TO_U.

getInternalUnitToMeterConversion

public double getInternalUnitToMeterConversion()

Description copied from interface: IScriptingInterface

Returns the internal unit to meter conversion factor. Use this factor to multiply your coordinates in internal units to get them in meters.

Specified by:

getInternalUnitToMeterConversion in interface IScriptingInterface

Returns:

The factor U_TO_M.

internalUnitsToMetres

public double internalUnitsToMetres(double internalUnits)

Description copied from interface: IScriptingInterface

Converts the value in internal units to metres.

Specified by:

internalUnitsToMetres in interface IScriptingInterface

Parameters:

internalUnits - The value in internal units.

Returns:

The value in metres.

internalUnitsToKilometres

public double internalUnitsToKilometres(double internalUnits)

Description copied from interface: IScriptingInterface

Converts the value in internal units to Kilometers.

Specified by:

internalUnitsToKilometres in interface IScriptingInterface

Parameters:

internalUnits - The value in internal units.

Returns:

The value in Kilometers.

internalUnitsToKilometres

public double[] internalUnitsToKilometres(double[] internalUnits)

Description copied from interface: IScriptingInterface

Converts the array in internal units to Kilometers.

Specified by:

internalUnitsToKilometres in interface IScriptingInterface

Parameters:

internalUnits - The array in internal units.

Returns:

The array in Kilometers.

internalUnitsToParsecs

public double internalUnitsToParsecs(double internalUnits)

Description copied from interface: IScriptingInterface

Converts the value in internal units to parsecs.

Specified by:

internalUnitsToParsecs in interface IScriptingInterface

Parameters:

internalUnits - The value in internal units.

Returns:

The value in parsecs.

internalUnitsToParsecs

public double[] internalUnitsToParsecs(double[] internalUnits)

Description copied from interface: IScriptingInterface

Converts the array in internal units to parsecs.

Specified by:

internalUnitsToParsecs in interface IScriptingInterface

Parameters:

internalUnits - The array in internal units.

Returns:

The array in parsecs.

internalUnitsToKilometres

public double[] internalUnitsToKilometres(List<?> internalUnits)

metresToInternalUnits

public double metresToInternalUnits(double metres)

Description copied from interface: IScriptingInterface

Converts the metres to internal units.

Specified by:

metresToInternalUnits in interface IScriptingInterface

Parameters:

metres - The value in metres.

Returns:

The value in internal units.

kilometresToInternalUnits

public double kilometresToInternalUnits(double kilometres)

Description copied from interface: IScriptingInterface

Converts the kilometres to internal units.

Specified by:

kilometresToInternalUnits in interface IScriptingInterface

Parameters:

kilometres - The value in kilometers.

Returns:

The value in internal units.

parsecsToInternalUnits

public double parsecsToInternalUnits(double parsecs)

Description copied from interface: IScriptingInterface

Converts the parsecs to internal units.

Specified by:

parsecsToInternalUnits in interface IScriptingInterface

Parameters:

parsecs - The value in parsecs.

Returns:

The value in internal units.

kilometersToInternalUnits

public double kilometersToInternalUnits(double kilometres)

listDatasets

public List<String> listDatasets()

Description copied from interface: IScriptingInterface

Returns the names of all datasets currently loaded.

Specified by:

listDatasets in interface IScriptingInterface

Returns:

A list with all the names of the loaded datasets.

getFrameNumber

public long getFrameNumber()

Description copied from interface: IScriptingInterface

Gets the current frame number. The number begins at 0 for the first frame produced when Gaia Sky is started and increases continuously.

Specified by:

getFrameNumber in interface IScriptingInterface

Returns:

The current frame number.

getDefaultFramesDir

public String getDefaultFramesDir()

Description copied from interface: IScriptingInterface

Gets the absolute path of the default directory where the still frames are saved.

Specified by:

getDefaultFramesDir in interface IScriptingInterface

Returns:

Absolute path of directory where still frames are saved.

getDefaultScreenshotsDir

public String getDefaultScreenshotsDir()

Description copied from interface: IScriptingInterface

Gets the absolute path of the default directory where the screenshots are saved.

Specified by:

getDefaultScreenshotsDir in interface IScriptingInterface

Returns:

Absolute path of directory where screenshots are saved.

getDefaultCameraDir

public String getDefaultCameraDir()

Description copied from interface: IScriptingInterface

Gets the absolute path of the default directory where the camera files are saved.

Specified by:

getDefaultCameraDir in interface IScriptingInterface

Returns:

Absolute path of directory where camera files are saved.

getDefaultMusicDir

public String getDefaultMusicDir()

Description copied from interface: IScriptingInterface

Gets the absolute path to the location of the music files

Specified by:

getDefaultMusicDir in interface IScriptingInterface

Returns:

Absolute path to the location of the music files

getDefaultMappingsDir

public String getDefaultMappingsDir()

Description copied from interface: IScriptingInterface

Gets the absolute path to the location of the inputListener mappings.

Specified by:

getDefaultMappingsDir in interface IScriptingInterface

Returns:

Absolute path to the location of the inputListener mappings.

getDataDir

public String getDataDir()

Description copied from interface: IScriptingInterface

Gets the absolute path of the local data directory, configured in your config.yaml file.

Specified by:

getDataDir in interface IScriptingInterface

Returns:

Absolute path to the location of the data files.

getConfigDir

public String getConfigDir()

Description copied from interface: IScriptingInterface

Gets the absolute path to the location of the configuration directory

Specified by:

getConfigDir in interface IScriptingInterface

Returns:

Absolute path of config directory.

getLocalDataDir

public String getLocalDataDir()

Description copied from interface: IScriptingInterface

Returns the default data directory. That is ~/.gaiasky/ in Windows and macOS, and ~/.local/share/gaiasky in Linux.

Specified by:

getLocalDataDir in interface IScriptingInterface

Returns:

Absolute path of data directory.

print

public void print(String message)

Description copied from interface: IScriptingInterface

Print text using the internal logging system.

Specified by:

print in interface IScriptingInterface

Parameters:

message - The message.

log

public void log(String message)

Description copied from interface: IScriptingInterface

Print text using the internal logging system.

Specified by:

log in interface IScriptingInterface

Parameters:

message - The message.

error

public void error(String message)

Description copied from interface: IScriptingInterface

Log an error using the internal logging system.

Specified by:

error in interface IScriptingInterface

Parameters:

message - The error message.

quit

public void quit()

Description copied from interface: IScriptingInterface

Initiates the quit action to terminate the program.

Specified by:

quit in interface IScriptingInterface

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.