MSFBillboard

Objective-C


@interface MSFBillboard : MSFVectorElement

Swift

class MSFBillboard : MSFVectorElement

A base class for billboard elements that can be displayed on the map. Billboards can either be given a concrete position on the map or be attached to other billboards.

  • Returns the base billboard this billboard is attached to.

    Declaration

    Objective-C

    - (MSFBillboard *)getBaseBillboard;

    Swift

    func getBase() -> MSFBillboard!

    Return Value

    The base billboard this billboard is attached to. Null if not attached to a billboard.

  • Attaches this billboard to another billboard, so it will always be drawn relative to the base billboard. If this billboard has a geometry object assigned to it, it will first be set to null.

    Declaration

    Objective-C

    - (void)setBaseBillboard:(MSFBillboard *)baseBillboard;

    Swift

    func setBase(_ baseBillboard: MSFBillboard!)

    Parameters

    baseBillboard

    The billboard this billboard will be attached to.

  • Returns the bounds of this billboard or the base billboard, if there is one.

    Declaration

    Objective-C

    - (MSFMapBounds *)getBounds;

    Swift

    func getBounds() -> MSFMapBounds!

    Return Value

    The bounds of this billboard.

  • Returns the location of the root billboard. If this billboard has a location, this method is equavalent to the Billboard::getGeometry method. If this billboard is attached to another billboard, the hierarchy is traveled recursively and the location of the root billboard is returned.

    Declaration

    Objective-C

    - (MSFGeometry *)getRootGeometry;

    Swift

    func getRootGeometry() -> MSFGeometry!

    Return Value

    The geometry object that defines the location of the root billboard. Null if there’s no root billboard.

  • Returns the geometry object that defines the location of this billboard.

    Declaration

    Objective-C

    - (MSFGeometry *)getGeometry;

    Swift

    func getGeometry() -> MSFGeometry!

    Return Value

    The geometry object of this billboard.

  • Sets the location for this billboard. If this billboard is attached to another billboard, it will first be detached.

    Declaration

    Objective-C

    - (void)setGeometry:(MSFGeometry *)geometry;

    Swift

    func setGeometry(_ geometry: MSFGeometry!)

    Parameters

    geometry

    The new geometry object that defines the location of this billboard.

  • Sets the location for this billboard. If this billboard is attached to another billboard, it will first be detached.

    Declaration

    Objective-C

    - (void)setPos:(MSFMapPos *)pos;

    Swift

    func setPos(_ pos: MSFMapPos!)

    Parameters

    pos

    The new map position that defines the location of this billboard.

  • Returns the rotation angle of this billboard.

    Declaration

    Objective-C

    - (float)getRotation;

    Swift

    func getRotation() -> Float

    Return Value

    The rotation angle of this billboard in degrees.

  • Sets the rotation angle of this billboard. The rotation angle is ignored if orientation mode is set to BillboardOrientation::FACE_CAMERA_BILLBOARD. If the orientation mode is set to BillboardOrientation::FACE_CAMERA_GROUND then the rotation angle is added to the calculated billboard angle. If the orientation mode is set to BillboardOrientation::GROUND then the rotation means absolute rotation, where 0 is points to the north.

    Declaration

    Objective-C

    - (void)setRotation:(float)rotation;

    Swift

    func setRotation(_ rotation: Float)

    Parameters

    rotation

    The new rotation angle of this billboard in degrees.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()