Source code for honeybee_display.shade

"""Method to translate a Shade to a VisualizationSet."""
from ladybug_display.geometry3d import DisplayFace3D
from ladybug_display.visualization import VisualizationSet, ContextGeometry

from ._util import _process_wireframe




def shade_to_vis_set(shade, color_by='type'):
    """Translate a Honeybee Shade to a VisualizationSet.

    Args:
        shade: A Honeybee Shade object to be converted to a VisualizationSet.
        color_by: Text for the property that dictates the colors of the Shade
            geometry. (Default: type). Choose from the following:

            * type
            * boundary_condition

    Returns:
        A VisualizationSet object that represents the Shade with a
        single ContextGeometry.
    """
    # get the basic properties for geometry conversion
    color_by_attr = 'type_color' if color_by.lower() == 'type' else 'bc_color'
    d_mod = 'SurfaceWithEdges'
    # convert all geometry into DisplayFace3D
    a_col = getattr(shade, color_by_attr)
    dis_geos = [DisplayFace3D(shade.geometry, a_col, d_mod)]
    # build the VisualizationSet and ContextGeometry
    con_geo = ContextGeometry(shade.identifier, dis_geos)
    con_geo.display_name = shade.display_name
    vis_set = VisualizationSet(shade.identifier, [con_geo])
    vis_set.display_name = shade.display_name
    return vis_set





def shade_to_vis_set_wireframe(shade, color=None):
    """Get a VisualizationSet with a single ContextGeometry for the shade wireframe.

    Args:
        shade: A Honeybee Shade object to be translated to a wireframe.
        color: An optional Color object to set the color of the wireframe.
            If None, the color will be black.

    Returns:
        A VisualizationSet with a single ContextGeometry and a list of
        DisplayLineSegment3D for the wireframe of the Shade.
    """
    wireframe = []
    lw = 2 if shade.is_detached else 1
    _process_wireframe(shade.geometry, wireframe, color, lw)

    vis_set = VisualizationSet(
        shade.identifier, [ContextGeometry('Wireframe', wireframe)])
    vis_set.display_name = shade.display_name
    return vis_set