Class UNIVERSE.EarthExtensions

Class Summary
Constructor Attributes Constructor Name and Description
 
UNIVERSE.EarthExtensions(universe, isSunLighting)
Extensions for doing Earth-based 3D modeling with Universe.js
Method Summary
Method Attributes Method Name and Description
 
Add a Tracing Line to the closest ground object for an Object
 
addEarth(dayImageURL, nightImageURL)
Add the Earth at the center of the Universe
 
addGroundDot(groundObject, color, size, callback)
Add an existing {UNIVERSE.GroundObject} as a static "ground dot".
 
addGroundObject(groundObject, callback)
Add a Ground Object to the Earth
 
addGroundTrackPointForObject(object, callback)
Add a Ground Track Point for an Object
 
addLineBetweenObjects(object1_id, object2_id, color, customIdentifier)
Add a Line between two graphics objects
 
addMoon(moonImageURL)
Add the Moon to the Universe
 
addPropogationLineForObject(object, callback)
Add a Propagation Line for an Object
 
addSensorFootprintProjection(spaceObject, callback)
Add sensor projection footprints for a specific sensor on a space object
 
addSensorFootprintProjections(spaceObject, callback)
Add sensor projection footprints for all sensors on a space object
 
addSensorProjection(object, spaceObject)
Add a Sensor Projection for an Object
 
addSensorProjections(spaceObject, callback)
Add sensor projections for a space object
 
addSensorVisibilityLines(spaceObject, callback)
Add Lines from a space object to objects in it's sensor FOVs to the Universe
 
addSpaceObject(spaceObject, callback)
Add a Space Object to the Universe
 
addStaticGroundDot(id, name, color, size, lat, lon, alt, callback)
Add a non-moving ground point to the universe.
 
Add the sun to the Universe at the correct position relative to the Earth-centered universe
 
Return the closest Ground Object to a location
 
Return the closest Object to a location
 
Lock the position of the camera relative to the Earth so that it appears that the Earth is not spinning
 
Remove all objects from the Universe except the Earth and Moon
 
Remove all Lines between two graphics objects
 
removeLineBetweenObjects(object1_id, object2_id, customIdentifier)
Remove a Line between two graphics objects
 
setSunLighting(isSunLighting)
Turn on or off sun lighting
 
Set up the Universe with the Earth Extensions
 
Enable or disable display of all ground tracks
 
Enable or disable display of all lines between objects
 
showAllOrbitLines(isEnabled)
Enable or disable all orbit lines
 
Enable or disable display of all sensor projections
 
Enable or disable display of all sensor projections
 
Enable or disable display of all lines between objects
 
showGroundTrackForId(id, isEnabled)
Enable or disable display of a ground track for an object
 
Enable or disable display of lines for an object
 
showModelForId(id, isEnabled)
Enable or disable display of an object
 
showOrbitLineForObject(id, isEnabled)
Enable or disable orbit lines for a specific object
 
Enable or disable display of sensor projections for an object
 
Enable or disable display of sensor projections for an object
 
Enable or disable display of sensor projections for an object
Class Detail
UNIVERSE.EarthExtensions(universe, isSunLighting)
Extensions for doing Earth-based 3D modeling with Universe.js
Parameters:
{UNIVERSE.Universe} universe
- The Universe to draw in
{boolean} isSunLighting
- Should the Earth be lit by the sun or not
Method Detail
addClosestGroundObjectTracingLine(object)
Add a Tracing Line to the closest ground object for an Object
Parameters:
{UNIVERSE.SpaceObject} object
- A Space Object to add a tracing line to the closest ground object for

addEarth(dayImageURL, nightImageURL)
Add the Earth at the center of the Universe
Parameters:
{string} dayImageURL
- URL of the image to be used for the sun-facing side of the Earth
{string} nightImageURL
- URL of the image to be used for the dark side of the Earth

addGroundDot(groundObject, color, size, callback)
Add an existing {UNIVERSE.GroundObject} as a static "ground dot".
Parameters:
{UNIVERSE.GroundObject} groundObject
- the GroundObject to be placed
{number} color
- the Hex RGB color to display the ground object with
{integer} size
- the size of the "dot"
{function} callback
- a function to be called when the dot is added

addGroundObject(groundObject, callback)
Add a Ground Object to the Earth
Parameters:
{UNIVERSE.GroundObject} groundObject
- an object to display on the Earth
{function} callback
- A function called at completion of the addition

addGroundTrackPointForObject(object, callback)
Add a Ground Track Point for an Object
Parameters:
{UNIVERSE.SpaceObject} object
- The Space Object to add a ground track point for
{function} callback
- A function called at completion of the addition

addLineBetweenObjects(object1_id, object2_id, color, customIdentifier)
Add a Line between two graphics objects
Parameters:
{string} object1_id
- starting object of the line
{string} object2_id
- end object of the line
{string} color
- color code in hex of the line between objects
{string} customIdentifier
- a specific identifier to put between objects in the id

addMoon(moonImageURL)
Add the Moon to the Universe
Parameters:
{string} moonImageURL
- the URL of the Moon image to use

addPropogationLineForObject(object, callback)
Add a Propagation Line for an Object
Parameters:
{UNIVERSE.SpaceObject} object
- A Space Object to add a propagation line for
{function} callback
- A function called at completion of the addition

