BarLabel

Canonical path: NemAll_Python_Reinforcement.BarLabel

Implementation of the bar label

Methods:

• GetAdditionalText –

  Get the additional text

• GetAngle –

  Get the angle

• GetDimensionLineOffset –

  Get the dimension line offset

• GetLabelOffset –

  Get the label offset for the text pointer

• GetLabelPoint –

  Get the label point

• GetLabelProperties –

  Get the label properties

• GetPointerProperties –

  Get the pointer properties

• GetPointerStartPoint –

  Get the start point of the text pointer

• GetPositionNumber –

  Get the position number

• GetShapeSide –

  Get the shape side for the text pointer

• GetShapeSideFactor –

  Get the factor for the text pointer at the shape side

• GetTextProperties –

  Get the text properties

• GetType –

  Get the label type

• GetVisibleBars –

  Get the vector with the visible bars

• IsDimensionLineAtShapeStart –

  Get the placement state of the dimension line

• IsLabelWithComb –

  Check for a label with a comb

• IsLabelWithFan –

  Check for a label with a fan

• IsPointerStartPoint –

  Get the state of the start point from the text pointer

• IsShowAllBars –

  Get the show all bars state

• IsShowTextPointer –

  Get the state for showing the text pointer

• IsShowTextPointerEndSymbol –

  Deprecated: use ShowTextPointerEndSymbol from BarLabelPointerProperties

• SetAdditionalText –

  Set the additional text

• SetDimensionLineAtShapeStart –

  Set the placement state of the dimension line

• SetDimensionLineOffset –

  Set the dimension line offset

• SetLabelOffset –

  Set the label offset

• SetLabelPoint –

  Set the label point

• SetPointerProperties –

  Set the pointer properties

• SetPointerStartPoint –

  Set the start pointer of the text pointer

• SetShowTextPointer –

  Set the state for showing the text pointer

• SetShowTextPointerEndSymbol –

  Deprecated: use ShowTextPointerEndSymbol from BarLabelPointerProperties

• SetTextProperties –

  Set the text properties

• SetVisibleBars –

  Set the vector with the visible bars

• ShowAllBars –

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

• ToString –

  Convert the label data to a string

• __eq__ –

  Compare operator

• __init__ –

  Overloaded function. See individual overloads.

• __repr__ –

  Convert to string

Attributes:

• AdditionalText (str) –

  Get the additional text

• DimensionLineAtShapeStart (bool) –

  Get the placement state of the dimension line

• DimensionLineOffset (float) –

  Get the dimension line offset

• LabelOffset (Vector2D) –

  Get the label offset for the text pointer

• LabelPoint (Point2D) –

  Get the label point

• PointerProperties (BarLabelPointerProperties) –

  Get the pointer properties

• PointerStartPoint (Point2D) –

  Get the start point of the text pointer

• ShowTextPointer (bool) –

  Get the state for showing the text pointer

• ShowTextPointerEndSymbol (bool) –

  Deprecated: use ShowTextPointerEndSymbol from BarLabelPointerProperties

• TextProperties (TextProperties) –

  Get the text properties

• VisibleBars (list[int] | VecIntList) –

  Get the vector with the visible bars

AdditionalText property writable

AdditionalText: str

Get the additional text

DimensionLineAtShapeStart property writable

DimensionLineAtShapeStart: bool

Get the placement state of the dimension line

DimensionLineOffset property writable

DimensionLineOffset: float

Get the dimension line offset

LabelOffset property writable

LabelOffset: Vector2D

Get the label offset for the text pointer

LabelPoint property writable

LabelPoint: Point2D

Get the label point

PointerProperties property writable

PointerProperties: BarLabelPointerProperties

Get the pointer properties

PointerStartPoint property writable

PointerStartPoint: Point2D

Get the start point of the text pointer

ShowTextPointer property writable

ShowTextPointer: bool

Get the state for showing the text pointer

ShowTextPointerEndSymbol property writable

ShowTextPointerEndSymbol: bool

Deprecated: use ShowTextPointerEndSymbol from BarLabelPointerProperties

TextProperties property writable

TextProperties: TextProperties

Get the text properties

VisibleBars property writable

VisibleBars: list[int] | VecIntList

Get the vector with the visible bars

GetAdditionalText

GetAdditionalText() -> str

Get the additional text

Returns:

• str –

  Additional text

GetAngle

GetAngle() -> Angle

Get the angle

Returns:

• Angle –

  Angle

GetDimensionLineOffset

GetDimensionLineOffset() -> float

Get the dimension line offset

Returns:

• float –

  Dimension line offset

GetLabelOffset

GetLabelOffset() -> Vector2D

Get the label offset for the text pointer

Returns:

• Vector2D –

  Label offset for the text pointer from the shape side

GetLabelPoint

GetLabelPoint() -> Point2D

Get the label point

Returns:

• Point2D –

  Label point

GetLabelProperties

GetLabelProperties() -> BarLabelProperties

Get the label properties

Returns:

• BarLabelProperties –

  Label properties

GetPointerProperties

GetPointerProperties() -> ReinforcementLabelPointerProperties

Get the pointer properties

Returns:

• ReinforcementLabelPointerProperties –

  Pointer Properties

GetPointerStartPoint

GetPointerStartPoint() -> Point2D

