Logo

Getting started

  • Handling Errors
  • Hardware requirements
  • Getting Started
    • Installation
    • Interface
      • System menu and Getting Started Tour
      • Navigation
        • Controlling the Camera
        • Orbital Navigation and Focus
        • Leaving the Solar System
      • Time
        • Keyboard Shortcuts
        • Time Menu
        • Time Options in the Settings Menu
        • Video
  • FAQ
    • Windows
      • 1. Low framerate on a computer with a modern dedicated graphics card
    • Using in Planetariums
      • 1. How do I get a fulldome (fisheye) output from OpenSpace?
      • 2. How can I save screenshots in a resolution higher than my screen resolution? For example, my computer screen can only display 1920x1080, but I want to capture 4096x4096 pngs using the session recording function.
      • 3. How can I get rid of the text and GUI elements in my planetarium display?
      • 4. How do I ensure that all the data sets I need are loaded before playing back a recorded path? Can I play back without an internet connection?
    • Related to running OpenSpace on MacOS, Linux and unsupported hardware
      • 1. Why do you only provide Intel Mac packages? Why not packages for Apple Silicon Macs?
      • 2. Does OpenSpace run on Linux?
      • 3. I don’t have an NVidia graphics card. Can I still run the Windows executable on my Windows laptop which has integrated Intel graphics?
      • 4. What keyboard shortcuts does OpenSpace support?

Using OpenSpace

  • Navigation
    • Joystick navigation
      • Xbox controller
      • PS4 controller
      • SpaceMouse
      • Customizing the joystick navigation
      • Issues and solutions
        • OpenSpace does not react to the controller input
        • OpenSpace keeps spinning even when the joysticks are not touched
        • Have an issue that is not included in this list?
    • Customizing the joystick navigation
      • Bind camera navigation to a joystick axis
      • Bind a property to a joystick axis
      • Bind a script to a joystick button
      • Setup new joystick type
        • Contribute your asset
    • PathNavigation - Simplifying navigation in OpenSpace
      • Flying to a target
      • Path types
        • Linear paths
      • Settings
      • Caveats
      • Creating paths through Lua Scripting
    • Idle Behavior
      • Footnotes
    • Touch Interface
      • INSTALL
      • USAGE
        • Gesture Legend
        • Menu Control
      • BASIC DESCRIPTION OF SOURCE CODE
        • TuioEar
        • TouchMarker
        • TouchInteraction
  • Properties
    • ViewOptions
  • Scene Graph
  • Events
    • Action Trigger
    • Event Types
      • SceneGraphNodeAdded
      • SceneGraphNodeRemoved
      • ParallelConnection
      • ProfileLoadingFinished
      • ApplicationShutdown
      • ScreenSpaceRenderableAdded
      • ScreenSpaceRenderableRemoved
      • CameraFocusTransition
      • TimeOfInterestReached
      • MissionEventReached
      • PlanetEclipsed
      • InterpolationFinished
      • FocusNodeChanged
      • LayerAdded
      • LayerRemoved
      • SessionRecordingPlayback
      • PointSpacecraft
      • RenderableEnabled
      • RenderableDisabled
      • CameraPathStarted
      • CameraPathFinished
      • CameraMovedPosition
      • ScheduledScriptExecuted
      • Custom
  • Scripting
    • Console
      • Basic Use
      • Command Expansion / Globbing with Properties
        • Example
      • Tagging
        • Examples
      • The Script Log
  • User
    • Table of Contents
      • Using the Menus - Datasets
        • Finding Datasets
        • Enabling and Disabling Datasets
        • Manipulating Datasets
        • Video
      • Using the Menus - Globebrowsing
        • Globe Properties
        • Layers and their Settings
        • Layer Ordering and Blending
        • Lighting Conditions
        • Atmospheres
        • Special Layers on Earth
        • Video
      • Customizing Bookmarks
      • Customizing Profiles
        • Add an asset
        • Change the initial Camera Position
  • Installers
    • Dual monitors with fullscreen display
      • Notes
    • Controlling OpenSpace remotely
    • E&S Site Configuration
      • Installing & Running OpenSpace in a COSM/E&S Digistar Dome
        • Typical System Overview
        • Configure All Digistar Computers Prior to OpenSpace Installation
        • Create a Staging Directory for the OpenSpace installation
        • Configure C-Troll
        • Copy Staging Directory to All Digistar Computers
        • Running OpenSpace on the Entire System
  • Builders
    • Create and display a “Water Moon”
    • Use a fulldome image in OpenSpace
      • 1. Convert the fulldome frame to a 360 image
      • 2. Create a renderable sphere
      • 3. Move the camera