addSensorFootprintProjection(spaceObject, callback)
Add sensor projection footprints for a specific sensor on a space object
Parameters:
{UNIVERSE.SpaceObject} spaceObject
- An orbiting object to add projections for
{function} callback
- A function called at completion of the addition

addSensorFootprintProjections(spaceObject, callback)
Add sensor projection footprints for all sensors on a space object
Parameters:
{UNIVERSE.SpaceObject} spaceObject
- An orbiting object to add projections for
{function} callback
- A function called at completion of the addition

addSensorProjection(object, spaceObject)
Add a Sensor Projection for an Object
Parameters:
{UNIVERSE.SpaceObject} object
- A Space Object to add a Sensor Projection for
spaceObject

addSensorProjections(spaceObject, callback)
Add sensor projections for a space object
Parameters:
{UNIVERSE.SpaceObject} spaceObject
- An orbiting object to add projections for
{function} callback
- A function called at completion of the addition

addSensorVisibilityLines(spaceObject, callback)
Add Lines from a space object to objects in it's sensor FOVs to the Universe
Parameters:
{UNIVERSE.SpaceObject} spaceObject
- An orbiting object to add to the Universe
{function} callback
- A function called at completion of the addition

addSpaceObject(spaceObject, callback)
Add a Space Object to the Universe
Parameters:
{UNIVERSE.SpaceObject} spaceObject
- An orbiting object to add to the Universe
{function} callback
- A function called at completion of the addition

addStaticGroundDot(id, name, color, size, lat, lon, alt, callback)
Add a non-moving ground point to the universe. This creates a new UNIVERSE.GroundObject for you, using the LLA coordinates given as parameters. Note that "ground point" can actually be off the surface of the earth (or, under, really). This function quickly lets you set various colors and sizes for the dot.
Parameters:
{object} id
- a unique identifier for the dot
{string} name
- a human-readable name for the dot
{number} color
- a hex value RGB color of the dot
{integer} size
- a size for the dot
{number} lat
- the LLA latitude coordinate
{number} lon
- the LLA longitude coordinate
{number} alt
- the LLA altitude coordinate
{function} callback
- a function called once the dot has been added

addSun()
Add the sun to the Universe at the correct position relative to the Earth-centered universe

findClosestGroundObject(location)
Return the closest Ground Object to a location
Parameters:
{UNIVERSE.ECICoordinates} location
- the location to find the closest point to

findClosestObject(location)
Return the closest Object to a location
Parameters:
{UNIVERSE.ECICoordinates} location
- the location to find the closest point to

lockCameraPositionRelativeToEarth(isLocked)
Lock the position of the camera relative to the Earth so that it appears that the Earth is not spinning
Parameters:
{boolean} isLocked

removeAllExceptEarthAndMoon()
Remove all objects from the Universe except the Earth and Moon

removeAllLinesBetweenObjects()
Remove all Lines between two graphics objects

removeLineBetweenObjects(object1_id, object2_id, customIdentifier)
Remove a Line between two graphics objects
Parameters:
{string} object1_id
- starting object of the line
{string} object2_id
- end object of the line
{string} customIdentifier
- a specific identifier to put between objects in the id

setSunLighting(isSunLighting)
Turn on or off sun lighting
Parameters:
{boolean} isSunLighting

setup()
Set up the Universe with the Earth Extensions

showAllGroundTracks(isEnabled)
Enable or disable display of all ground tracks
Parameters:
{boolean} isEnabled

showAllLinesBetweenObjects(isEnabled)
Enable or disable display of all lines between objects
Parameters:
{boolean} isEnabled

showAllOrbitLines(isEnabled)
Enable or disable all orbit lines
Parameters:
{boolean} isEnabled

showAllSensorFootprintProjections(isEnabled)
Enable or disable display of all sensor projections
Parameters:
{boolean} isEnabled

showAllSensorProjections(isEnabled)
Enable or disable display of all sensor projections
Parameters:
{boolean} isEnabled

showAllSensorVisibilityLines(isEnabled)
Enable or disable display of all lines between objects
Parameters:
{boolean} isEnabled

showGroundTrackForId(id, isEnabled)
Enable or disable display of a ground track for an object
Parameters:
{string} id
- identifier for the object
{boolean} isEnabled

showLineBetweenObjectsForId(id, isEnabled)
Enable or disable display of lines for an object
Parameters:
{string} id
- identifier for the object
{boolean} isEnabled

showModelForId(id, isEnabled)
Enable or disable display of an object
Parameters:
{string} id
- identifier for the object
{boolean} isEnabled

showOrbitLineForObject(id, isEnabled)
Enable or disable orbit lines for a specific object
Parameters:
{string} id
- identifier for the object
{boolean} isEnabled

showSensorFootprintProjectionsForId(id, isEnabled)
Enable or disable display of sensor projections for an object
Parameters:
{string} id
- identifier for the object
{boolean} isEnabled

showSensorProjectionForId(id, isEnabled)
Enable or disable display of sensor projections for an object
Parameters:
{string} id
- identifier for the object
{boolean} isEnabled

showSensorVisibilityLinesForId(id, isEnabled)
Enable or disable display of sensor projections for an object
Parameters:
{string} id
- identifier for the object
{boolean} isEnabled

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jan 16 2013 21:54:23 GMT-0700 (MST)