ReinforcementLabel

Canonical path: NemAll_Python_Reinforcement.ReinforcementLabel

Methods:

• SetAdditionalText –

  Set the additional text

• SetLabelOffset –

  Set the label offset

• SetPointerStartPoint –

  Set the start pointer of the text pointer

• SetShowTextPointer –

  Set the state for showing the text pointer

• SetShowTextPointerEndSymbol –

  Set the state for showing the text pointer end symbol

• SetTextProperties –

  Set the text properties

• SetVisibleBars –

  Set the vector with the visible bars

• ShowAllBars –

  Set the all bars inside the dimension line, ... state

• __init__ –

  dummy, is only needed for the creation of the documentation by MkDocs

SetAdditionalText

SetAdditionalText(additionalText: str)

Set the additional text

Parameters:

• additionalText (str) –

  Additional text

SetLabelOffset

SetLabelOffset(labelOffset: Vector2D)

Set the label offset

Parameters:

• labelOffset (Vector2D) –

  Label offset

SetPointerStartPoint

SetPointerStartPoint(pointerStartPoint: Point2D)

Set the start pointer of the text pointer

Parameters:

• pointerStartPoint (Point2D) –

  Start point of the text pointer

SetShowTextPointer

SetShowTextPointer(showTextPointer: bool)

Set the state for showing the text pointer

Parameters:

• showTextPointer (bool) –

  Show the text pointer: true/false

SetShowTextPointerEndSymbol

SetShowTextPointerEndSymbol(showTextPointerEndSymbol: bool)

Set the state for showing the text pointer end symbol

Parameters:

• showTextPointerEndSymbol (bool) –

  Show the text pointer end symbol: true/false

SetTextProperties

SetTextProperties(textProperties: TextProperties)

Set the text properties

Parameters:

• textProperties (TextProperties) –

  Text properties

SetVisibleBars

SetVisibleBars(visibleBars: list[int] | VecIntList)

Set the vector with the visible bars

Parameters:

• visibleBars (list[int] | VecIntList) –

  Vector with the visible bars: 1, 2, 3, .. index from left; -1, -2, -3, ... index from right, 0 = center

ShowAllBars

ShowAllBars(bShowAllBars: bool)

Set the all bars inside the dimension line, ... state

Parameters:

• bShowAllBars (bool) –

  Show all bars in the dimension lines, ...: true/false

__init__ overloaded

__init__()

Initialize

__init__(
    reinforcementType: ReinforcementType,
    type: LabelType,
    positionNumber: int,
    labelProp: ReinforcementLabelProperties,
    labelPoint: Point2D,
    angle: Angle,
)

Constructor

Parameters:

• reinforcementType (ReinforcementType) –

  Reinforcement type

• type (LabelType) –

  Label type

• positionNumber (int) –

  Position number

• labelProp (ReinforcementLabelProperties) –

  Label properties

• labelPoint (Point2D) –

  Label placement point

• angle (Angle) –

  Angle

__init__(
    reinforcementType: ReinforcementType,
    type: LabelType,
    positionNumber: int,
    labelProp: ReinforcementLabelProperties,
    shapeSide: int,
    shapeSideFactor: float,
    labelOffset: Vector2D,
    angle: Angle,
)

Constructor

Parameters:

• reinforcementType (ReinforcementType) –

  Reinforcement type

• type (LabelType) –

  Label type

• positionNumber (int) –

  Position number

• labelProp (ReinforcementLabelProperties) –

  Label properties

• shapeSide (int) –

  Shape side for the text pointer

• shapeSideFactor (float) –

  Factor for the text pointer at the shape side

• labelOffset (Vector2D) –

  Label offset

• angle (Angle) –

  Angle

__init__(
    reinforcementType: ReinforcementType,
    type: LabelType,
    positionNumber: int,
    labelProp: ReinforcementLabelProperties,
    bDimLineAtShapeStart: bool,
    dimLineOffset: float,
)

Constructor

Parameters:

• reinforcementType (ReinforcementType) –

  Reinforcement type

• type (LabelType) –

  Label type

• positionNumber (int) –

  Position number

• labelProp (ReinforcementLabelProperties) –

  Label properties

• bDimLineAtShapeStart (bool) –

  Placement of the dimension line: at shape start = true / at shape end = false

• dimLineOffset (float) –

  Offset of the dimension line from the placement

__init__(
    reinforcementType: ReinforcementType,
    type: LabelType,
    positionNumber: int,
    labelProp: ReinforcementLabelProperties,
    pointerProp: ReinforcementLabelPointerProperties,
    bDimLineAtShapeStart: bool,
    dimLineOffset: float,
)

Constructor

Parameters:

• reinforcementType (ReinforcementType) –

  Reinforcement type

• type (LabelType) –

  Label type

• positionNumber (int) –

  Position number

• labelProp (ReinforcementLabelProperties) –

  Label properties

• pointerProp (ReinforcementLabelPointerProperties) –

  Pointer properties

• bDimLineAtShapeStart (bool) –

  Placement of the dimension line: at shape start = true / at shape end = false

• dimLineOffset (float) –

  Offset of the dimension line from the placement