Skip to content

PreviewSymbols

implementation of the preview symbols

PreviewSymbols

Canonical path: PreviewSymbols.PreviewSymbols

implementation of the preview symbols

PreviewSymbolType

Canonical path: PreviewSymbols.PreviewSymbols.PreviewSymbolType

Bases: IntEnum

definition of the preview symbol types

__init__ 

__init__()

initialize

add_arrow 

add_arrow(
    reference_point: Point3D,
    width: float,
    color: Union[ARGB, int],
    rotation_angle: Angle,
)

add an arrow symbol

Parameters:

  • reference_point (Point3D) –

    reference point

  • width (float) –

    width

  • color (Union[ARGB, int]) –

    color as ARGB value or color ID

  • rotation_angle (Angle) –

    rotation angle

add_circle 

add_circle(
    reference_point: Point3D, radius_pixel: int, color: Union[ARGB, int]
)

add a circle symbol

Parameters:

  • reference_point (Point3D) –

    reference point

  • radius_pixel (int) –

    radius in pixel

  • color (Union[ARGB, int]) –

    color as ARGB value or color ID

add_coord_cross 

add_coord_cross(plane: Union[Plane3D, AxisPlacement3D], arm_length: float)

add a coordinate cross symbol

Parameters:

  • plane (Union[Plane3D, AxisPlacement3D]) –

    plane of the coordinate cross

  • arm_length (float) –

    length of the arms

add_cross 

add_cross(reference_point: Point3D, width: float, color: Union[ARGB, int])

add a cross symbol

Parameters:

  • reference_point (Point3D) –

    reference point

  • width (float) –

    width

  • color (Union[ARGB, int]) –

    color as ARGB value or color ID

add_filled_rectangle 

add_filled_rectangle(
    reference_point: Point3D,
    width: float,
    color: Union[ARGB, int],
    rotation_angle: Angle,
)

add a filled rectangle symbol

Parameters:

  • reference_point (Point3D) –

    reference point

  • width (float) –

    width

  • color (Union[ARGB, int]) –

    color as ARGB value or color ID

  • rotation_angle (Angle) –

    rotation angle

add_mark 

add_mark(reference_point: Point3D, width: float, color: Union[ARGB, int])

add mark symbol

Parameters:

  • reference_point (Point3D) –

    reference point

  • width (float) –

    width

  • color (Union[ARGB, int]) –

    color as ARGB value or color ID

add_polyline 

add_polyline(
    reference_point: Point3D,
    polyline: Polyline2D,
    color: Union[ARGB, int],
    line_pattern: int = 4095,
)

add a polyline symbol

Parameters:

  • reference_point (Point3D) –

    reference point

  • polyline (Polyline2D) –

    polyline

  • color (Union[ARGB, int]) –

    color as ARGB value or color ID

  • line_pattern (int, default: 4095 ) –

    line pattern as 0/1 patten

add_text 

add_text(
    text: str,
    reference_point: Point3D,
    ref_pnt_pos: TextReferencePointPosition,
    height: float,
    color: Union[ARGB, int],
    rotation_angle: Angle,
)

add a text symbol

Parameters:

  • text (str) –

    text

  • reference_point (Point3D) –

    reference point

  • ref_pnt_pos (TextReferencePointPosition) –

    point position of the reference point

  • height (float) –

    height

  • color (Union[ARGB, int]) –

    color as ARGB value or color ID

  • rotation_angle (Angle) –

    rotation angle

draw 

draw(
    insert_matrix: Matrix3D,
    view_projection: ViewWorldProjection,
    use_system_angle: bool = True,
)

draw the symbols

Parameters:

  • insert_matrix (Matrix3D) –

    insert matrix

  • view_projection (ViewWorldProjection) –

    view world projection

  • use_system_angle (bool, default: True ) –

    use the system angle state