`openspace.skybrowser`

Functions overview

Name	Documentation
`addDisplayCopy`	Takes an identifier to a sky browser and adds a rendered copy to it
`addPairToSkyBrowserModule`	Takes the identifier of the sky target and a sky browser and adds them to the sky browser module
`adjustCamera`	Takes an identifier to a sky browser or sky target
`centerTargetOnScreen`	Takes an identifier to a sky browser and animates its corresponding target to the center of the current view
`createTargetBrowserPair`	Creates a sky browser and a target
`disableHoverCircle`	Disables the hover circle, if there is one added to the sky browser module
`finetuneTargetPosition`	Finetunes the target depending on a mouse drag
`getListOfImages`	Deprecated in favor of ‘listOfExoplanets’
`getTargetData`	Deprecated in favor of ‘targetData’
`getWwtImageCollectionUrl`	Deprecated in favor of ‘wwtImageCollectionUrl’
`initializeBrowser`	Takes an identifier to a sky browser and starts the initialization for that browser
`listOfImages`	Returns a list of all the loaded AAS WorldWide Telescope images that have been loaded
`loadImagesToWWT`	Takes an identifier to a sky browser or target and loads the WWT image collection to that browser
`loadingImageCollectionComplete`	Sets the image collection as loaded in the sky browser
`moveCircleToHoverImage`	Moves the hover circle to the coordinate specified by the image index
`reloadDisplayCopyOnNode`	Reloads the sky browser display copy for the node index that is sent in
`removeDisplayCopy`	Takes an identifier to a sky browser and removes the latest added rendered copy to it
`removeSelectedImageInBrowser`	Takes an identifier to a sky browser or target and an index to an image
`removeTargetBrowserPair`	Takes in identifier to a sky browser or target and removes them
`scrollOverBrowser`	Takes an identifier to a sky browser or a sky target and a vertical field of view
`selectImage`	Takes an index to an image and selects that image in the currently selected sky browser
`sendOutIdsToBrowsers`	Sends all sky browsers’ identifiers to their respective CEF browser
`setBorderColor`	Takes an identifier to a sky browser or a sky target and a rgb color in the ranges [0, 255]
`setBorderRadius`	Takes an identifier to a sky browser and a radius value between 0 and 1, where 0 is rectangular and 1 is circular
`setBrowserRatio`	Sets the screen space size of the sky browser to the numbers specified by the input [x, y]
`setEquatorialAim`	Takes the identifier of a sky browser or a sky target and equatorial coordinates Right Ascension and Declination
`setHoverCircle`	Takes an identifier to a screen space renderable and adds it to the module
`setImageLayerOrder`	Takes an identifier to a sky browser or a sky target, an image index and the order which it should have in the selected image list
`setOpacityOfImageLayer`	Takes an identifier to a sky browser or sky target, an index to an image and a value for the opacity
`setSelectedBrowser`	Takes an identifier to a sky browser or target
`setVerticalFov`	Takes an identifier to a sky browser or a sky target and a vertical field of view
`showAllTargetsAndBrowsers`	Show or hide all targets and browsers
`startFinetuningTarget`	Starts the fine-tuning of the target rendered copy to it
`startSetup`	Starts the setup process of the sky browers
`stopAnimations`	Stop animations
`targetData`	Returns a table of data regarding the current view and the sky browsers and targets
`translateScreenSpaceRenderable`	Takes an identifier to a sky browser or sky target and the [x, y] starting position and the [x, y] translation vector
`wwtImageCollectionUrl`	Returns the AAS WorldWide Telescope image collection url

Functions

`addDisplayCopy`

Takes an identifier to a sky browser and adds a rendered copy to it. The first argument is the position of the first copy. The position is in RAE or Cartesian coordinates, depending on if ‘Use Radius Azimuth Elevation’ is checked. The second argument is the number of copies. If RAE is used, they will be evenly spread out on the azimuth.

Parameters

identifier String
numberOfCopies Integer? - Default value: 1
position vec3? - Default value: glm::vec3(2.1f, 0.f, 0.f)

Return type: void

Signature

openspace.skybrowser.addDisplayCopy(identifier, numberOfCopies, position)

`addPairToSkyBrowserModule`

Takes the identifier of the sky target and a sky browser and adds them to the sky browser module.

Parameters

targetId String
browserId String

Return type: void

Signature

openspace.skybrowser.addPairToSkyBrowserModule(targetId, browserId)

