MSFBillboardStyleBuilder

Objective-C


@interface MSFBillboardStyleBuilder : MSFStyleBuilder

Swift

class MSFBillboardStyleBuilder : MSFStyleBuilder

A base class for BillboardStyleBuilder subclasses.

  • Returns the horizontal attaching anchor point of the billboard.

    Declaration

    Objective-C

    - (float)getAttachAnchorPointX;

    Swift

    func getAttachAnchorPointX() -> Float

    Return Value

    The horizontal attaching anchor point of the billboard.

  • Sets the horizontal attaching anchor point of the billboard.

    Declaration

    Objective-C

    - (void)setAttachAnchorPointX:(float)attachAnchorPointX;

    Swift

    func setAttachAnchorPointX(_ attachAnchorPointX: Float)

    Parameters

    attachAnchorPointX

    The new horizontal attaching anchor point for the billboard. -1 means the left side, 0 the center and 1 the right side. The default is 0.

  • Returns the vertical attaching anchor point of the billboard.

    Declaration

    Objective-C

    - (float)getAttachAnchorPointY;

    Swift

    func getAttachAnchorPointY() -> Float

    Return Value

    The vertical attaching anchor point of the billboard.

  • Sets the vertical attaching anchor point of the billboard.

    Declaration

    Objective-C

    - (void)setAttachAnchorPointY:(float)attachAnchorPointY;

    Swift

    func setAttachAnchorPointY(_ attachAnchorPointY: Float)

    Parameters

    attachAnchorPointY

    The new vertical attaching anchor point for the billboard. -1 means the bottom, 0 the center and 1 the top. The default is 1.

  • Sets the attaching anchor point for the billboard: the point on the base billboard where this billboard is placed. Only used if the billboard is attached to another (base) billboard.

    Declaration

    Objective-C

    - (void)setAttachAnchorPointX:(float)attachAnchorPointX
           attachAnchorPointY:(float)attachAnchorPointY;

    Swift

    func setAttachAnchorPointX(_ attachAnchorPointX: Float, attachAnchorPointY: Float)

    Parameters

    attachAnchorPointX

    The new horizontal attaching anchor point for the billboard. -1 means the left side, 0 the center and 1 the right side. The default is 0.
    attachAnchorPointY

    The new vertical attaching anchor point for the billboard. -1 means the bottom, 0 the center and 1 the top. The default is 1.

  • Returns the state of the causes overlap flag.

    Declaration

    Objective-C

    - (BOOL)isCausesOverlap;

    Swift

    func isCausesOverlap() -> Bool

    Return Value

    True if this billboard causes overlapping with other billboards behind it.

  • Sets the state of the causes overlap flag. If true the billboard may hide overlapping billboards behind it that have the hide if overlapped flag set; if false it never hides others. It may still be hidden by billboards in front of it either way. The default depends on the subclass.

    Declaration

    Objective-C

    - (void)setCausesOverlap:(BOOL)causesOverlap;

    Swift

    func setCausesOverlap(_ causesOverlap: Bool)

    Parameters

    causesOverlap

    The new state of the allow overlap flag.

  • Returns the state of the allow overlap flag.

    Declaration

    Objective-C

    - (BOOL)isHideIfOverlapped;

    Swift

    func isHideIfOverlapped() -> Bool

    Return Value

    True if this billboard can be hidden by overlapping billboards in front of it.

  • Sets the state of the hide if overlapped flag. If true the billboard may be hidden by overlapping billboards in front of it; if false it is never hidden by them. The default depends on the subclass.

    Declaration

    Objective-C

    - (void)setHideIfOverlapped:(BOOL)hideIfOverlapped;

    Swift

    func setHideIfOverlapped(_ hideIfOverlapped: Bool)

    Parameters

    hideIfOverlapped

    The new state of the hide if overlapped flag.

  • Returns the horizontal offset of the billboard.

    Declaration

    Objective-C

    - (float)getHorizontalOffset;

    Swift

    func getHorizontalOffset() -> Float

    Return Value

    The horizontal offset of the billboard, units depend on the scaling mode.

  • Sets the horizontal offset of the bitmap, relative to the billboard rotation, in the units of setSize. Negative values offset the bitmap to the left, positive to the right. The default is 0.

    Declaration

    Objective-C

    - (void)setHorizontalOffset:(float)horizontalOffset;

    Swift

    func setHorizontalOffset(_ horizontalOffset: Float)

    Parameters

    horizontalOffset

    The new horizontal offset for the billboard.

  • Returns the vertical offset of the billboard.

    Declaration

    Objective-C

    - (float)getVerticalOffset;

    Swift

    func getVerticalOffset() -> Float

    Return Value

    The vertical offset of the billboard, units depend on the scaling mode.

  • Sets the vertical offset of the bitmap, relative to the billboard rotation, in the units of setSize. Negative values offset the bitmap to the bottom, positive to the top. The default is 0.

    Declaration

    Objective-C

    - (void)setVerticalOffset:(float)verticalOffset;

    Swift

    func setVerticalOffset(_ verticalOffset: Float)

    Parameters

    verticalOffset

    The new vertical offset for the billboard.

  • Returns the placement priority of the billboard.

    Declaration

    Objective-C

    - (int)getPlacementPriority;

    Swift

    func getPlacementPriority() -> Int32

    Return Value

    The placement priority of the billboard.

  • Sets the placement priority for the billboard. Higher priority billboard get drawn in front of lower priority billboards regardless of their distance to the camera. If billboards are not allowed to overlap then higher priority billboards hide overlapping lower priority billboards. The default is 0.

    Declaration

    Objective-C

    - (void)setPlacementPriority:(int)placementPriority;

    Swift

    func setPlacementPriority(_ placementPriority: Int32)

    Parameters

    placementPriority

    The new placement priority for the billboard.

  • Returns the state of the scale with DPI flag.

    Declaration

    Objective-C

    - (BOOL)isScaleWithDPI;

    Swift

    func isScaleWithDPI() -> Bool

    Return Value

    True if this billboard’s size will be scaled using the screen dot’s per inch.

  • Sets the state of the scale with DPI flag. If true the billboard’s size scales with screen DPI, so it looks the same size on any density; if false it looks smaller on higher density screens (custom Label and Popup implementations may compensate with higher resolution images). The default depends on the subclass.

    Declaration

    Objective-C

    - (void)setScaleWithDPI:(BOOL)scaleWithDPI;

    Swift

    func setScaleWithDPI(_ scaleWithDPI: Bool)

    Parameters

    scaleWithDPI

    The new state of the scale with DPI flag.

  • Returns the animation style of the billboard.

    Declaration

    Objective-C

    - (MSFAnimationStyle *)getAnimationStyle;

    Swift

    func getAnimationStyle() -> MSFAnimationStyle!

    Return Value

    The animation style of the billboard. Can be null if animations are not used.

  • Sets the animation style of the billboard.

    Declaration

    Objective-C

    - (void)setAnimationStyle:(MSFAnimationStyle *)animStyle;

    Swift

    func setAnimationStyle(_ animStyle: MSFAnimationStyle!)

    Parameters

    animStyle

    The new animation style of the billboard. Can be null if animations are not needed (the default).

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()