dragonfly-core
  • Site
      • CLI Docs
        • Installation
        • Commands
          • validate
            • dragonfly validate
              • model
              • room-collisions
          • edit
            • dragonfly edit
              • align
              • convert-units
              • remove-short-segments
              • reset-room-boundaries
              • solve-adjacency
              • windows-by-ratio
          • translate
            • dragonfly translate
              • merge-models-to-honeybee
              • model-to-honeybee
              • model-to-honeybee-file
          • create
            • dragonfly create
              • from-geojson
              • from-honeybee
              • merge-models
      • dragonfly
        • dragonfly package
          • Subpackages
            • dragonfly.cli package
              • Submodules
                • dragonfly.cli.create module
                  • from_geojson()
                  • from_honeybee()
                  • merge_models()
                • dragonfly.cli.edit module
                • dragonfly.cli.translate module
                  • merge_models_to_honeybee()
                  • model_to_honeybee()
                  • model_to_honeybee_file()
                • dragonfly.cli.validate module
                  • validate_model()
                  • validate_room_collisions()
              • Module contents
            • dragonfly.writer package
              • Submodules
                • dragonfly.writer.building module
                • dragonfly.writer.context module
                • dragonfly.writer.model module
                • dragonfly.writer.room2d module
                • dragonfly.writer.story module
              • Module contents
          • Submodules
            • dragonfly.building module
              • Building
                • ToString()
                • 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()
                • move()
                • process_alleys()
                • reflect()
                • remove_duplicate_roofs()
                • 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_to_honeybee()
                • suggested_alignment_axes()
                • to_dict()
                • to_honeybee()
                • to_rectangular_windows()
                • display_name
                • exterior_aperture_area
                • exterior_wall_area
                • floor_area
                • footprint_area
                • full_id
                • has_room_2d_plenums
                • has_room_2ds
                • has_room_3ds
                • has_zones
                • height
                • height_above_ground
                • height_from_first_floor
                • identifier
                • max
                • min
                • properties
                • room_2d_story_names
                • room_3d_apertures
                • room_3d_doors
                • room_3d_faces
                • room_3d_shades
                • room_3d_story_names
                • room_3ds
                • story_count
                • story_count_above_ground
                • to
                • unique_room_2ds
                • unique_stories
                • unique_stories_above_ground
                • user_data
                • volume
                • zone_dict
            • dragonfly.colorobj module
              • ColorRoom2D
                • ToString()
                • attr_name
                • attr_name_end
                • attributes
                • attributes_original
                • attributes_unique
                • floor_faces
                • graphic_container
                • legend_parameters
                • max_point
                • min_point
                • room_2ds
            • dragonfly.config module
              • Folders
                • dragonfly_core_version
                • dragonfly_core_version_str
                • dragonfly_schema_version
                • dragonfly_schema_version_str
                • python_package_path
            • dragonfly.context module
              • ContextShade
                • ToString()
                • add_prefix()
                • align()
                • apply_vertex_map()
                • duplicate()
                • from_dict()
                • from_honeybee()
                • is_conforming()
                • move()
                • reflect()
                • rotate_xy()
                • scale()
                • snap_to_grid()
                • to_dict()
                • to_honeybee()
                • unconforming_vertex_map()
                • area
                • display_name
                • full_id
                • geometry
                • identifier
                • is_detached
                • max
                • min
                • properties
                • to
                • user_data
            • dragonfly.dictutil module
              • dict_to_object()
            • dragonfly.extensionutil module
              • building_extension_dicts()
              • context_shade_extension_dicts()
              • model_extension_dicts()
              • room2d_extension_dicts()
              • story_extension_dicts()
            • dragonfly.model module
              • Model
                • ToString()
                • 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_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()
                • 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_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()
                • angle_tolerance
                • average_height
                • average_height_above_ground
                • average_story_count
                • average_story_count_above_ground
                • buildings
                • context_shades
                • display_name
                • exterior_aperture_area
                • exterior_wall_area
                • floor_area
                • footprint_area
                • full_id
                • identifier
                • max
                • min
                • properties
                • room_2ds
                • room_3ds
                • stories
                • to
                • tolerance
                • units
                • user_data
                • volume
            • dragonfly.projection module
              • lon_lat_to_polygon()
              • meters_to_long_lat_factors()
              • origin_long_lat_from_location()
              • polygon_to_lon_lat()
            • dragonfly.properties module
              • BuildingProperties
                • ToString()
                • add_prefix()
                • apply_ceiling_plenum_face_properties()
                • apply_floor_plenum_face_properties()
                • apply_properties_from_geojson_dict()
                • make_plenums()
                • move()
                • reflect()
                • rotate_xy()
                • scale()
                • to_dict()
                • host
              • ContextShadeProperties
                • ToString()
                • add_prefix()
                • from_honeybee()
                • move()
                • reflect()
                • rotate_xy()
                • scale()
                • to_dict()
                • to_honeybee()
                • host
              • ModelProperties
                • ToString()
                • apply_properties_from_dict()
                • move()
                • reflect()
                • rotate_xy()
                • scale()
                • to_dict()
                • to_honeybee()
                • host
              • Room2DProperties
                • ToString()
                • add_prefix()
                • from_honeybee()
                • move()
                • reflect()
                • rotate_xy()
                • scale()
                • to_dict()
                • to_honeybee()
                • host
              • StoryProperties
                • ToString()
                • add_prefix()
                • move()
                • reflect()
                • rotate_xy()
                • scale()
                • to_dict()
                • host
            • dragonfly.roof module
              • RoofSpecification
                • ToString()
                • align()
                • check_roof_above_rooms()
                • duplicate()
                • find_gaps()
                • from_dict()
                • move()
                • overlap_count()
                • pull_to_segments()
                • reflect()
                • resolved_geometry()
                • rotate_xy()
                • scale()
                • snap_to_grid()
                • split_with_lines()
                • split_with_polygon()
                • subtract_roofs()
                • to_dict()
                • union_coplanar()
                • update_geometry_2d()
                • update_geometry_3d()
                • altitudes
                • azimuths
                • boundary_geometry_2d
                • center_heights
                • geometry
                • has_parent
                • max
                • max_height
                • min
                • min_height
                • parent
                • planes
                • tilts
            • dragonfly.room2d module
              • Room2D
                • ToString()
                • 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()
                • 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_orientation()
                • grouped_horizontal_boundary()
                • intersect_adjacency()
                • join_by_boundary()
                • join_room_2ds()
                • join_to_neighbor()
                • label_point()
                • move()
                • offset_skylights()
                • offset_skylights_from_edges()
                • offset_windows()
                • overlap_area()
                • pull_to_polygon()
                • pull_to_polyline()
                • pull_to_room_2d()
                • pull_to_segments()
                • reflect()
                • relevant_roof_geometry()
                • remove_colinear_vertices()
                • remove_degenerate_holes()
                • remove_duplicate_vertices()
                • remove_short_segments()
                • remove_small_holes()
                • 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()
                • subtract_room_2ds()
                • to_core_perimeter()
                • to_detailed_windows()
                • to_dict()
                • to_honeybee()
                • to_rectangular_windows()
                • unconforming_vertex_map()
                • update_floor_geometry()
                • air_boundaries
                • boundary_conditions
                • ceiling_height
                • ceiling_plenum_depth
                • center
                • display_name
                • exterior_aperture_area
                • exterior_wall_area
                • exterior_window_area
                • floor_area
                • floor_geometry
                • floor_height
                • floor_plenum_depth
                • floor_segments
                • floor_segments_2d
                • floor_to_ceiling_height
                • full_id
                • has_ceiling
                • has_floor
                • has_parent
                • highest_plenum_floor_height
                • identifier
                • interior_wall_area
                • is_core
                • is_ground_contact
                • is_perimeter
                • is_top_exposed
                • max
                • min
                • parent
                • properties
                • roof_sub_face_area
                • segment_count
                • segment_normals
                • shading_parameters
                • skylight_area
                • skylight_parameters
                • sub_face_area
                • to
                • user_data
                • volume
                • wall_sub_face_area
                • window_parameters
                • zone
            • dragonfly.shadingparameter module
              • ExtrudedBorder
                • ToString()
                • add_shading_to_face()
                • duplicate()
                • from_dict()
                • scale()
                • to_dict()
                • depth
              • LouversByCount
                • ToString()
                • add_shading_to_face()
                • duplicate()
                • from_dict()
                • scale()
                • to_dict()
                • angle
                • contour_vector
                • depth
                • flip_start_side
                • louver_count
                • offset
              • LouversByDistance
                • ToString()
                • add_shading_to_face()
                • duplicate()
                • from_dict()
                • scale()
                • to_dict()
                • angle
                • contour_vector
                • depth
                • distance
                • flip_start_side
                • offset
              • Overhang
                • ToString()
                • add_shading_to_face()
                • duplicate()
                • from_dict()
                • scale()
                • to_dict()
                • angle
                • depth
            • dragonfly.skylightparameter module
              • DetailedSkylights
                • ToString()
                • add_skylight_to_face()
                • aperture_area_from_face()
                • area_from_face()
                • check_overlaps()
                • check_self_intersecting()
                • check_valid_for_face()
                • duplicate()
                • from_dict()
                • merge_and_simplify()
                • merge_to_bounding_rectangle()
                • move()
                • offset()
                • offset_polygons_for_face()
                • reflect()
                • remove_self_intersecting()
                • remove_small_skylights()
                • rotate()
                • scale()
                • split()
                • to_dict()
                • union_overlaps()
                • are_doors
                • polygons
              • GriddedSkylightArea
                • ToString()
                • add_skylight_to_face()
                • area_from_face()
                • duplicate()
                • from_dict()
                • scale()
                • split()
                • to_dict()
                • skylight_area
                • spacing
              • GriddedSkylightRatio
                • ToString()
                • add_skylight_to_face()
                • area_from_face()
                • duplicate()
                • from_dict()
                • scale()
                • split()
                • to_dict()
                • skylight_ratio
                • spacing
            • dragonfly.story module
              • Story
                • ToString()
                • 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()
                • 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_TYPES
                • display_name
                • exterior_aperture_area
                • exterior_wall_area
                • floor_area
                • floor_height
                • floor_to_floor_height
                • full_id
                • has_parent
                • has_plenums
                • has_zones
                • highest_plenum_floor_height
                • identifier
                • is_above_ground
                • is_plenum
                • max
                • median_room2d_floor_height
                • min
                • multiplier
                • parent
                • properties
                • roof
                • room_2ds
                • to
                • type
                • user_data
                • volume
                • zone_dict
            • dragonfly.subdivide module
              • interpret_core_perimeter_subdivide()
              • interpret_floor_height_subdivide()
            • dragonfly.windowparameter module
              • DetailedWindows
                • ToString()
                • 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()
                • merge()
                • merge_and_simplify()
                • merge_to_bounding_rectangle()
                • merge_to_rectangular()
                • offset()
                • remove_small_windows()
                • scale()
                • shift_horizontally()
                • shift_vertically()
                • split()
                • to_dict()
                • to_rectangular_windows()
                • trim()
                • union_overlaps()
                • are_doors
                • polygons
                • user_data
              • RectangularWindows
                • ToString()
                • add_window_to_face()
                • aperture_area_from_segment()
                • area_from_segment()
                • check_valid_for_segment()
                • check_window_overlaps()
                • duplicate()
                • flip()
                • from_dict()
                • merge()
                • merge_to_rectangular()
                • offset()
                • remove_small_windows()
                • scale()
                • shift_horizontally()
                • shift_vertically()
                • split()
                • to_detailed_windows()
                • to_dict()
                • to_rectangular_windows()
                • trim()
                • are_doors
                • heights
                • origins
                • user_data
                • widths
              • RepeatingWindowRatio
                • ToString()
                • add_window_to_face()
                • area_from_segment()
                • duplicate()
                • from_dict()
                • merge()
                • merge_to_rectangular()
                • scale()
                • split()
                • to_dict()
                • to_rectangular_windows()
                • trim()
                • horizontal_separation
                • rect_split
                • sill_height
                • user_data
                • vertical_separation
                • window_height
                • window_ratio
              • RepeatingWindowWidthHeight
                • ToString()
                • add_window_to_face()
                • area_from_segment()
                • duplicate()
                • from_dict()
                • merge()
                • merge_to_rectangular()
                • scale()
                • split()
                • to_dict()
                • to_rectangular_windows()
                • trim()
                • horizontal_separation
                • sill_height
                • user_data
                • window_height
                • window_width
              • SimpleWindowArea
                • ToString()
                • add_window_to_face()
                • area_from_segment()
                • duplicate()
                • from_dict()
                • merge()
                • merge_to_rectangular()
                • scale()
                • split()
                • to_dict()
                • to_rectangular_windows()
                • trim()
                • rect_split
                • user_data
                • window_area
              • SimpleWindowRatio
                • ToString()
                • add_window_to_face()
                • area_from_segment()
                • duplicate()
                • from_dict()
                • merge()
                • merge_to_rectangular()
                • scale()
                • split()
                • to_dict()
                • to_rectangular_windows()
                • trim()
                • rect_split
                • user_data
                • window_ratio
              • SingleWindow
                • ToString()
                • add_window_to_face()
                • area_from_segment()
                • duplicate()
                • from_dict()
                • merge()
                • merge_to_rectangular()
                • scale()
                • split()
                • to_dict()
                • to_rectangular_windows()
                • trim()
                • height
                • sill_height
                • user_data
                • width
          • Module contents
  • Page
      • CLI Docs
      • dragonfly
  • CLI Docs
  • dragonfly

Python Module Index

d
 
d
- dragonfly
    dragonfly.building
    dragonfly.cli
    dragonfly.cli.create
    dragonfly.cli.edit
    dragonfly.cli.translate
    dragonfly.cli.validate
    dragonfly.colorobj
    dragonfly.config
    dragonfly.context
    dragonfly.dictutil
    dragonfly.extensionutil
    dragonfly.model
    dragonfly.projection
    dragonfly.properties
    dragonfly.roof
    dragonfly.room2d
    dragonfly.shadingparameter
    dragonfly.skylightparameter
    dragonfly.story
    dragonfly.subdivide
    dragonfly.windowparameter
    dragonfly.writer
    dragonfly.writer.building
    dragonfly.writer.context
    dragonfly.writer.model
    dragonfly.writer.room2d
    dragonfly.writer.story

Back to top

© Copyright 2025, Ladybug Tools.
Created using Sphinx 8.0.2.