Profiles

  • Profiles
    • Apollo
      • Keyboard Shortcuts
    • Artemis
    • Asteroids
    • Bastille Day 2000
      • Keybinds
    • Dawn
    • Default
    • Default (full)
    • Eclipse
    • Empty Profile
    • Gaia
    • Juice
    • Juno
    • James Webb Space Telescope
    • Mars
    • Messenger
    • New Horizons
      • Keyboard Shortcuts
    • Night Sky
    • Offline
    • OSIRIS-REx
      • Keyboard Shortcuts
    • Rosetta
      • Keyboard Shortcuts
    • Solar Storm 2012
      • Keyboard Shortcuts
    • Touch
      • Story Selection
      • Using the Menu Bar
        • Menu Interface Elements Common to All Stories
        • Menu Interface Elements Unique to Stories
      • Info Buttons
    • Voyager

Content

  • Content
    • Profile Syntax
      • Sections
        • Version
        • Modules
        • Assets
        • Properties
        • Keybindings
        • Time
        • Camera
        • Mark Nodes
        • AdditionalScripts
        • Meta
        • Delta Times (a.k.a. ‘Simulation Time Increments’)
      • Example
    • Asteroids
      • How to add Asteroids/Comets to OpenSpace
      • Running OpenSpace with Asteroids/Comets
      • Additional Features
      • Asteroid Content Categories
        • Amor Asteroids
        • Apollo Asteroids
        • Aten Asteroids
        • Atira Asteroids
        • Centaur Asteroids
        • Chiron-Type Comets
        • Encke-Type Comets
        • Halley-Type Comets
        • Inner Main Asteroid Belt
        • Jupiter Family Comets
        • Jupiter Trojan Asteroids
        • Main Asteroid Belt
        • Mars Crossing Asteroids
        • Outer Main Asteroid Belt
        • Potentially Hazardous Asteroids (PHAs)
        • Trans-Neptunian Asteroids
    • Exoplanets
      • About the Exoplanets Module
      • Adding exoplanet systems to OpenSpace
      • About the visualizations
        • Resources
    • Sky Browser
      • Browser
      • Target
      • Image list
      • Tab buttons
      • Display Copies
      • General Settings
    • Gaia
      • Define which profile to run
      • Run OpenSpace
        • File Path
        • Render Option
        • Shader Option
        • Thresholds
        • Rendered stars
        • Luminosity multiplier
        • LOD Pixel Threshold
        • Max GPU Memory
        • Filter Size & Normal Distribution Sigma (for Points Shader Option)
        • Billboard Size & Close-up Boost Distance (for Billboards Shader Option)
      • Advanced Instructions for Defining What Dataset to Render
      • How to create new subsets from Gaia DR2 and how to render them (or your own star data) in OpenSpace
        • (Possibly) Download datasets
        • Get the data in a readable format
        • Read the raw data
        • Construct the octree
        • Run in OpenSpace
    • Globebrowsing
      • Builders
        • Working With Layers
        • Globe Geometry Features from GeoJson Files
        • Creation
        • WMS
    • Solar Video Overlay
      • Source of Corona Video
      • Create an Asset File for the Coronoa Video
      • Add the Downloaded Video File
      • Create a Profile With The Corona Asset
    • Point Data
      • Rendering Point Data
        • Loading Point Datasets
        • Coloring
        • Adding a Texture
        • Outlines
        • Controlling the Point Size
        • Fading
        • Orientation
        • Specializations of RenderablePointCloud
      • Labels
        • Unit
        • Appearance
      • File Formats
        • CSV
        • SPECK (.speck)
        • Labels (.label)
        • Color Maps (.cmap)
        • Texture Map (.tmap)
      • Advanced Rendering
        • Using Multiple Textures
        • Orientation From Data
    • Session Recording
      • Recording a Session
      • Playback of a Recorded Session
      • Session Recording Advanced Features
        • Console Script Commands
        • Playback Using Advanced Time Options
        • Known Issues
        • ASCII File Format
        • Saving Screen Frames for Offline Movie Rendering
        • File Conversion
        • File Extensions
        • Comment Lines
    • Satellites
      • Automation
      • Customizing the Satellites Module
      • Adding new Satellite Data to OpenSpace
      • Selectively Rendering Individual Satellites in a Group
      • Satellite Data from Celestrak
      • Satellites in the ‘default’ Profile
      • All Satellite Categories and Assets Included in OpenSpace
        • Communications
        • Debris
        • Misc
        • Navigation
        • Science
        • Weather
    • Renderable Stars
    • Ephemeris
      • Horizons GUI
        • The Horizons Tool
        • Issues and Solutions
      • Horizons Web
        • Downloading Ephemeris Data from JPL Horizons Site
        • Examine Downloaded Output
        • Data Usage
        • Create an Asset File
        • Add the Asset to OpenSpace
      • Kepler Translation
        • Create an Asset File
        • Add the Asset to OpenSpace
      • Asteroids
        • Adding New Asteroid or Comet Data to OpenSpace
        • Selective Rendering of Asteroids
        • Trail Rendering Settings
      • SBDB
        • Downloading Orbital Data from the JPL Small-Body Database (SBDB)
        • Data Usage
        • Create an Asset File
        • Add the Asset to OpenSpace

