Bitbybit Docs
    Preparing search index...

    Class PinWithLabelDto (Inputs.OCCT)

    Two points, a label and the drawing settings for dimensions.pinWithLabel, a line pointing at a spot on a model with text at its end.

    Index

    Constructors

    constructor

    Properties

    startPoint endPoint? direction? offsetFromStart? label? labelOffset? labelSize? endType? arrowSize? arrowAngle? arrowsFlipped? labelRotation? labelFlipHorizontal? labelFlipVertical?

    Constructors

    • Parameters

      • OptionalstartPoint: Point3
      • OptionalendPoint: Point3
      • Optionaldirection: Vector3
      • OptionaloffsetFromStart: number
      • Optionallabel: string
      • OptionallabelOffset: number
      • OptionallabelSize: number
      • OptionalendType: dimensionEndTypeEnum
      • OptionalarrowSize: number
      • OptionalarrowAngle: number
      • OptionalarrowsFlipped: boolean
      • OptionallabelRotation: number
      • OptionallabelFlipHorizontal: boolean
      • OptionallabelFlipVertical: boolean

      Returns PinWithLabelDto

    Properties

    startPoint: Point3

    The spot on the model the pin marks.

    [0, 0, 0]
    endPoint?: Point3

    The point the pin line ends at, where the label is written.

    [0, 5, 2]
    direction?: Vector3

    The normal of the plane the label is written in.

    [0, 0, 1]
    offsetFromStart?: number

    The gap between the start point and the beginning of the line, in model units.

    0

    0

    Infinity

    0.1

    label?: string

    The text written at the end of the pin.

    Pin
    labelOffset?: number

    The gap between the end of the line and the label, in model units.

    0.3

    -Infinity

    Infinity

    0.1

    labelSize?: number

    The height of the label's capital letters, in model units.

    0.1

    0

    Infinity

    0.1

    endType?: dimensionEndTypeEnum

    What the pin line ends with at the start point: nothing, or an arrowhead.

    none
    arrowSize?: number

    The length of the arrowhead, in model units.

    0.3

    0

    Infinity

    0.1

    arrowAngle?: number

    The full angle between the two lines of the arrowhead, in degrees, up to 90.

    30

    0

    90

    1

    arrowsFlipped?: boolean

    When true, the arrowhead points away from the start point instead of toward it.

    false
    labelRotation?: number

    Extra rotation of the label in its plane, in degrees.

    0

    -360

    360

    1

    labelFlipHorizontal?: boolean

    When true, the label is mirrored left to right.

    false
    labelFlipVertical?: boolean

    When true, the label is mirrored top to bottom.

    false

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties