ladybug_display.extension.compass module

Method to draw a Compass as a VisualizationSet.

ladybug_display.extension.compass.compass_to_vis_set(compass, z=0, custom_angles=None, projection=None, font='Arial', maj_txt_size=None, min_txt_size=None)[source]

Translate a Ladybug Compass object into Display geometry.

Parameters:

  • compass – A Ladybug Compass object to be converted to display geometry.

  • z – A number for the Z-coordinate to be used in translation. (Default: 0)

  • custom_angles – An array of numbers between 0 and 360 to be used to generate custom angle labels around the compass.

  • projection –

    Text for the name of the projection to use from the sky dome hemisphere to the 2D plane. If None, no altitude circles o labels will be drawn (Default: None). Choose from the following:

    • Orthographic

    • Stereographic

  • font – Optional text for the font to be used in creating the text. (Default: ‘Arial’)

  • maj_txt_size – An optional number for the size of the major text. If None, it will be set to one 20th of the radius.

  • min_txt_size – An optional number for the size of the major text. Set to zero to have no minor text in the compass. If None, it will be set to half of the major text size.

Returns:

A VisualizationSet with the Compass represented as a single ContextGeometry. This context geometry includes these objects in the following order.

  • all_boundary_circles – Three Circle objects for the compass boundary.

  • major_azimuth_ticks – Line objects for the major azimuth labels.

  • major_azimuth_text – Text objects for the major azimuth labels.

  • minor_azimuth_ticks – Line objects for the minor azimuth labels (if applicable).

  • minor_azimuth_text – Text objects for the minor azimuth labels (if applicable).

  • altitude_circles – Circle objects for altitude labels (if projection is not None).

  • altitude_text – Text objects for altitude labels (if projection is not None).