dragonfly_trace.properties.room2d module¶

Room2D TRACE Properties.

class dragonfly_trace.properties.room2d.Room2DTraceProperties(host)[source]¶

Bases: object

TRACE Properties for Dragonfly Room2D.

Parameters:: host – A dragonfly_core Room2D object that hosts these properties.

Properties:

check_no_floor_plate_holes(raise_exception=True, detailed=False)[source]¶

Check whether the Room2D’s floor geometry has holes.

TRACE 3D Plus currently has no way to represent holes.

Parameters:

raise_exception – If True, a ValueError will be raised if the Room2D floor plate has one or more holes. (Default: True).
detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A string with the message or a list with a dictionary if detailed is True.

check_no_skylights(raise_exception=True, detailed=False)[source]¶

Check whether the Room2D has skylights.

TRACE 3D Plus currently has no way to represent them.

Parameters:

raise_exception – If True, a ValueError will be raised if the Room2D has skylights. (Default: True).
detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A string with the message or a list with a dictionary if detailed is True.

check_windows_above_origin(tolerance=0.01, raise_exception=True, detailed=False)[source]¶

Check whether the Room2D has windows below the scene origin.

TRACE 3D Plus currently fails to import these windows since it believes that they are below ground.

Parameters:

tolerance – The maximum difference between coordinate values of two vertices at which they can be considered equivalent. (Default: 0.01, suitable for objects in meters).
raise_exception – If True, a ValueError will be raised if the Room2D has skylights. (Default: True).
detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A string with the message or a list with a dictionary if detailed is True.