Creating data assets

  • Creating data assets
    • Assets
      • Asset lifecycle
        • Loading
        • Synchronization
        • Initialization
        • Deinitialization
      • Simple Example
      • Asset API Reference
        • Managing assets
        • Defining assets
    • Resources
      • What are resources?
      • Local resources
        • If your resource is in the same folder as the asset
        • If your resource is not located in the same folder as the asset
      • Synchronized resources
    • Models
      • How to load a model into OpenSpace
        • Formats
        • Debugging your model
        • List of formats
      • Scaling of models
        • Scale Down
        • Scale Up
        • Scale with Numbers
        • Summary
      • Animation in OpenSpace
        • Import model with animation
        • Settings
      • Breaking change in 0.17.0: Model Loading
        • Examples
        • RenderableModelProjection
        • Models
    • Data Synchronization
      • Data endpoint usage
      • Server arrangement
      • Usage example
    • Uniview Mod File Conversion
  • Custom web UI
    • HTML Controls Setup Guide
      • Required files
      • Setting up the HTML document
      • How to get OpenSpace commands from the script log
      • Other buttons
        • Fade to a location on a globe
        • Fade to a navigation state
        • Toggle button
      • Conditional formatting

Reference

  • Renderable Overview
  • All asset components
    • DashboardItem
      • DashboardItem
      • DashboardItemAngle
        • Members
        • Asset Examples
      • DashboardItemDate
        • Members
        • Asset Examples
      • DashboardItemDistance
        • Members
        • Asset Examples
      • DashboardItemElapsedTime
        • Asset Examples
      • DashboardItemFramerate
        • Members
        • Asset Examples
      • DashboardItemGlobeLocation
        • Asset Examples
      • DashboardItemInputState
        • Asset Examples
      • DashboardItemInstruments
        • Asset Examples
      • DashboardItemMission
        • Members
        • Asset Examples
      • DashboardItemParallelConnection
        • Members
        • Asset Examples
      • DashboardItemPropertyValue
        • Members
        • Asset Examples
      • DashboardItemSimulationIncrement
        • Members
        • Asset Examples
      • DashboardItemSpacing
        • Members
        • Asset Examples
      • DashboardItemText
        • Members
        • Asset Examples
      • DashboardItemVelocity
        • Members
        • Asset Examples
    • Decoder
      • Decoder
      • Instrument
      • Target
    • LightSource
      • CameraLightSource
        • Members
        • Asset Examples
      • LightSource
        • Members
      • SceneGraphLightSource
        • Members
        • Asset Examples
    • Other
      • ColorMappingComponent
        • Members
      • Configuration
        • Members
      • DataMapping
        • Members
      • GeoJsonComponent
        • Members
      • GeoJsonManager
      • GeoJsonProperties
        • Members
      • GlobeLabelsComponent
        • Members
      • LabelsComponent
        • Members
      • Layer
        • Members
      • LayerAdjustment
        • Members
      • LayerManager
        • Members
      • LogFactory
        • Members
      • MissionPhase
        • Members
      • NavigationState
        • Members
      • PathInstruction
        • Members
      • ProjectionComponent
        • Members
      • RingsComponent
        • Members
      • SceneGraphNode
        • Members
      • ShadowComponent
        • Members
      • SizeMappingComponent
        • Members
      • State
        • Members
      • StateMachine
        • Members
      • TimeRange
        • Members
      • Transition
        • Members
    • Renderable
      • DataPlane
        • Members
      • DataSphere
        • Members
      • KameleonPlane
        • Members
      • Renderable
        • Members
      • RenderableAtmosphere
        • Members
        • Asset Examples
      • RenderableBoxGrid
        • Members
        • Asset Examples
      • RenderableCartesianAxes
        • Members
        • Asset Examples
      • RenderableConstellationBounds
        • Members
        • Asset Examples
      • RenderableConstellationLines
        • Members
        • Asset Examples
      • RenderableCrawlingLine
        • Members
        • Asset Examples
      • RenderableDebugPlane
        • Members
      • RenderableDisc
        • Members
        • Asset Examples
      • RenderableDistanceLabel
        • Members
      • RenderableDUMeshes
        • Members
        • Asset Examples
      • RenderableEclipseCone
        • Members
        • Asset Examples
      • RenderableFieldlines
        • Members
      • RenderableFieldlinesSequence
        • Members
        • Asset Examples
      • RenderableFluxNodes
        • Members
        • Asset Examples
      • RenderableFov
        • Members
        • Asset Examples
      • RenderableGaiaStars
        • Members
        • Asset Examples
      • RenderableGalaxy
        • Members
        • Asset Examples
      • RenderableGlobe
        • Members
        • Asset Examples
      • RenderableGrid
        • Members
        • Asset Examples
      • RenderableHabitableZone
        • Members
        • Asset Examples
      • RenderableInterpolatedPoints
        • Members
        • Asset Examples
      • RenderableKameleonVolume
        • Members
      • RenderableLabel
        • Members
        • Asset Examples
      • RenderableModel
        • Members
        • Asset Examples
      • RenderableModelProjection
        • Members
        • Asset Examples
      • RenderableMultiresVolume
        • Members
      • RenderableNodeArrow
        • Members
        • Asset Examples
      • RenderableNodeLine
        • Members
        • Asset Examples
      • RenderableOrbitalKepler
        • Members
        • Asset Examples
      • RenderableOrbitDisc
        • Members
      • RenderablePlaneImageLocal
        • Members
        • Asset Examples
      • RenderablePlaneImageOnline
        • Members
        • Asset Examples
      • RenderablePlaneProjection
        • Members
        • Asset Examples
      • RenderablePlaneSpout
        • Members
        • Asset Examples
      • RenderablePlaneTimeVaryingImage
        • Members
        • Asset Examples
      • RenderablePlanetProjection
        • Members
        • Asset Examples
      • RenderablePointCloud
        • Members
        • Asset Examples
      • RenderablePolygonCloud
        • Members
        • Asset Examples
      • RenderablePrism
        • Members
        • Asset Examples
      • RenderableRadialGrid
        • Members
        • Asset Examples
      • RenderableRings
        • Members
      • RenderableShadowCylinder
        • Members
        • Asset Examples
      • RenderableSkyTarget
        • Members
      • RenderableSphereImageLocal
        • Members
        • Asset Examples
      • RenderableSphereImageOnline
        • Members
        • Asset Examples
      • RenderableSphereSpout
        • Members
        • Asset Examples
      • RenderableSphericalGrid
        • Members
        • Asset Examples
      • RenderableStars
        • Members
        • Asset Examples
      • RenderableTimeVaryingSphere
        • Members
        • Asset Examples
      • RenderableTimeVaryingVolume
        • Members
        • Asset Examples
      • RenderableToyVolume
        • Members
        • Asset Examples
      • RenderableTrailOrbit
        • Members
        • Asset Examples
      • RenderableTrailTrajectory
        • Members
        • Asset Examples
      • RenderableTravelSpeed
        • Members
        • Asset Examples
      • RenderableVideoPlane
        • Members
        • Asset Examples
      • RenderableVideoSphere
        • Members
        • Asset Examples
      • TexturePlane
        • Members
    • ResourceSynchronization
      • HttpSynchronization
        • Members
        • Asset Examples
      • ResourceSynchronization
      • UrlSynchronization
        • Members
        • Asset Examples
    • Rotation
      • ConstantRotation
        • Members
        • Asset Examples
      • FixedRotation
        • Members
        • Asset Examples
      • GlobeRotation
        • Members
        • Asset Examples
      • LuaRotation
        • Members
        • Asset Examples
      • Rotation
        • Members
      • SpiceRotation
        • Members
        • Asset Examples
      • StaticRotation
        • Members
        • Asset Examples
      • TimelineRotation
        • Members
        • Asset Examples
    • Scale
      • LuaScale
        • Members
        • Asset Examples
      • NonUniformStaticScale
        • Members
        • Asset Examples
      • Scale
        • Members
      • StaticScale
        • Members
        • Asset Examples
      • TimeDependentScale
        • Members
        • Asset Examples
    • ScreenSpaceRenderable
      • ScreenSpaceBrowser
        • Members
        • Asset Examples
      • ScreenSpaceCygnet
        • Members
      • ScreenSpaceDashboard
        • Members
        • Asset Examples
      • ScreenSpaceFramebuffer
        • Members
      • ScreenSpaceImageLocal
        • Members
        • Asset Examples
      • ScreenSpaceImageOnline
        • Members
      • ScreenSpaceRenderable
        • Members
      • ScreenSpaceSkyBrowser
        • Members
      • ScreenSpaceSpout
        • Members
      • ScreenSpaceVideo
        • Members
        • Asset Examples
    • Task
      • ConstructOctreeTask
        • Members
      • ConvertRecFileVersionTask
        • Members
      • ConvertRecFormatTask
        • Members
      • ExoplanetsDataPreparationTask
        • Members
      • GenerateRawVolumeTask
        • Members
      • KameleonDocumentationTask
        • Members
      • KameleonMetadataToJsonTask
        • Members
      • KameleonVolumeToRawTask
        • Members
      • MilkywayConversionTask
        • Members
      • MilkywayPointsConversionTask
        • Members
      • ReadFitsTask
        • Members
      • ReadSpeckTask
        • Members
      • Task
        • Members
    • TileProvider
      • DefaultTileProvider
        • Members
      • ImageSequenceTileProvider
        • Members
        • Asset Examples
      • SingleImageProvider
        • Members
      • SizeReferenceTileProvider
        • Members
        • Asset Examples
      • SpoutImageProvider
        • Asset Examples
      • TemporalTileProvider
        • Members
        • Asset Examples
      • TileIndexTileProvider
        • Members
        • Asset Examples
      • TileProvider
      • TileProviderByIndex
        • Members
        • Asset Examples
      • TileProviderByLevel
        • Members
        • Asset Examples
      • VideoTileProvider
        • Members
        • Asset Examples
    • TimeFrame
      • TimeFrame
        • Members
      • TimeFrameInterval
        • Members
        • Asset Examples
      • TimeFrameUnion
        • Members
        • Asset Examples
    • Translation
      • GlobeTranslation
        • Members
        • Asset Examples
      • GPTranslation
        • Members
        • Asset Examples
      • HorizonsTranslation
        • Members
        • Asset Examples
      • KeplerTranslation
        • Members
        • Asset Examples
      • LuaTranslation
        • Members
        • Asset Examples
      • SpiceTranslation
        • Members
        • Asset Examples
      • StaticTranslation
        • Members
        • Asset Examples
      • TimelineTranslation
        • Members
        • Asset Examples
      • Translation
        • Members
  • Scripting API
    • openspace
      • Functions overview
      • Functions
        • absPath
        • addCustomProperty
        • addSceneGraphNode
        • addScreenSpaceRenderable
        • addTag
        • addToPropertyValue
        • appendToListProperty
        • bindKey
        • boundingSphere
        • clearKey
        • clearKeys
        • configuration
        • createDirectory
        • createSingleColorImage
        • directoryExists
        • directoryForPath
        • downloadFile
        • dpiScaling
        • fadeIn
        • fadeOut
        • fileExists
        • getProperty
        • getPropertyValue
        • hasMission
        • hasProperty
        • hasSceneGraphNode
        • interactionSphere
        • invertBooleanProperty
        • isMaster
        • keyBindings
        • layerServer
        • loadJson
        • loadMission
        • makeIdentifier
        • markInterestingNodes
        • markInterestingTimes
        • nodeByRenderableType
        • printDebug
        • printError
        • printFatal
        • printInfo
        • printTrace
        • printWarning
        • property
        • propertyValue
        • readCSVFile
        • readFile
        • rebindKey
        • removeCustomProperty
        • removeInterestingNodes
        • removeSceneGraphNode
        • removeSceneGraphNodesFromRegex
        • removeScreenSpaceRenderable
        • removeTag
        • resetCamera
        • resetScreenshotNumber
        • saveSettingsToProfile
        • sceneGraphNodes
        • screenSpaceRenderables
        • setCurrentMission
        • setDefaultDashboard
        • setDefaultGuiSorting
        • setParent
        • setPathToken
        • setPropertyValue
        • setPropertyValueSingle
        • setScreenshotFolder
        • takeScreenshot
        • toggleFade
        • toggleShutdown
        • unloadMission
        • unzipFile
        • version
        • walkDirectory
        • walkDirectoryFiles
        • walkDirectoryFolders
        • worldPosition
        • worldRotation
        • writeDocumentation
    • openspace.action
      • Functions overview
      • Functions
        • action
        • actions
        • hasAction
        • registerAction
        • removeAction
        • triggerAction
    • openspace.asset
      • Functions overview
      • Functions
        • add
        • allAssets
        • isLoaded
        • remove
        • removeAll
        • rootAssets
    • openspace.audio
      • Functions overview
      • Functions
        • currentlyPlaying
        • globalVolume
        • isLooping
        • isPaused
        • isPlaying
        • pauseAll
        • pauseAudio
        • playAllFromStart
        • playAudio
        • playAudio3d
        • resumeAll
        • resumeAudio
        • set3dListenerPosition
        • set3dSourcePosition
        • setGlobalVolume
        • setLooping
        • setSpeakerPosition
        • setVolume
        • speakerPosition
        • stopAll
        • stopAudio
        • volume
    • openspace.dashboard
      • Functions overview
      • Functions
        • addDashboardItem
        • addDashboardItemToScreenSpace
        • clearDashboardItems
        • removeDashboardItem
        • removeDashboardItemsFromScreenSpace
    • openspace.debugging
      • Functions overview
      • Functions
        • addCartesianAxes
        • removePathControlPoints
        • removeRenderedCameraPath
        • renderCameraPath
        • renderPathControlPoints
    • openspace.event
      • Functions overview
      • Functions
        • disableEvent
        • enableEvent
        • registeredEvents
        • registerEventAction
        • unregisterEventAction
    • openspace.exoplanets
      • Functions overview
      • Functions
        • addExoplanetSystem
        • getListOfExoplanets
        • listAvailableExoplanetSystems
        • listOfExoplanets
        • loadExoplanetsFromCsv
        • removeExoplanetSystem
    • openspace.gaia
      • Functions overview
      • Functions
        • addClippingBox
        • addClippingSphere
        • removeClippingBox
    • openspace.globebrowsing
      • Functions overview
      • Functions
        • addBlendingLayersFromDirectory
        • addFocusNodeFromLatLong
        • addFocusNodesFromDirectory
        • addGeoJson
        • addGeoJsonFromFile
        • addGibsLayer
        • addLayer
        • capabilitiesWMS
        • createGibsGdalXml
        • createTemporalGibsGdalXml
        • deleteGeoJson
        • deleteLayer
        • flyToGeo
        • flyToGeo2
        • geoPositionForCamera
        • getGeoPositionForCamera
        • getLayers
        • getLocalPositionFromGeo
        • goToChunk
        • goToGeo
        • jumpToGeo
        • layers
        • loadWMSCapabilities
        • loadWMSServersFromFile
        • localPositionFromGeo
        • moveLayer
        • parseInfoFile
        • removeWMSServer
        • setNodePosition
        • setNodePositionFromCamera
    • openspace.iswa
      • Functions overview
      • Functions
        • addCdfFiles
        • addCygnet
        • addKameleonPlanes
        • addScreenSpaceCygnet
        • removeCygnet
        • removeGroup
        • removeScreenSpaceCygnet
        • setBaseUrl
    • openspace.modules
      • Functions overview
      • Functions
        • isLoaded
    • openspace.navigation
      • Functions overview
      • Functions
        • addGlobalRoll
        • addGlobalRotation
        • addLocalRoll
        • addLocalRotation
        • addTruckMovement
        • axisDeadzone
        • bindJoystickAxis
        • bindJoystickAxisProperty
        • bindJoystickButton
        • clearJoystickButton
        • distanceToFocus
        • distanceToFocusBoundingSphere
        • distanceToFocusInteractionSphere
        • getNavigationState
        • joystickAxis
        • joystickButton
        • listAllJoysticks
        • loadNavigationState
        • retargetAim
        • retargetAnchor
        • saveNavigationState
        • setAxisDeadZone
        • setNavigationState
        • targetNextInterestingAnchor
        • targetPreviousInterestingAnchor
        • triggerIdleBehavior
    • openspace.openglCapabilities
      • Functions overview
      • Functions
        • extensions
        • glslCompiler
        • gpuVendor
        • hasOpenGLVersion
        • isExtensionSupported
        • max2DTextureSize
        • max3DTextureSize
        • maxAtomicCounterBufferBindings
        • maxShaderStorageBufferBindings
        • maxTextureUnits
        • maxUniformBufferBindings
        • openGLVersion
    • openspace.orbitalnavigation
      • Functions overview
      • Functions
        • setRelativeMaxDistance
        • setRelativeMinDistance
    • openspace.parallel
      • Functions overview
      • Functions
        • connect
        • disconnect
        • joinServer
        • requestHostship
        • resignHostship
    • openspace.pathnavigation
      • Functions overview
      • Functions
        • continuePath
        • createPath
        • flyTo
        • flyToHeight
        • flyToNavigationState
        • isFlying
        • jumpTo
        • jumpToNavigationState
        • pausePath
        • skipToEnd
        • stopPath
        • zoomToDistance
        • zoomToDistanceRelative
        • zoomToFocus
    • openspace.scriptScheduler
      • Functions overview
      • Functions
        • clear
        • loadFile
        • loadScheduledScript
        • scheduledScripts
        • setModeApplicationTime
        • setModeRecordedTime
        • setModeSimulationTime
    • openspace.sessionRecording
      • Functions overview
      • Functions
        • disableTakeScreenShotDuringPlayback
        • enableTakeScreenShotDuringPlayback
        • fileFormatConversion
        • isPlayingBack
        • isRecording
        • setPlaybackPause
        • startPlayback
        • startPlaybackApplicationTime
        • startPlaybackRecordedTime
        • startPlaybackSimulationTime
        • startRecording
        • startRecordingAscii
        • stopPlayback
        • stopRecording
        • togglePlaybackPause
    • openspace.skybrowser
      • Functions overview
      • Functions
        • addDisplayCopy
        • addPairToSkyBrowserModule
        • adjustCamera
        • centerTargetOnScreen
        • createTargetBrowserPair
        • disableHoverCircle
        • finetuneTargetPosition
        • getListOfImages
        • getTargetData
        • getWwtImageCollectionUrl
        • initializeBrowser
        • listOfImages
        • loadImagesToWWT
        • loadingImageCollectionComplete
        • moveCircleToHoverImage
        • reloadDisplayCopyOnNode
        • removeDisplayCopy
        • removeSelectedImageInBrowser
        • removeTargetBrowserPair
        • scrollOverBrowser
        • selectImage
        • sendOutIdsToBrowsers
        • setBorderColor
        • setBorderRadius
        • setBrowserRatio
        • setEquatorialAim
        • setHoverCircle
        • setImageLayerOrder
        • setOpacityOfImageLayer
        • setSelectedBrowser
        • setVerticalFov
        • showAllTargetsAndBrowsers
        • startFinetuningTarget
        • startSetup
        • stopAnimations
        • targetData
        • translateScreenSpaceRenderable
        • wwtImageCollectionUrl
    • openspace.space
      • Functions overview
      • Functions
        • convertFromRaDec
        • convertToRaDec
        • readKeplerFile
        • tleToSpiceTranslation
    • openspace.spice
      • Functions overview
      • Functions
        • convertTLEtoSPK
        • kernels
        • loadKernel
        • position
        • rotationMatrix
        • spiceBodies
        • unloadKernel
    • openspace.statemachine
      • Functions overview
      • Functions
        • canGoToState
        • createStateMachine
        • currentState
        • destroyStateMachine
        • goToState
        • possibleTransitions
        • printCurrentStateInfo
        • saveToDotFile
        • setInitialState
    • openspace.sync
      • Functions overview
      • Functions
        • syncResource
        • unsyncResource
    • openspace.systemCapabilities
      • Functions overview
      • Functions
        • cacheLineSize
        • cacheSize
        • cores
        • extensions
        • fullOperatingSystem
        • installedMainMemory
        • L2Associativity
        • os
    • openspace.time
      • Functions overview
      • Functions
        • advancedTime
        • convertTime
        • currentApplicationTime
        • currentTime
        • currentWallTime
        • deltaTime
        • interpolateDeltaTime
        • interpolateNextDeltaTimeStep
        • interpolatePause
        • interpolatePreviousDeltaTimeStep
        • interpolateTime
        • interpolateTimeRelative
        • interpolateTogglePause
        • isPaused
        • pauseToggleViaKeyboard
        • setDeltaTime
        • setDeltaTimeSteps
        • setNextDeltaTimeStep
        • setPause
        • setPreviousDeltaTimeStep
        • setTime
        • SPICE
        • togglePause
        • UTC

