NTBillboardStyleBuilder


@interface NTBillboardStyleBuilder : NTStyleBuilder

A base class for BillboardStyleBuilder subclasses.

  • Returns the horizontal attaching anchor point of the billboard.

    Declaration

    Objective-C

    - (float)getAttachAnchorPointX;

    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;

    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;

    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;

    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 attaching anchor point is only used if the billboard is attached to another (base) billboard. It defines the point on the base billboard where the attachable billboard will be placed.

    Declaration

    Objective-C

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

    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;

    Return Value

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

  • Sets the state of the causes overlap flag. If set to false the billboard will never hide other billboards, even if they are overlapping and have the hide if overlapped flag set to true. If set to true the billboard may hide other overlapping billboards that have the hide if overlapped flag set to true and are located behind this billboard. This billboard may still be hidden by other billboards in front of it, regardless of this parameter. The default depends on the subclass.

    Declaration

    Objective-C

    - (void)setCausesOverlap:(BOOL)causesOverlap;

    Parameters

    causesOverlap

    The new state of the allow overlap flag.

  • Returns the state of the allow overlap flag.

    Declaration

    Objective-C

    - (BOOL)isHideIfOverlapped;

    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 set to false the billboard may be hidden by other billboards that are overlapping with it and are located in front of this billboard. If set to true the billboard will never be hidden by other overlapping billboards. The default depends on the subclass.

    Declaration

    Objective-C

    - (void)setHideIfOverlapped:(BOOL)hideIfOverlapped;

    Parameters

    hideIfOverlapped

    The new state of the allow overlap flag.

  • Returns the horizontal offset of the billboard.

    Declaration

    Objective-C

    - (float)getHorizontalOffset;

    Return Value

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

  • Sets the horizontal offset for the billboard. Horizontal offset is used to offset the bitmap of the billboard horizontally relative to the billboard rotation. The units are the same as the units used in the setSize method. Negative values offset the bitmap to the left and positive values to the right. The default is 0.

    Declaration

    Objective-C

    - (void)setHorizontalOffset:(float)horizontalOffset;

    Parameters

    horizontalOffset

    The new horizontal offset for the billboard.

  • Returns the vertical offset of the billboard.

    Declaration

    Objective-C

    - (float)getVerticalOffset;

    Return Value

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

  • Sets the vertical offset for the billboard. Vertical offset is used to offset the bitmap of the billboard vertically relative to the billboard rotation. The units are the same as the units used in the setSize method. Negative values offset the bitmap to the bottom and positive values to the top. The default is 0.

    Declaration

    Objective-C

    - (void)setVerticalOffset:(float)verticalOffset;

    Parameters

    verticalOffset

    The new vertical offset for the billboard.

  • Returns the placement priority of the billboard.

    Declaration

    Objective-C

    - (int)getPlacementPriority;

    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;

    Parameters

    placementPriority

    The new placement priority for the billboard.

  • Returns the state of the scale with DPI flag.

    Declaration

    Objective-C

    - (BOOL)isScaleWithDPI;

    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 set to true the billboard’s size will scale using the screen dots per inch parameter. This means that billboards will look the same size regardless of the device screen size and density. If set to false the billboards will not be scaled with the screen density parameter, which means that billboard will look smaller on on higher density screens. Custom Label and Popup implementations may, but are not guaranteed to compensate for this by generating higher resolution images. The default depends on the subclass.

    Declaration

    Objective-C

    - (void)setScaleWithDPI:(BOOL)scaleWithDPI;

    Parameters

    scaleWithDPI

    The new state of the scale with DPI flag.

  • Returns the animation style of the billboard.

    Declaration

    Objective-C

    - (NTAnimationStyle *)getAnimationStyle;

    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:(NTAnimationStyle *)animStyle;

    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;