Floor

The "floors" part of the floorplan project JSON structure represents a pivotal component, encompassing multiple floor levels of the building design. Each floor level is encapsulated within an individual object, providing a comprehensive view of the entire building's layout.

Within each floor object, designers can create multiple design variations or layouts, facilitating exploration and comparison of different floor plan configurations. Each design is denoted by a unique name, allowing easy identification and reference.

{
  'id': Integer,
  'name': String,
  'level': Integer,
  'height': Float,
  'designs': Design[],
  'cameras': Camera[],
  'drawing': Drawing
}

Name	Type	Description	Default
id	Integer	This property contains an integer value, which can be used as a unique identifier for the object
name	String	This property can be used to give the floorplan a name
level	Integer	This property specified the level of the floor. Zero being ground floor	0
height	Float	Height of the floor in centimeters, 280 cm is the default	280
designs	Object	This property contains an array of objects of type Design, which represent floorplan designs of a single floor
cameras	Object	This property contains an array of objects of type Camera, which holds data for cameras such as their positions, lighting and type
drawing	Object	This property contains the object of type Drawing. The drawing contains data for a image that can be used as layer to add details or to redraw the floorplan from

Drawing

The drawing section in the floorplan JSON structure provides essential details for visual representation and positioning of the floorplan design. It includes properties like "id" for identification, "x" and "y" for coordinates, "width" and "height" for dimensions, and "rotation" for orientation. The "alpha" property controls transparency, and "visible" determines the visibility of the drawing. The "url" property links to the image file representing the floorplan. "depth" defines the depth of the drawing, and it allows for a clear visualization of the floorplan layout in the project. Overall, the "drawing" section plays a pivotal role in presenting the floorplan design with precision and clarity.

{
  'id', Integer,
  'x': Integer,
  'y': Integer,
  'width': Integer,
  'height': Integer,
  'visible': Boolean,
  'url': String,
  'rotation': Integer,
  'alpha': Integer,
  'depth': 'LOW' || 'HIGH'
}

Name	Type	Description	Default
id	Integer	Unique identifier for the drawing
x	Integer	X coordinate of the position on the floorplan	0
y	Integer	Y coordinate of the position on the floorplan	0
width	Integer	width of the image on the floorplan
height	Integer	height of the image on the floorplan
visible	Boolean	Show or hide the background
url	String	Link pointing to the image on a remote location
rotation	Integer	Rotation of the image	0
alpha	Integer	Visibility alpha of the image	100
depth	Show image below or above the floorplan with 'LOW' OR 'HIGH'	'LOW'

Cameras

The cameras respresent the viewpoint configurations that allow users to visualize the floorplan from different camera angles. Each camera object within the array defines a specific viewpoint, giving users the flexibility to navigate and explore the floorplan in various ways.

{
  'id': Integer,
  'name': String,
  'type_name': 'orbital' || 'walkthrough',
  'x': Integer,
  'y': Integer,
  'z': Integer,
  'ux': Integer,
  'uy': Integer,
  'uz': Integer,
  'dx': Integer,
  'dy': Integer,
  'dz': Integer,
  'fov': Integer,
  'lightSettings': Light,
  'background_image': Background
}

Background

{
  'sky_id': Integer,
  'url': String,
  'type_name': 'sphere'
}

{
  'url': String,
  'type_name': 'plane'
}

Light

The light settings part of the floorplan JSON structure contains properties that define the lighting conditions for a specific camera view within the floorplan. These settings influence the illumination, shadows, and overall ambiance of the floorplan visualization.

{
    'altitude': Integer,
    'azimuth': Integer,
    'day': Boolean,
    'intensity': Integer,
    'profile': Boolean
  }