Contribute

  • Development
    • Compiling
      • Windows
        • Development Tools
        • Dependencies
        • Notes
      • Ubuntu
        • Development Tools
        • Dependencies
        • Compile OpenSpace
        • Outdated Versions of Ubuntu
        • Troubleshooting
      • MacOS
        • Development Tools
        • Dependencies
        • Compiling
      • FreeBSD
        • Developer Tools
        • Dependencies
      • Fedora
        • Development Tools
        • Dependencies
        • Compile OpenSpace
      • 0. Hardware requirements
      • 1. Development Tools
        • Git Client
        • CMake
        • Compiler / IDE
      • 2. Dependencies
      • 3. Compiling
      • 4. After compiling
      • 5. FAQ
    • Tools
      • Visual Studio Tips and Tricks
        • Detecting Exceptions
        • Breaking on floating point exceptions
        • Disabling optimizations for a particlar part of code
        • Command Palette
    • Dependencies
      • LibMPV
    • Coding Style
      • General
        • 1. Violations to the guidelines are allowed if it enhances readability of the code
        • 2. Class and method headers must include Doxygen-style comments
        • 3. File content must be kept within 90 columns
        • 4. All TABs must be 4 spaces
        • 5. Use the auto keyword sparingly
        • 6. Use // for all comments, including multi-line comments
      • Naming
        • 7. Negated boolean variable names should be avoided
        • 8. Enumerations must not be in upper case and should be strongly typed
        • 9. Names for methods or functions must be verbs and written in CamelCase starting with lower case
        • 10. Names representing namespaces must be all lowercase and should not be nested deeper than two levels
        • 11. Abbreviations in names must be avoided
        • 12. Private class variables must have underscore prefix if part of a larger class
        • 13. The length of a variable name should correspond to the length of its scope
        • 14. The terms get/set must be used where an attribute is accessed. The prefix ‘get’ must be omitted in case the value is returned. ‘get’ is only to be used when the value is returned in a referenced parameter
        • 15. The prefix n should be used for variables representing a number of objects
        • 16. The prefix i should be used for variables representing an entity number
        • 17. The prefixes is, has, should, or can should be used for boolean variables and methods
        • 18. Abbreviations and acronyms must not be uppercase when used as name
      • Structure
        • 19. #include statements should be at the top of the file, sorted and grouped
        • 20. The parts of a class must be sorted public, protected and private
        • 21. Type conversions must always be done explicitly
        • 22. All definitions must reside in source or inline files
        • 23. Implicit test for 0 should only be used for boolean variables and pointer-types
        • 24. Complex conditional expressions should be avoided. Introduce constant temporary boolean variables instead
        • 25. Executable statements in conditionals should be avoided
        • 26. The use of magic values in the code should be avoided
        • 27. nullptr must be used instead of 0 or NULL for declaring null pointer
      • Doxygen Comments
        • 1. Overall structure for Doxygen comments:
        • 2. Use \ for commands instead of @
        • 3. Use singular version of commands
        • 4. Member variables and enum members are documented with ///, everything else with /**  */
        • 5. The description text ends with a ., everything else does not have a period at end
        • 6. No separate \brief section
        • 7. Capitalization
        • 8. No documentation for namespaces
        • Example
      • Best Practices
        • Standard library is your friend
        • Keep it simple, sailor
      • File formatting
        • Handling line breaks
        • Constructor layout
    • Code Structure
      • Libraries
      • Classes
      • Assets
        • Simple Example
        • Advanced Example
    • Deploying Windows
      • Deploy OpenSpace
    • Folder Layout
      • Source Code
      • Settings
    • Pull Requests
    • Git Branch Naming Conventions
    • C++ Musings
      • Returning by const reference for large objects is better than hoping for copy elision
      • Defining textual constants as const char* or constexpr const char* is better than std::string
    • Skybrowser Webpage Design
      • Architecture overview
      • Messages to and from WorldWideTelescope
    • WebRTC
      • Streaming User Guide
        • Initial Setup
        • Starting a Remote Viewing Session
      • Streaming Structure and Good-To-Knows
        • OpenSpace Front-end
        • OpenSpace Application
        • GStreamer
  • FAQ
    • Configuration
      • Is it possible to run OpenSpace in kiosk mode and mask the display area ?
    • Wormhole
      • Is there a way to configure the Wormhole to fixate the passwords for connection & host? I would like to automate the connecting process, but I guess that is not possible with the random password generation at each start?
    • Compiling
      • MacOS
        • While running CMake , No CMAKE_C_COMPILER could be found or No CMAKE_CXX_COMPILER could be found
  • Documentation
    • How to build the documentation locally
      • Build the documentation locally
      • Generate OpenSpace reference (optional)
    • Kitchen Sink
      • Markup
        • Heading without TOC entry
        • Subscript/Superscript
        • Abbreviations
        • Commands
        • Keystrokes
        • Menu Selection
        • Inline comments
        • Icons embedding
      • Tables
        • Markdown-style
        • MyST style
        • Multi-column table
      • Links
        • Footnotes
      • Images
        • Markdown
        • Centering images
        • Captions
        • Dark and Light theme
      • Videos
      • Callouts
      • Sidebar
      • Markups
      • Code Highlighting
        • Default language
        • Different language
        • Line number and captions
        • Highlight lines
        • Function defintions
      • Math
      • Cards
      • Carousels
      • Dropdown
        • No Title
        • With title
        • Standard open
      • Buttons
      • Tabs
      • Diagram
      • Glossary
      • Section Labels
      • Include files
        • Verbatim include
        • Include file with syntax highlighting
    • Field List examples
      • Required reading
      • Recommended reading

