MSFCelestialImage

Objective-C


@interface MSFCelestialImage : MSFCelestialObject

Swift

class MSFCelestialImage : MSFCelestialObject

A bitmap laid on the sky, e.g. constellation artwork: three points of the bitmap are pinned to three directions and the rest follows on the sky sphere, so it turns and stretches with the sky rather than facing the camera. Its own direction is not used.

  • Undocumented

    Declaration

    Objective-C

    -(id)init;

    Swift

    init!()

  • Returns the bitmap of the image.

    Declaration

    Objective-C

    - (MSFBitmap *)getBitmap;

    Swift

    func getBitmap() -> MSFBitmap!

    Return Value

    The bitmap, or null if none is set.

  • Sets the bitmap of the image. An image without a bitmap is not drawn.

    Declaration

    Objective-C

    - (void)setBitmap:(MSFBitmap *)bitmap;

    Swift

    func setBitmap(_ bitmap: MSFBitmap!)

    Parameters

    bitmap

    The new bitmap.

  • Pins the bitmap to the sky by three anchors, each a point of the bitmap and the direction it sits in: [u, v, azimuth, altitude] per anchor, twelve values in all. u and v run 0..1 across the bitmap, v down from the top; azimuth and altitude are in degrees. The image is not drawn until the anchors are set, nor while they are collinear.

    Declaration

    Objective-C

    - (void)setAnchors:(MSFDoubleVector *)anchors;

    Swift

    func setAnchors(_ anchors: MSFDoubleVector!)

    Parameters

    anchors

    The anchors, as u, v, azimuth, altitude for each of the three.

  • Returns the anchors.

    Declaration

    Objective-C

    - (MSFDoubleVector *)getAnchors;

    Swift

    func getAnchors() -> MSFDoubleVector!

    Return Value

    The anchors, as u, v, azimuth, altitude for each of the three, or empty if unset.

  • Returns whether the bitmap’s brightness is read as its opacity.

    Declaration

    Objective-C

    - (BOOL)isLuminanceAlpha;

    Swift

    func isLuminanceAlpha() -> Bool

    Return Value

    True if the brightness is the opacity.

  • Sets whether the bitmap’s brightness is read as its opacity, the color then giving the hue: for artwork drawn light on black, as Stellarium’s is, which then shows on a pale sky too. The default is false.

    Declaration

    Objective-C

    - (void)setLuminanceAlpha:(BOOL)luminanceAlpha;

    Swift

    func setLuminanceAlpha(_ luminanceAlpha: Bool)

    Parameters

    luminanceAlpha

    True to read the brightness as the opacity.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()