class PreviewSymbols

class PreviewSymbols.PreviewSymbols

implementation of the preview symbols

class PreviewSymbolType(value)

definition of the preview symbol types

ARROW = 7

CIRCLE = 1

COORD_CROSS = 5

CROSS = 3

FILLED_RECTANGLE = 8

MARK = 4

POLYLINE = 2

TEXT = 6

__module__ = 'PreviewSymbols'

__init__()

initialize

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

add an arrow symbol

Parameters

• reference_point – reference point

• width – width

• color – color as ARGB value or color ID

• rotation_angle – rotation angle

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

add a circle symbol

Parameters

• reference_point – reference point

• radius_pixel – radius in pixel

• color – color as ARGB value or color ID

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

add a coordinate cross symbol

Parameters

• plane – plane of the coordinate cross

• arm_length – length of the arms

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

add a cross symbol

Parameters

• reference_point – reference point

• width – width

• color – color as ARGB value or color ID

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

add a filled rectangle symbol

Parameters

• reference_point – reference point

• width – width

• color – color as ARGB value or color ID

• rotation_angle – rotation angle

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

add mark symbol

Parameters

• reference_point – reference point

• width – width

• color – color as ARGB value or color ID

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

add a polyline symbol

Parameters

• reference_point – reference point

• polyline – polyline

• color – color as ARGB value or color ID

• line_pattern – line pattern as 0/1 patten

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 – text

• reference_point – reference point

• ref_pnt_pos – point position of the reference point

• height – height

• color – color as ARGB value or color ID

• rotation_angle – rotation angle

draw(insert_matrix: Matrix3D,
     view_projection: ViewWorldProjection)

draw the symbols

Parameters

• insert_matrix – insert matrix

• view_projection – view world projection

__module__ = 'PreviewSymbols'