MSFLabelStyleBuilder

Objective-C


@interface MSFLabelStyleBuilder : MSFBillboardStyleBuilder

Swift

class MSFLabelStyleBuilder : MSFBillboardStyleBuilder

A builder class for LabelStyle.

  • Constructs a LabelStyleBuilder object with all parameters set to defaults.

    Declaration

    Objective-C

    - (id)init;

    Swift

    init!()

  • Returns the horizontal anchor point of the label.

    Declaration

    Objective-C

    - (float)getAnchorPointX;

    Swift

    func getAnchorPointX() -> Float

    Return Value

    The horizontal anchor point of the label.

  • Sets the horizontal anchor point of the label.

    Declaration

    Objective-C

    - (void)setAnchorPointX:(float)anchorPointX;

    Swift

    func setAnchorPointX(_ anchorPointX: Float)

    Parameters

    anchorPointX

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

  • Returns the vertical anchor point of the label.

    Declaration

    Objective-C

    - (float)getAnchorPointY;

    Swift

    func getAnchorPointY() -> Float

    Return Value

    The vertical anchor point of the label.

  • Sets the vertical anchor point of the label.

    Declaration

    Objective-C

    - (void)setAnchorPointY:(float)anchorPointY;

    Swift

    func setAnchorPointY(_ anchorPointY: Float)

    Parameters

    anchorPointY

    The vertical anchor point for the label. -1 means the bottom, 0 the center and 1 the top of the label. The default is -1.

  • Sets the anchor point for the label. Values will be clamped to [-1, 1] range.

    Declaration

    Objective-C

    - (void)setAnchorPointX:(float)anchorPointX anchorPointY:(float)anchorPointY;

    Swift

    func setAnchorPointX(_ anchorPointX: Float, anchorPointY: Float)

    Parameters

    anchorPointX

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

    The vertical anchor point for the label. -1 means the bottom, 0 the center and 1 the top of the label. The default is -1.

  • Returns the state of the flippable flag.

    Declaration

    Objective-C

    - (BOOL)isFlippable;

    Swift

    func isFlippable() -> Bool

    Return Value

    True if the label is flippable.

  • Sets the state of the flippable flag. If set to true and the orientation mode is set to GROUND the label is allowed to flip 180 degrees to try and face the camera better. This is useful for street names and some other texts. The default is true.

    Declaration

    Objective-C

    - (void)setFlippable:(BOOL)flippable;

    Swift

    func setFlippable(_ flippable: Bool)

    Parameters

    flippable

    The new state of the flippable flag.

  • Returns the orientation mode of the label.

    Declaration

    Objective-C

    - (enum MSFBillboardOrientation)getOrientationMode;

    Swift

    func getOrientationMode() -> MSFBillboardOrientation

    Return Value

    The orientation mode of the label.

  • Sets the orientation mode for the label. The default is BillboardOrientation::FACE_CAMERA_BILLBOARD.

    Declaration

    Objective-C

    - (void)setOrientationMode:(enum MSFBillboardOrientation)orientationMode;

    Swift

    func setOrientationMode(_ orientationMode: MSFBillboardOrientation)

    Parameters

    orientationMode

    The new orientation mode for the label.

  • Returns the scaling mode of the label.

    Declaration

    Objective-C

    - (enum MSFBillboardScaling)getScalingMode;

    Swift

    func getScalingMode() -> MSFBillboardScaling

    Return Value

    The scaling mode of the label.

  • Sets the scaling mode for the label. The default is BillboardScaling::CONST_SCREEN_SIZE.

    Declaration

    Objective-C

    - (void)setScalingMode:(enum MSFBillboardScaling)scalingMode;

    Swift

    func setScalingMode(_ scalingMode: MSFBillboardScaling)

    Parameters

    scalingMode

    The new scaling mode for the label.

  • Returns the relative rendering scale for the label.

    Declaration

    Objective-C

    - (float)getRenderScale;

    Swift

    func getRenderScale() -> Float

    Return Value

    The relative rendering scale for the label.

  • Sets the relative rendering scale for the label. The default is 1.0. For sharper labels, this should be larger.

    Declaration

    Objective-C

    - (void)setRenderScale:(float)renderScale;

    Swift

    func setRenderScale(_ renderScale: Float)

    Parameters

    renderScale

    The new rendering scale value.

  • Builds a new instance of the LabelStyle object using previously set parameters.

    Declaration

    Objective-C

    - (MSFLabelStyle *)buildStyle;

    Swift

    func buildStyle() -> MSFLabelStyle!

    Return Value

    A new LabelStyle object.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()