MeshLabel

Canonical path: NemAll_Python_Reinforcement.MeshLabel

Implementation of the reinforcement label

Methods:

• ToString –

  Convert the label data to a string

• __eq__ –

  Compare operator

• __init__ –

  Overloaded function. See individual overloads.

• __repr__ –

  Convert to string

Attributes:

• AutomaticTextPointer (bool) –

  Get the state for create the text pointer automatically

• LabelOffset (Vector2D) –

  Get the label offset for the text pointer

• LabelPoint (Point2D) –

  Get the label point

• LabelProperties (MeshLabelProperties) –

  Get the label properties

• PointerProperties (MeshLabelPointerProperties) –

  Get the pointer properties

• PointerStartPoint (Point2D) –

  Get the start point of the text pointer

• PositionNumber (int) –

  Get the position number

• ShapeSide (int) –

  Get the shape side for the text pointer

• ShapeSideFactor (float) –

  Get the factor for the text pointer at the shape side

• ShowTextPointer (bool) –

  Get the state for showing the text pointer

• TextProperties (ReinforcementLabelTextProperties) –

  Get the text properties

AutomaticTextPointer property writable

AutomaticTextPointer: bool

Get the state for create the text pointer automatically

LabelOffset property writable

LabelOffset: Vector2D

Get the label offset for the text pointer

LabelPoint property writable

LabelPoint: Point2D

Get the label point

LabelProperties property

LabelProperties: MeshLabelProperties

Get the label properties

PointerProperties property writable

PointerProperties: MeshLabelPointerProperties

Get the pointer properties

PointerStartPoint property writable

PointerStartPoint: Point2D

Get the start point of the text pointer

PositionNumber property

PositionNumber: int

Get the position number

ShapeSide property

ShapeSide: int

Get the shape side for the text pointer

ShapeSideFactor property

ShapeSideFactor: float

Get the factor for the text pointer at the shape side

ShowTextPointer property writable

ShowTextPointer: bool

Get the state for showing the text pointer

TextProperties property writable

TextProperties: ReinforcementLabelTextProperties

Get the text properties

ToString

ToString() -> str

Convert the label data to a string

Returns:

• str –

  String from the label data

__eq__

__eq__(label: MeshLabel) -> bool

Compare operator

Parameters:

• label (MeshLabel) –

  Labels to compare

Returns:

• bool –

  Labels are equal: true/false

__init__ overloaded

__init__()

Initialize

__init__(
    positionNumber: int, labelProp: MeshLabelProperties, labelPoint: Point2D
)

Constructor

Parameters:

• positionNumber (int) –

  Position number

• labelProp (MeshLabelProperties) –

  Label properties

• labelPoint (Point2D) –

  Label placement point

__init__(
    positionNumber: int,
    labelProp: MeshLabelProperties,
    shapeSide: int,
    shapeSideFactor: float,
    labelOffset: Vector2D,
)

Constructor

Parameters:

• positionNumber (int) –

  Position number

• labelProp (MeshLabelProperties) –

  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

__repr__

__repr__() -> str

Convert to string

Placeholder