Community

  • Community

Glossary

  • Glossary

About

  • Academics
    • Papers
    • Theses
    • Contact
  • Version Overview
    • 0.20.1
      • Features
      • User Interface
      • Content
      • Lua (Scripting)
      • Bug Fixes
      • Breaking Changes
      • Updated Hierarchy in Scene Menu
    • 0.20.0
      • New Features
      • Enhancements
      • UI Improvements
      • Content Creation
      • Content and Assets
      • Bug Fixes
      • Breaking Changes
        • Details on Breaking Changes
    • 0.19.2
      • Content
      • Bug Fixes
    • 0.19.1
      • Features
      • Launcher
      • User Interface
      • Content
      • Lua (Scripting)
      • Bug Fixes
    • 0.19.0
      • New content
        • Improvements to existing content
      • New features
      • Bug fixes
    • 0.18.2
    • 0.18.1
    • 0.18.0
      • New content
        • Improvements to existing content
      • New features
        • SkyBrowser
        • Fly-to and Zoom-to
        • Actions
        • Event System
      • User interface improvements
      • Bug fixes
    • 0.17.2
    • 0.17.1
    • 0.17.0
      • New content
        • Exoplanet systems
        • James Webb Space Telescope profile
      • Improvements to existing content
      • New features
        • New Session Recording features
        • Better 3D models
        • Logarithmic sliders
        • Color picker
        • User folder
        • More obvious shutdown message
        • Font size on-screen info text can be adjusted
        • Equirectangular configuration
        • Select scripts in profile editor
      • Bug fixes
    • 0.16.1
      • New features and content
        • Drag and drop support
        • Phobos and Deimos maps
        • Import Hub content
      • Bug fixes
    • 0.16.0
      • OpenSpace Launcher
      • Editing profiles
        • Properties
        • Assets
        • Keybindings
        • Meta
        • Mark Interesting Nodes
        • Simulation Time Increments
        • Set Camera Position
        • Time
        • Modules
        • Additional Scripts
      • New features and content
        • Asset meta information
        • New exoplanets menu
        • Orion Nebula model
        • GlobeBrowsing layers
        • New time menu GUI and shortcut to go backward in time
        • New radial grid and easier planar grid
        • Updated Mars HiRISE map
        • Navigate from Web GUI
      • C-Troll
  • Links
    • OpenSpace Links
    • Documentation Links
    • Data Links
      • Map Data
      • Orbital Data
      • Trajectory Data
      • Testing Servers
OpenSpace
  • Scripting API
  • Edit on GitHub

Scripting API

Libraries

  • openspace
  • openspace.action
  • openspace.asset
  • openspace.audio
  • openspace.dashboard
  • openspace.debugging
  • openspace.event
  • openspace.exoplanets
  • openspace.gaia
  • openspace.globebrowsing
  • openspace.iswa
  • openspace.modules
  • openspace.navigation
  • openspace.openglCapabilities
  • openspace.orbitalnavigation
  • openspace.parallel
  • openspace.pathnavigation
  • openspace.scriptScheduler
  • openspace.sessionRecording
  • openspace.skybrowser
  • openspace.space
  • openspace.spice
  • openspace.statemachine
  • openspace.sync
  • openspace.systemCapabilities
  • openspace.time
Previous Next

© Copyright 2014-2024, OpenSpace community.

Built with Sphinx using a theme provided by Read the Docs.