BULC Building Designer

Get the current spatial layout of the project including all rooms, walls, levels, and their exact coordinates. IMPORTANT: Call this first when you need to place elements relative to existing objects (e.g., 'next to the living room', 'above the kitchen'). Returns bounds, room positions, wall positions, and level information. Use this to calculate coordinates before calling create functions.

Get general information about the current project including file path, modification status, level count, room count, wall count, and furniture count.

Get all floor levels with their names, elevations (height from ground), and floor heights (ceiling height).

Create a new floor level. Elevation is the height from ground (Z=0) to the floor surface in centimeters.

Set which floor level is currently active for editing. New rooms/walls will be created on this level by default.

Undo the last operation. Returns information about what was undone.

Redo the last undone operation. Returns information about what was redone.

Save the current project to file.

Create a new rectangular room at the specified position. All coordinates are in centimeters (cm). Use bulc_get_spatial_context first if you need to position relative to existing rooms. Example: To create a 5m x 4m room, use width=500, depth=400.

Create a room with a custom polygon shape defined by an array of points. Use this for non-rectangular rooms like L-shaped rooms. All coordinates are in centimeters.

Get a list of all rooms with their IDs, names, positions, and dimensions. Use the returned IDs for modify/delete operations.

Modify properties of an existing room. Only specified properties will be changed. Get room IDs from bulc_list_rooms first.

Delete a room by its ID. Get room IDs from bulc_list_rooms.

Create a wall segment between two points. All coordinates are in centimeters. For rectangular rooms, consider using bulc_create_walls_rectangle instead.

Create 4 connected walls forming a rectangular enclosure. This is the recommended way to create walls for rectangular rooms. All coordinates are in centimeters.

Get a list of all walls with their IDs, coordinates, thickness, and height. Use the returned IDs for modify/delete operations.

Modify properties of an existing wall. Only specified properties will be changed. Get wall IDs from bulc_list_walls.

Delete a wall by its ID. Get wall IDs from bulc_list_walls.

Get a list of available furniture items from the catalog. Use category filter to narrow down results. Returns catalog IDs needed for bulc_place_furniture.

Place a furniture item at the specified position. Get catalog IDs from bulc_list_furniture_catalog first. All coordinates are in centimeters.

Get a list of all placed furniture with their IDs, positions, and properties. Use the returned IDs for modify/delete operations.

Modify properties of an existing furniture item. Only specified properties will be changed. Get furniture IDs from bulc_list_furniture.

Delete a furniture item by its ID. Get furniture IDs from bulc_list_furniture.

Get FDS configuration for a furniture item. Returns the FDS category (fire source, detector, sprinkler, HVAC, thermocouple) and its configuration parameters.

Configure a furniture item as an FDS fire source. Supports HRRPUA (Heat Release Rate Per Unit Area) mode with time-based ramping. The fire will use the furniture's surface area for HRR calculations.

Configure a furniture item as an FDS detector (heat or smoke). Heat detectors use RTI and activation temperature. Smoke detectors use optical obscuration threshold.

Configure a furniture item as an FDS sprinkler. Uses RTI and activation temperature for thermal response, with water spray parameters for suppression simulation.

Configure a furniture item as an FDS HVAC (supply or exhaust vent). Assigns surface properties to specific faces of the obstruction. Supply vents blow air in, exhaust vents extract air out.

Configure a furniture item as an FDS thermocouple for temperature measurement. Used to record temperature at specific locations during simulation.

Clear FDS configuration from a furniture item. Removes fire source, detector, sprinkler, HVAC, or thermocouple settings.

Get a list of all FDS computational meshes. Returns mesh IDs, dimensions, cell sizes, and bounding coordinates.

Create a new FDS computational mesh with specified dimensions and cell count. The mesh defines the computational domain for fire simulation.

Automatically generate FDS mesh based on building geometry. Creates optimized mesh covering all rooms and walls with specified resolution. Can create single mesh or multiple meshes for multi-level buildings.

Modify an existing FDS mesh. Change dimensions, cell counts, or other properties.

Delete an FDS mesh by its ID.

Get current FDS simulation settings including time, ambient conditions, output settings, and numerical parameters.

Set FDS simulation time parameters. Controls simulation duration and time step settings.

Configure FDS output settings for visualization data. Controls slice files, 3D smoke, and device output intervals.

Set FDS ambient conditions including temperature, pressure, and species.

Generate a preview of the FDS input file without saving. Returns the complete FDS input file content for review.

Validate FDS configuration for errors and warnings. Checks mesh consistency, fire source setup, boundary conditions, etc.

Export the FDS input file to disk. Creates the .fds file and any required supporting files.

Start FDS simulation. Runs the simulation in background and returns immediately. Use bulc_get_fds_status to monitor progress.

Get current FDS simulation status. Returns running state, progress, current simulation time, and estimated completion.

Stop a running FDS simulation. Sends stop signal and waits for graceful shutdown.

Open the FDS result viewer window. Loads simulation results from the specified SMV file or last simulation.

List available datasets in the loaded FDS results. Returns slices, smoke3d volumes, Plot3D, devices, and other data types.

Extract time-series data at a specific point in the simulation domain. Useful for getting temperature, visibility, or species concentration at a location.

Run ASET (Available Safe Egress Time) analysis at a specified exit location. Evaluates safety criteria: temperature <60C, visibility >5m, CO <1400ppm, CO2 <5%, O2 >15%.

Generate an analysis report from FDS simulation results. Supports ASET, RSET, and combined safety analysis reports.

Set evacuation simulation time parameters. Controls total simulation duration and time step resolution.

Get current EVAC simulation settings including model type, agent parameters, and stair configurations.

Set the evacuation simulation model type and parameters. Supports CollisionFreeSpeed, SocialForce, and GeneralizedCentrifugal models.

List all configured evacuation stairs for multi-level buildings.

Configure a furniture item as an evacuation stair connection between floors. Defines entry/exit positions, capacity, and travel speed.

Remove stair configuration from a furniture item.

List all evacuation agents with their positions and properties.

Place evacuation agents in rooms or at specific positions. Can place by count (random distribution) or at exact coordinates.

Clear evacuation agents from specified room or all rooms.

Set default properties for evacuation agents (radius, speed, etc.).

List all detected evacuation exits (doors converted to exits).

Validate evacuation setup for errors and warnings. Checks agents, exits, walkable areas, and stair configurations.

Start evacuation simulation using JuPedSim. Returns immediately; use bulc_get_evac_status to monitor progress.

Get current evacuation simulation status including progress, evacuated count, and estimated completion time.

Stop a running evacuation simulation.

Load evacuation results from a .evac file for visualization.

Get evacuation result summary including total time, per-agent exit times, and statistics.

Generate RSET (Required Safe Egress Time) analysis report from evacuation simulation results.

Save current evacuation results to a .evac file.

Modify an existing evacuation stair configuration. Update capacity, speed, or position properties.

Set the exit assignment strategy for evacuation agents. Determines how agents choose which exit to use.

Set pre-movement time parameters for evacuation agents. Includes detection time and reaction time with statistical distributions.

Configure fire-evacuation coupling for FDS+EVAC integration. Sets visibility and temperature thresholds that affect agent behavior.

Get detailed evacuation results including per-agent trajectories, exit statistics, and flow rate analysis.

Open the 3D evacuation result viewer window. Displays agents on the building model with timeline playback.