`adjustCamera`

Takes an identifier to a sky browser or sky target. Rotates the camera so that the target is placed in the center of the view.

Parameters

id String

Return type: void

Signature

openspace.skybrowser.adjustCamera(id)

`centerTargetOnScreen`

Takes an identifier to a sky browser and animates its corresponding target to the center of the current view.

Parameters

identifier String

Return type: void

Signature

openspace.skybrowser.centerTargetOnScreen(identifier)

`createTargetBrowserPair`

Creates a sky browser and a target.

Return type: void

Signature

openspace.skybrowser.createTargetBrowserPair()

`disableHoverCircle`

Disables the hover circle, if there is one added to the sky browser module.

Return type: void

Signature

openspace.skybrowser.disableHoverCircle()

`finetuneTargetPosition`

Finetunes the target depending on a mouse drag. rendered copy to it. First argument is the identifier of the sky browser, second is the start position of the drag and third is the end position of the drag.

Parameters

identifier String
translation vec2

Return type: void

Signature

openspace.skybrowser.finetuneTargetPosition(identifier, translation)

`getListOfImages`

Deprecated in favor of ‘listOfExoplanets’

Return type: Table

Signature

openspace.skybrowser.getListOfImages()

`getTargetData`

Deprecated in favor of ‘targetData’

Return type: Table

Signature

openspace.skybrowser.getTargetData()

`getWwtImageCollectionUrl`

Deprecated in favor of ‘wwtImageCollectionUrl’

Return type: Table

Signature

openspace.skybrowser.getWwtImageCollectionUrl()

`initializeBrowser`

Takes an identifier to a sky browser and starts the initialization for that browser. That means that the browser starts to try to connect to the AAS WorldWide Telescope application by sending it messages. And that the target matches its appearance to its corresponding browser.

Parameters

identifier String

Return type: void

Signature

openspace.skybrowser.initializeBrowser(identifier)

`listOfImages`

Returns a list of all the loaded AAS WorldWide Telescope images that have been loaded. Each image has a name, thumbnail url, equatorial spherical coordinates RA and Dec, equatorial Cartesian coordinates, if the image has celestial coordinates, credits text, credits url and the identifier of the image which is a unique number.

Return type: Table

Signature

openspace.skybrowser.listOfImages()

`loadImagesToWWT`

Takes an identifier to a sky browser or target and loads the WWT image collection to that browser.

Parameters

identifier String

Return type: void

Signature

openspace.skybrowser.loadImagesToWWT(identifier)

`loadingImageCollectionComplete`

Sets the image collection as loaded in the sky browser. Takes an identifier to the sky browser.

Parameters

identifier String

Return type: void

Signature

openspace.skybrowser.loadingImageCollectionComplete(identifier)

`moveCircleToHoverImage`

Moves the hover circle to the coordinate specified by the image index.

Parameters

imageUrl String

Return type: void

Signature

openspace.skybrowser.moveCircleToHoverImage(imageUrl)

`reloadDisplayCopyOnNode`

Reloads the sky browser display copy for the node index that is sent in. .If no ID is sent in, it will reload all display copies on that node.

Parameters

nodeIndex Integer
id String? - Default value: "all"

Return type: void

Signature

openspace.skybrowser.reloadDisplayCopyOnNode(nodeIndex, id)

`removeDisplayCopy`

Takes an identifier to a sky browser and removes the latest added rendered copy to it.

Parameters

identifier String

Return type: void

Signature

openspace.skybrowser.removeDisplayCopy(identifier)

`removeSelectedImageInBrowser`

Takes an identifier to a sky browser or target and an index to an image. Removes that image from that sky browser.

Parameters

identifier String
imageUrl String

Return type: void

Signature

openspace.skybrowser.removeSelectedImageInBrowser(identifier, imageUrl)

`removeTargetBrowserPair`

Takes in identifier to a sky browser or target and removes them.

Parameters

identifier String

Return type: void

Signature

openspace.skybrowser.removeTargetBrowserPair(identifier)

`scrollOverBrowser`

Takes an identifier to a sky browser or a sky target and a vertical field of view. Changes the field of view as specified by the input.

Parameters

identifier String
scroll Number

Return type: void

Signature

openspace.skybrowser.scrollOverBrowser(identifier, scroll)

`selectImage`

Takes an index to an image and selects that image in the currently selected sky browser.

Parameters

imageUrl String

Return type: void