Get the start point of the text pointer

Returns:

• Point2D –

  Start point of the text pointer

GetPositionNumber

GetPositionNumber() -> int

Get the position number

Returns:

• int –

  Position number

GetShapeSide

GetShapeSide() -> int

Get the shape side for the text pointer

Returns:

• int –

  Shape side for the text pointer

GetShapeSideFactor

GetShapeSideFactor() -> float

Get the factor for the text pointer at the shape side

Returns:

• float –

  Factor for the text pointer at the shape side

GetTextProperties

GetTextProperties() -> TextProperties

Get the text properties

Returns:

• TextProperties –

  Text properties

GetType

GetType() -> LabelType

Get the label type

Returns:

• LabelType –

  Type of the label

GetVisibleBars

GetVisibleBars() -> list[int] | VecIntList

Get the vector with the visible bars

Returns:

• list[int] | VecIntList –

  Vector with the visible bars

IsDimensionLineAtShapeStart

IsDimensionLineAtShapeStart() -> bool

Get the placement state of the dimension line

Returns:

• bool –

  Placement of the dimension line as placement start state

IsLabelWithComb

IsLabelWithComb() -> bool

Check for a label with a comb

Returns:

• bool –

  Label with a comb: true/false

IsLabelWithFan

IsLabelWithFan() -> bool

Check for a label with a fan

Returns:

• bool –

  Label with a fan: true/false

IsPointerStartPoint

IsPointerStartPoint() -> bool

Get the state of the start point from the text pointer

Returns:

• bool –

  Defined start point exist: true/false

IsShowAllBars

IsShowAllBars() -> bool

Get the show all bars state

Returns:

• bool –

  Show all bars inside the dimension lines, ...

IsShowTextPointer

IsShowTextPointer() -> bool

Get the state for showing the text pointer

Returns:

• bool –

  Show the text pointer: true/false

IsShowTextPointerEndSymbol

IsShowTextPointerEndSymbol() -> bool

Deprecated: use ShowTextPointerEndSymbol from BarLabelPointerProperties

SetAdditionalText

SetAdditionalText(additionalText: str)

Set the additional text

Parameters:

• additionalText (str) –

  Additional text

SetDimensionLineAtShapeStart

SetDimensionLineAtShapeStart(dimLineAtShapeStart: bool)

Set the placement state of the dimension line

SetDimensionLineOffset

SetDimensionLineOffset(dimLineOffset: float)

Set the dimension line offset

Returns:

• –

  Dimension line offset

SetLabelOffset

SetLabelOffset(labelOffset: Vector2D)

Set the label offset

Parameters:

• labelOffset (Vector2D) –

  Label offset

SetLabelPoint

SetLabelPoint(labelPoint: Point2D)

Set the label point

Parameters:

• labelPoint (Point2D) –

  Label point

SetPointerProperties

SetPointerProperties(pointerProperties: ReinforcementLabelPointerProperties)

Set the pointer properties

Parameters:

• pointerProperties (ReinforcementLabelPointerProperties) –

  Pointer properties

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)

Deprecated: use ShowTextPointerEndSymbol from BarLabelPointerProperties

Parameters:

• showTextPointerEndSymbol (bool) –

  showTextPointerEndSymbol

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

ToString

ToString() -> str

Convert the label data to a string

Returns:

• str –

  String from the label data

__eq__

__eq__(label: BarLabel) -> bool

Compare operator

Parameters:

• label (BarLabel) –

  Labels to compare

Returns:

• bool –

  Labels are equal: true/false

__init__ overloaded

__init__()

Initialize

__init__(
    type: LabelType,
    positionNumber: int,
    labelProp: BarLabelProperties,
    labelPoint: Point2D,
    angle: Angle,
)

Constructor

Parameters:

• type (LabelType) –

  Label type

• positionNumber (int) –

  Position number

• labelProp (BarLabelProperties) –

  Label properties

• labelPoint (Point2D) –

  Label placement point

• angle (Angle) –

  Angle

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

Constructor

Parameters:

• type (LabelType) –

  Label type

• positionNumber (int) –

  Position number

• labelProp (BarLabelProperties) –

  Label properties

• shapeSide (int) –

  Shape side for the text pointer, starting from 1

• shapeSideFactor (float) –

  Factor for the text pointer at the shape side

• labelOffset (Vector2D) –

  Label offset for the text pointer from the shape side

• angle (Angle) –

  Angle

__init__(
    type: LabelType,
    positionNumber: int,
    labelProp: BarLabelProperties,
    bDimLineAtShapeStart: bool,
    dimLineOffset: float,
)

Constructor

Parameters:

• type (LabelType) –

  Label type

• positionNumber (int) –

  Position number

• labelProp (BarLabelProperties) –

  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__(
    type: LabelType,
    positionNumber: int,
    labelProp: BarLabelProperties,
    pointerProp: ReinforcementLabelPointerProperties,
    bDimLineAtShapeStart: bool,
    dimLineOffset: float,
)

Constructor

Parameters:

• type (LabelType) –

  Label type

• positionNumber (int) –

  Position number

• labelProp (BarLabelProperties) –

  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

__init__(element: BarLabel)

Copy constructor

Parameters:

• element (BarLabel) –

  Element to copy

__repr__

__repr__() -> str

Convert to string

Placeholder