Project Info

The project information is a JSON object containing details about the project structure and content.

Event name	Input / Output	Payload	Reason
getProjectInfo	Input event	None.	Request the Project Info for the current state.
projectInfo	Output event	See the description below.	Receive the requested project info.

Example

// Receive the project info.
configurator.addEventListener("projectInfo", (event) => {
    console.log(event.detail);
});

// Send a request to get the project info.
configurator.dispatchEvent(new CustomEvent("getProjectInfo"))

Payload description

The Project Info is a complex JSON object. At the top level, it contains the following attributes:

Attribute name	Type	Content
products	Array of Product data. 🔗	This will contain the products currently loaded in the project.
level	Level data. 🔗	This will contain the level information of the project.
walls	Array of Wall data. 🔗	This will contain the walls information of the project.
bays	Array of Bay data. 🔗	This will contain the bays information of the project.

Product

This is the description of a product or sub product.

Attribute name	Type	Content
dbID	string	The identifier of this product in the database. If you load the same product multiple times, the dbid will be the same.
parameters	Array of Parameters. 🔗	The parameters of this product.
subProducts	Array of Products. 🔗	The sub products of this product.
transfo	matrix4	The transformation matrix of the product, corresponding to its position in the 3D scene.
uuid	string	A unique random identifier for this instance of the product.

Parameter

This is the description of the parameter of a product.

Attribute name	Type	Content
id	string	The identifier of this product in the database. If you load the same product multiple times, the dbid will be the same.
type	number	A number indicating the type of the value: 1: number (Real) 2: integer 3: boolean 4: string 5: string (color) 6: string (material dbid) 7: string (product dbid)
value	See the "type" attribute.	The current value of this parameter. The type depends on the "type" attribute.

Level

This is the description of the level of a project.

Attribute name	Type	Content
wallHeight	number	The wall height.

Wall

This is the description of a wall of a sloped wall.

Attribute name	Type	Content
height	number	The wall height.
depth	number	The wall depth.
startPoint	Point2	The wall's start point.
endPoint	Point2	The wall's end point.
straightHeight	number	The sloped wall height of the straigth part.
slopeDepth	number	The sloped wall depth of the sloped part.
direction	-1 or 1 enum	The sloped wall direction (1 for inward, -1 for outward).

Bay

This is the description of a bay. A bay is a product so it contains the same information as Product data. 🔗