Signature

openspace.skybrowser.selectImage(imageUrl)

`sendOutIdsToBrowsers`

Sends all sky browsers’ identifiers to their respective CEF browser.

Return type: void

Signature

openspace.skybrowser.sendOutIdsToBrowsers()

`setBorderColor`

Takes an identifier to a sky browser or a sky target and a rgb color in the ranges [0, 255].

Parameters

identifier String
red Integer
green Integer
blue Integer

Return type: void

Signature

openspace.skybrowser.setBorderColor(identifier, red, green, blue)

`setBorderRadius`

Takes an identifier to a sky browser and a radius value between 0 and 1, where 0 is rectangular and 1 is circular

Parameters

identifier String
radius Number

Return type: void

Signature

openspace.skybrowser.setBorderRadius(identifier, radius)

`setBrowserRatio`

Sets the screen space size of the sky browser to the numbers specified by the input [x, y].

Parameters

identifier String
ratio Number

Return type: void

Signature

openspace.skybrowser.setBrowserRatio(identifier, ratio)

`setEquatorialAim`

Takes the identifier of a sky browser or a sky target and equatorial coordinates Right Ascension and Declination. The target will animate to this coordinate and the browser will display the coordinate.

Parameters

identifier String
rightAscension Number
declination Number

Return type: void

Signature

openspace.skybrowser.setEquatorialAim(identifier, rightAscension, declination)

`setHoverCircle`

Takes an identifier to a screen space renderable and adds it to the module.

Parameters

identifier String

Return type: void

Signature

openspace.skybrowser.setHoverCircle(identifier)

`setImageLayerOrder`

Takes an identifier to a sky browser or a sky target, an image index and the order which it should have in the selected image list. The image is then changed to have this order.

Parameters

identifier String
imageUrl String
imageOrder Integer

Return type: void

Signature

openspace.skybrowser.setImageLayerOrder(identifier, imageUrl, imageOrder)

`setOpacityOfImageLayer`

Takes an identifier to a sky browser or sky target, an index to an image and a value for the opacity.

Parameters

identifier String
imageUrl String
opacity Number

Return type: void

Signature

openspace.skybrowser.setOpacityOfImageLayer(identifier, imageUrl, opacity)

`setSelectedBrowser`

Takes an identifier to a sky browser or target. Sets that sky browser currently selected.

Parameters

identifier String

Return type: void

Signature

openspace.skybrowser.setSelectedBrowser(identifier)

`setVerticalFov`

Takes an identifier to a sky browser or a sky target and a vertical field of view. Changes the field of view as specified by the input.

Parameters

identifier String
verticalFieldOfView Number

Return type: void

Signature

openspace.skybrowser.setVerticalFov(identifier, verticalFieldOfView)

`showAllTargetsAndBrowsers`

Show or hide all targets and browsers. Takes a boolean that sets it to either be shown or not.

Parameters

show Boolean

Return type: void

Signature

openspace.skybrowser.showAllTargetsAndBrowsers(show)

`startFinetuningTarget`

Starts the fine-tuning of the target rendered copy to it.

Parameters

identifier String

Return type: void

Signature

openspace.skybrowser.startFinetuningTarget(identifier)

`startSetup`

Starts the setup process of the sky browers. This function calls the Lua function ‘sendOutIdsToBrowsers’ in all nodes in the cluster.

Return type: void

Signature

openspace.skybrowser.startSetup()

`stopAnimations`

Stop animations. Takes an identifier to a sky browser.

Parameters

identifier String

Return type: void

Signature

openspace.skybrowser.stopAnimations(identifier)

`targetData`

Returns a table of data regarding the current view and the sky browsers and targets. returns a table of data regarding the current targets.

Return type: Table

Signature

openspace.skybrowser.targetData()

`translateScreenSpaceRenderable`

Takes an identifier to a sky browser or sky target and the [x, y] starting position and the [x, y] translation vector.

Parameters

identifier String
startingPositionX Number
startingPositionY Number
translationX Number
translationY Number

Return type: void

Signature

openspace.skybrowser.translateScreenSpaceRenderable(identifier, startingPositionX, startingPositionY, translationX, translationY)

`wwtImageCollectionUrl`

Returns the AAS WorldWide Telescope image collection url.

Return type: Table

Signature

openspace.skybrowser.wwtImageCollectionUrl()

openspace.skybrowser

Functions overview

Functions

`openspace.skybrowser`