6.1.28.2 Methods Defined Here

assign_construction(construction, surface)

Assign construction to surface. If the model has inner volumes and newly-assigned constructions have

differing thicknesses to the previous ones, rebuild_adjacencies must be called on the VEModel.

assign_construction_to_opening(construction, surface, opening_id)

Assign construction to an opening with the specified id.

assign_opening_type_by_id(surface_index, macroflo_id, opening_id)

Assign macroflo opening type to opening.

get_areas() -> {areas}

Returns a dict of areas (and volume) for this space.

The following areas are returned (All areas are returned in m² units. Room volume is returned in m³):

int_floor_area	ext_floor_area	int_floor_opening	ext_floor_opening
int_floor_glazed	ext_floor_glazed
int_ceiling_area	ext_ceiling_area	int_ceiling_opening	ext_ceiling_opening
int_ceiling_glazed	ext_ceiling_glazed	int_ceiling_door	ext_ceiling_door
int_wall_area	ext_wall_area	int_wall_opening	ext_wall_opening
int_wall_glazed	ext_wall_glazed	int_wall_door	ext_wall_door
volume

Note: space total floor / ceiling etc. area comprises both internal and external areas.

get_assigned_constructions() -> [(construction ID, '')]

Returns a list of tuples containing construction IDs assigned to this space. The second element in the tuple is currently unused.

get_assigned_profiles() -> [(profile ID, '')]

Returns a list of tuples containing profile IDs in use by this space. The second element in the tuple is currently unused.

get_index()

Get the index of the body

get_processes() -> list[VEComponentProcess]

Returns a list of VEComponentProcess objects representing the component processes in the body.

get_properties() -> dict

Returns a dictionary with the following properties:

min_height
max_height
floor_height_above_ground

get_surfaces() -> [surfaces]

Returns a list of VESurface objects that bound this space.

get_room_data(type = attribute_type. active_attributes ) -> VERoomData object

Args:

type (attribute_type )

Returns a VERoomData object for closer inspection of data assigned to this room. The returned data depends on the input type: the default type of ‘real_attributes’ gives the default data for the room, but NCM, PRM and Title 24 specific data can be requested (but only for their respective building variants).

is_3d_shade() -> bool

Checks whether the body is a 3d shade. Returns True for a topographical or local shade but False for a vegetated shade.

select()

Selects this body. Perform operations on the selected body using the VEGeometry API.

deselect()

deselects this body. Perform operations on the selected body using the VEGeometry API.