dragonfly.writer.room2d module¶
Room2D Writer.
Note to developers: Use this module to extend dragonfly’s Room2D writer for new extensions. (eg. adding rad to this module adds the method Room2D.to.rad)
BuildingToString()add_prefix()add_roof_geometry()add_room_3ds()add_stories()all_room_2ds()all_stories()automatically_zone()buildings_to_honeybee()check_collisions_between_stories()convert_all_room_3ds_to_2d()convert_multipliers_to_stories()convert_plenum_depths_to_room_2ds()convert_room_3d_to_2d()convert_room_3ds_to_2d()district_to_honeybee()duplicate()find_adjacency_gaps()footprint()from_all_story_geometry()from_dict()from_footprint()from_honeybee()has_floors_ceilings()make_basement_stories()match_and_replace_room_2d_floor_geometry()move()process_alleys()reflect()remove_duplicate_roofs()remove_stories_by_identifier()room_2ds_by_display_name()room_3ds_by_display_name()room_3ds_by_story()rotate_xy()scale()separate_mid_floors()separate_room_2d_plenums()separate_top_bottom_floors()set_outdoor_shading_parameters()set_outdoor_window_parameters()shade_representation()sort_stories()split_room_2d_vertically()stories_by_display_name()stories_by_identifier()stories_to_honeybee()suggested_alignment_axes()to_dict()to_honeybee()to_rectangular_windows()display_nameexterior_aperture_areaexterior_wall_areafloor_areafootprint_areafull_idhas_room_2d_plenumshas_room_2dshas_room_3dshas_zonesheightheight_above_groundheight_from_first_flooridentifiermaxminpropertiesroom_2d_story_namesroom_3d_aperturesroom_3d_doorsroom_3d_facesroom_3d_shadesroom_3d_story_namesroom_3dsstory_countstory_count_above_groundtounique_room_2dsunique_storiesunique_stories_above_grounduser_datavolumezone_dictModelToString()add_building()add_context_shade()add_model()add_prefix()buildings_by_identifier()check_all()check_all_duplicate_identifiers()check_all_room3d()check_all_room_collisions()check_collisions_between_stories()check_degenerate_room_2ds()check_duplicate_building_identifiers()check_duplicate_context_shade_identifiers()check_duplicate_room_2d_identifiers()check_duplicate_story_identifiers()check_for_error()check_for_extension()check_missing_adjacencies()check_no_roof_overlaps()check_no_room2d_overlaps()check_plenum_depths()check_roofs_above_rooms()check_room2d_floor_heights_valid()check_self_intersecting_room_2ds()check_window_parameters_valid()clean_irrational_geometry()context_shade_by_identifier()convert_to_units()duplicate()from_dfjson()from_dfpkl()from_dict()from_file()from_geojson()from_honeybee()from_pomf()lines_from_pomf()model_dict_room_2d_subset()model_dict_subset()move()reflect()remove_duplicate_roofs()reset_coordinate_system()reset_ids()resolve_id_collisions()room_2ds_by_identifier()room_3ds_by_identifier()rotate_xy()scale()separate_top_bottom_floors()set_outdoor_shading_parameters()set_outdoor_window_parameters()stories_by_identifier()to_dfjson()to_dfpkl()to_dict()to_geojson()to_geojson_dict()to_honeybee()to_rectangular_windows()validate()ERROR_MAPangle_toleranceaverage_heightaverage_height_above_groundaverage_story_countaverage_story_count_above_groundbuildingscontext_shadesdisplay_nameexterior_aperture_areaexterior_wall_areafloor_areafootprint_areafull_ididentifiermaxminpropertiesreference_vectorroom_2dsroom_3dsstoriestotoleranceunitsuser_datavolumeRoofSpecificationToString()align()check_roof_above_rooms()duplicate()find_gaps()from_dict()from_geometry_to_join()join_geometries()move()overlap_count()pull_to_segments()reflect()remove_small_holes()resolved_geometry()rotate_xy()scale()snap_to_grid()split_with_lines()split_with_polygon()split_with_thick_line()split_with_thick_polyline()subtract_roofs()to_dict()union_coplanar()update_geometry_2d()update_geometry_3d()altitudesazimuthsboundary_geometry_2dcenter_heightsgeometrygeometry_2dhas_parentmaxmax_heightminmin_heightparentplanestiltsRoom2DToString()add_prefix()align()apply_vertex_map()assign_sub_faces()automatically_zone()average_orientation()check_degenerate()check_horizontal()check_plenum_depths()check_self_intersecting()check_window_parameters_valid()coordinate_room_2d_vertices()coordinate_segment_vertices()duplicate()find_adjacency()find_adjacency_by_guide_lines()find_adjacency_gaps()find_segment_adjacency()floor_segment_by_index()from_dict()from_honeybee()from_polygon()from_vertices()generate_alignment_axes()generate_grid()group_by_adjacency()group_by_air_boundary_adjacency()group_by_attribute()group_by_floor_height()group_by_orientation()grouped_horizontal_boundary()intersect_adjacency()join_by_boundary()join_room_2ds()join_to_neighbor()label_point()make_skylights_flush()make_windows_flush()move()offset_skylights()offset_skylights_from_edges()offset_windows()overlap_area()patch_missing_adjacencies()pull_to_polygon()pull_to_polyline()pull_to_room_2d()pull_to_segments()rectangularize_windows()reflect()relevant_roof_geometry()remove_colinear_vertices()remove_degenerate_holes()remove_doors()remove_duplicate_vertices()remove_short_segments()remove_small_holes()remove_small_skylights()remove_small_windows()replace_floor_geometry()reset_adjacency()room_orientation_plane()rotate_xy()scale()segment_indices_by_guide_lines()segment_orientations()separate_plenum()set_adjacency()set_air_boundary()set_boundary_condition()set_outdoor_shading_parameters()set_outdoor_window_parameters()set_window_parameter()snap_to_grid()snap_to_line_end_points()snap_to_points()solve_adjacency()split_through_self_intersection()split_with_line()split_with_lines()split_with_polygon()split_with_polyline()split_with_thick_line()split_with_thick_polyline()subtract_room_2ds()to_core_perimeter()to_detailed_windows()to_dict()to_honeybee()to_rectangular_windows()unconforming_vertex_map()update_floor_geometry()air_boundariesboundary_conditionsceiling_heightceiling_plenum_depthcenterdisplay_nameexterior_aperture_areaexterior_wall_areaexterior_window_areafloor_areafloor_geometryfloor_heightfloor_plenum_depthfloor_segmentsfloor_segments_2dfloor_to_ceiling_heightfull_idhas_ceilinghas_floorhas_parenthighest_plenum_floor_heightidentifierinterior_wall_areais_coreis_ground_contactis_perimeteris_top_exposedmaxminparentpropertiesroof_sub_face_areasegment_countsegment_normalsshading_parametersskylight_areaskylight_parameterssub_face_areatouser_datavolumewall_sub_face_areawindow_parameterszoneDetailedSkylightsToString()add_skylight_to_face()aperture_area_from_face()area_from_face()check_overlaps()check_self_intersecting()check_valid_for_face()duplicate()from_dict()from_honeybee()invalid_face_geometries()make_flush()merge_and_simplify()merge_to_bounding_rectangle()move()offset()offset_polygons_for_face()overlapping_geometries()rectangularize()reflect()remove_doors()remove_self_intersecting()remove_small_skylights()rotate()scale()self_intersecting_geometries()split()to_dict()union_overlaps()are_doorspolygonsuser_dataGriddedSkylightArea
GriddedSkylightRatio
StoryToString()add_prefix()add_room_2d()add_room_2ds()align()align_room_2ds()automatically_zone()check_collision_with_story()check_missing_adjacencies()check_no_roof_overlaps()check_no_room2d_overlaps()check_roofs_above_rooms()check_room2d_floor_heights_valid()delete_degenerate_room_2ds()duplicate()fill_holes()floor_geometry()footprint()from_dict()from_honeybee()generate_grid()intersect_room_2d_adjacency()join_room_2ds()join_small_room_2ds()make_underground()move()outline_polylines()outline_segments()patch_missing_adjacencies()rebuild_detailed_windows()reflect()remove_room_2d_colinear_vertices()remove_room_2d_duplicate_vertices()remove_room_2d_short_segments()reset_adjacency()reset_room_2d_boundaries()room_2d_story_geometry_valid()room_by_identifier()rooms_by_identifier()rotate_xy()scale()set_adjacent_air_boundary()set_ground_contact()set_ground_contact_by_story_below()set_outdoor_shading_parameters()set_outdoor_window_parameters()set_top_exposed()set_top_exposed_by_story_above()shade_representation()shade_representation_multiplier()solve_room_2d_adjacency()split_with_story_above()suggested_alignment_axes()to_dict()to_honeybee()to_rectangular_windows()STORY_TYPESdisplay_nameexterior_aperture_areaexterior_wall_areafloor_areafloor_heightfloor_to_floor_heightfull_idhas_parenthas_plenumshas_zoneshighest_plenum_floor_heightidentifieris_above_groundis_plenummaxmax_room_2d_ceiling_heightmedian_room2d_floor_heightminmin_room_2d_floor_heightmultiplierparentpropertiesroofroom_2dstotypeuser_datavolumezone_dictDetailedWindowsToString()add_window_to_face()adjust_for_segment()aperture_area_from_segment()area_from_segment()check_self_intersecting()check_valid_for_segment()check_window_overlaps()duplicate()flip()from_dict()from_face3ds()is_face3d_in_segment_plane()is_flipped_equivalent()make_flush()merge()merge_and_simplify()merge_to_bounding_rectangle()merge_to_rectangular()offset()overlapping_geometries()rectangularize()remove_doors()remove_small_windows()scale()self_intersecting_geometries()shift_horizontally()shift_vertically()split()to_dict()to_rectangular_windows()trim()union_overlaps()are_doorspolygonsuser_dataRectangularWindowsToString()add_window_to_face()adjust_for_segment()aperture_area_from_segment()area_from_segment()check_valid_for_segment()check_window_overlaps()duplicate()flip()from_dict()merge()merge_to_rectangular()offset()remove_doors()remove_small_windows()scale()shift_horizontally()shift_vertically()split()to_detailed_windows()to_dict()to_rectangular_windows()trim()are_doorsheightsoriginsuser_datawidthsRepeatingWindowRatio
RepeatingWindowWidthHeight
SimpleWindowArea
SimpleWindowRatio
SingleWindow
Room2D Writer.
Note to developers: Use this module to extend dragonfly’s Room2D writer for new extensions. (eg. adding rad to this module adds the method Room2D.to.rad)