Celestial

Created with kind celestial.

Type	Class
"arc"	CelestialArc
"image"	CelestialImage
"label"	CelestialLabel
"sprite"	CelestialSprite

"arc" — CelestialArc

{"type": "arc"}

Key	Type	Always required	Notes

Property	Type	Access	Description
belowHorizonVisible	boolean	read/write	Returns whether the part of the curve below the horizon is drawn.
clickRadius	number	read/write	Returns the click radius of the curve.
radius	number	read-only	Returns the angular radius of a circular arc.
segmented	boolean	read-only	Returns true if the directions are read as separate segments rather than as a path.
width	number	read/write	Returns the line width.

Inherited from CelestialObject:

Property	Type	Access	Description
altitude	number	read-only	Returns the altitude of a direction-anchored object.
azimuth	number	read-only	Returns the azimuth of a direction-anchored object.
color	color	read/write	Returns the color of the object.
directionAnchored	boolean	read-only	Returns true if the object is anchored by direction, false if by geographic position.
distance	number	read-only	Returns the distance of a direction-anchored object.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the meta data map. Changes to the copy are not reflected in the object.
occludedByMap	boolean	read/write	Returns whether the map in front hides the object.
position	struct massif::MapPos	read-only	Returns the geographic position of a position-anchored object.
positionAltitude	number	read-only	Returns the altitude of a position-anchored object.
visible	boolean	read/write	Returns the visibility of the object.

Method	Arguments	Returns
setCircle	axisAzimuth: float, axisAltitude: float, radius: float	void
setDirection	azimuth: float, altitude: float, distance: float	void
setDirections	directions: json	void
setSegments	directions: json	void

"image" — CelestialImage

{"type": "image"}

Key	Type	Always required	Notes

Property	Type	Access	Description
bitmap	object graphics.Bitmap	read/write	Returns the bitmap of the image.
luminanceAlpha	boolean	read/write	Returns whether the bitmap's brightness is read as its opacity.

Inherited from CelestialObject:

Property	Type	Access	Description
altitude	number	read-only	Returns the altitude of a direction-anchored object.
azimuth	number	read-only	Returns the azimuth of a direction-anchored object.
color	color	read/write	Returns the color of the object.
directionAnchored	boolean	read-only	Returns true if the object is anchored by direction, false if by geographic position.
distance	number	read-only	Returns the distance of a direction-anchored object.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the meta data map. Changes to the copy are not reflected in the object.
occludedByMap	boolean	read/write	Returns whether the map in front hides the object.
position	struct massif::MapPos	read-only	Returns the geographic position of a position-anchored object.
positionAltitude	number	read-only	Returns the altitude of a position-anchored object.
visible	boolean	read/write	Returns the visibility of the object.

Method	Arguments	Returns
setAnchors	anchors: json	void
setDirection	azimuth: float, altitude: float, distance: float	void

"label" — CelestialLabel

{"type": "label"}

Key	Type	Always required	Notes

Property	Type	Access	Description
anchorPointX	number	read-only	Returns the horizontal anchor point.
anchorPointY	number	read-only	Returns the vertical anchor point.
backgroundColor	color	read/write	Returns the background colour.
backgroundRadius	number	read/write	Returns the corner radius of the plate.
clickable	boolean	read/write	Returns whether a click on the label hits it.
fontName	string	read/write	Returns the font list.
fontSize	number	read/write	Returns the font size.
haloColor	color	read/write	Returns the halo colour.
haloWidth	number	read/write	Returns the halo width.
offsetX	number	read-only	Returns the horizontal offset.
offsetY	number	read-only	Returns the vertical offset.
paddingX	number	read/write	Returns the horizontal padding between the text and the plate's edge.
paddingY	number	read/write	Returns the vertical padding between the text and the plate's edge.
text	string	read/write	Returns the text.
textColor	color	read/write	Returns the text colour. The object's own colour tints the whole label, plate included.

Inherited from CelestialObject:

Property	Type	Access	Description
altitude	number	read-only	Returns the altitude of a direction-anchored object.
azimuth	number	read-only	Returns the azimuth of a direction-anchored object.
color	color	read/write	Returns the color of the object.
directionAnchored	boolean	read-only	Returns true if the object is anchored by direction, false if by geographic position.
distance	number	read-only	Returns the distance of a direction-anchored object.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the meta data map. Changes to the copy are not reflected in the object.
occludedByMap	boolean	read/write	Returns whether the map in front hides the object.
position	struct massif::MapPos	read-only	Returns the geographic position of a position-anchored object.
positionAltitude	number	read-only	Returns the altitude of a position-anchored object.
visible	boolean	read/write	Returns the visibility of the object.

Method	Arguments	Returns
setAnchorPoint	x: float, y: float	void
setDirection	azimuth: float, altitude: float, distance: float	void
setOffset	x: float, y: float	void

"sprite" — CelestialSprite

{"type": "sprite"}

Key	Type	Always required	Notes

Property	Type	Access	Description
angularSize	number	read/write	Returns the angular size of the sprite.
bitmap	object graphics.Bitmap	read/write	Returns the bitmap of the sprite.
clickRadius	number	read/write	Returns the extra radius that responds to a click.
screenSize	number	read/write	Returns the screen size of the sprite.
softness	number	read/write	Returns the edge softness of a disc sprite.

Inherited from CelestialObject:

Property	Type	Access	Description
altitude	number	read-only	Returns the altitude of a direction-anchored object.
azimuth	number	read-only	Returns the azimuth of a direction-anchored object.
color	color	read/write	Returns the color of the object.
directionAnchored	boolean	read-only	Returns true if the object is anchored by direction, false if by geographic position.
distance	number	read-only	Returns the distance of a direction-anchored object.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the meta data map. Changes to the copy are not reflected in the object.
occludedByMap	boolean	read/write	Returns whether the map in front hides the object.
position	struct massif::MapPos	read-only	Returns the geographic position of a position-anchored object.
positionAltitude	number	read-only	Returns the altitude of a position-anchored object.
visible	boolean	read/write	Returns the visibility of the object.

Method	Arguments	Returns
setDirection	azimuth: float, altitude: float, distance: float	void

Base classes

Not constructed directly. Their properties are reachable on every object above that derives from them.

CelestialObject

Property	Type	Access	Description
altitude	number	read-only	Returns the altitude of a direction-anchored object.
azimuth	number	read-only	Returns the azimuth of a direction-anchored object.
color	color	read/write	Returns the color of the object.
directionAnchored	boolean	read-only	Returns true if the object is anchored by direction, false if by geographic position.
distance	number	read-only	Returns the distance of a direction-anchored object.
metaData	struct std::map<std::string, massif::Variant>	read/write	Returns a copy of the meta data map. Changes to the copy are not reflected in the object.
occludedByMap	boolean	read/write	Returns whether the map in front hides the object.
position	struct massif::MapPos	read-only	Returns the geographic position of a position-anchored object.
positionAltitude	number	read-only	Returns the altitude of a position-anchored object.
visible	boolean	read/write	Returns the visibility of the object.

Method	Arguments	Returns
setDirection	azimuth: float, altitude: float, distance: float	void