Furniture

Furniture interface

Multiple queries in this page return objects of the type Furniture described below:

interface Furniture {
  catalogId: string;
  id: string;
  name: string;
  levelIndex: number;
  position: {
    x: number;
    z: number;
    elevation: number;
  };
  rotation: Partial<{
    pitch: number;
    yaw: number;
    roll: number;
  }>;
  dimensions: Partial<{
    length: number;
    height: number;
    width: number;
  }>;
  configuration?: object;
}

• catalogId - unique identifier of the furniture model, internal to Smplrspace. For example, all desks will share their catalogId.
• id - unique identifier of this particular piece of furniture, in that space.
• name - name given to the furniture in the editor.
• levelIndex - zero-based index of the level where the furniture is located. For example, levelIndex equals to 2 means the furniture is on L3 if there are no basements.
• position - location of the center of the furniture in the floor plan. Values are given in meter. The absolute value has no meaning since the coordinate (0,0,0) is arbitrary. So these values are only relevant relatively to each other.
• rotation - angle of rotation of the furniture in degrees. yaw would typically be the only non-null value as it represents the rotation around the vertical axis.
• dimensions - size of the furniture in centimeters. length and width are the dimensions in the 2D horizontal plane, while height is the vertical height in the 3D space.
• configuration - only exists for parametric furniture models, and contains the values of all model options for that piece of furniture. The schema depends on the model.

getAllFurnitureInSpace

To list all furniture from a space, you can call the following query.

smplrClient.getAllFurnitureInSpace(id: string): Promise<Furniture[]>

• id - unique identifier of the space in Smplrspace, something like "fbc5617e-5a27-4138-851e-839446121b2e".
• Furniture - this main interface is described here.

getAllFurnitureInSpaceFromCache

This is the synchronous equivalent of the query right above.

smplrClient.getAllFurnitureInSpaceFromCache(id: string): Furniture[]

where id and Furniture are as defined in getAllFurnitureInSpace.

getFurnitureOnLevel

To list all furniture from a single level in a space, you can call the following query.

smplrClient.getFurnitureOnLevel({
  spaceId: string,
  levelIndex: number
}): Promise<Furniture[]>

• spaceId - unique identifier of the space in Smplrspace, something like "fbc5617e-5a27-4138-851e-839446121b2e".
• levelIndex - zero-based index of the level. Refer to the Furniture interface to learn more.
• Furniture - this main interface is described here.

getFurnitureOnLevelFromCache

This is the synchronous equivalent of the query right above.

smplrClient.getFurnitureOnLevelFromCache({
  spaceId: string,
  levelIndex: number
}): Furniture[]

where spaceId, levelIndex, and Furniture are as defined in getFurnitureOnLevel.

getFurnitureInPolygon

To list all furniture contained within an area defined by a polygon, you can call the following query.

smplrClient.getFurnitureInPolygon({
  spaceId: string,
  polygon: {
    levelIndex: number,
    x: number,
    z: number
  }[]
}): Promise<Furniture[]>

• spaceId - unique identifier of the space in Smplrspace, something like "fbc5617e-5a27-4138-851e-839446121b2e".
• polygon - the definition of the area used as a mask to extract furniture. It has the same schema as the coordinates from the polygon data layers. It is assumed here that all coordinates have the same levelIndex value.
• Furniture - this main interface is described here.

getFurnitureInPolygonFromCache

This is the synchronous equivalent of the query right above.

smplrClient.getFurnitureInPolygonFromCache({
  spaceId: string,
  polygon: {
    levelIndex: number,
    x: number,
    z: number
  }[]
}): Furniture[]

where spaceId, polygon, and Furniture are as defined in getFurnitureInPolygon.

getFurnitureById

To extract a single piece of furniture from a space, identified by its unique identifier, you can call the following query.

smplrClient.getFurnitureById({
  spaceId: string,
  furnitureId: string
}): Promise<Furniture | null>

• spaceId - unique identifier of the space in Smplrspace, something like "fbc5617e-5a27-4138-851e-839446121b2e".
• furnitureId - unique identifier of the furniture in the space, has a similar format to spaceId.
• Furniture - this main interface is described here.

Returns null if the furniture is not found in the space.

getFurnitureByIdFromCache

This is the synchronous equivalent of the query right above.

smplrClient.getFurnitureByIdFromCache({
  spaceId: string,
  furnitureId: string
}): Furniture | null

where spaceId, furnitureId, and Furniture are as defined in getFurnitureById.

getFurnitureGroundFootprintById

To get the ground footprint (as a polygon) of a single piece of furniture, identified by its unique identifier, you can call the following query.

smplrClient.getFurnitureGroundFootprintById({
  spaceId: string,
  furnitureId: string
  closed?: boolean
}): Promise<{
  levelIndex: number
  x: number
  z: number
}[] | null>

• spaceId - unique identifier of the space in Smplrspace, something like "fbc5617e-5a27-4138-851e-839446121b2e".
• furnitureId - unique identifier of the furniture in the space, has a similar format to spaceId.
• closed - optional - indicates whether the returned array should be "closed", i.e. the last element repeats the first element. Default value: false.

Returns null if the furniture is not found in the space.

getFurnitureGroundFootprintByIdFromCache

This is the synchronous equivalent of the query right above.

smplrClient.getFurnitureGroundFootprintByIdFromCache({
  spaceId: string,
  furnitureId: string
  closed?: boolean
}): {
  levelIndex: number
  x: number
  z: number
}[] | null

where spaceId, furnitureId, and closed are as defined in getFurnitureGroundFootprintById.

isFurnitureInPolygon

To know whether a piece of furniture is contained within an area defined by a polygon, you can call the following query.

smplrClient.isFurnitureInPolygon({
  spaceId: string,
  furnitureId: string,
  polygon: {
    levelIndex: number,
    x: number,
    z: number
  }[]
}): Promise<boolean | null>

• spaceId - unique identifier of the space in Smplrspace, something like "fbc5617e-5a27-4138-851e-839446121b2e".
• furnitureId - unique identifier of the furniture in the space, has a similar format to spaceId.
• polygon - the definition of the area used as a mask to extract furniture. It has the same schema as the coordinates from the polygon data layers. It is assumed here that all coordinates have the same levelIndex value.

Returns null if the furniture is not found in the space, false if it is found but not in the polygon, true if it is found in the polygon.

A similar query is available for points, see isPointInPolygon.

isFurnitureInPolygonFromCache

This is the synchronous equivalent of the query right above.

smplrClient.isFurnitureInPolygonFromCache({
  spaceId: string,
  furnitureId: string,
  polygon: {
    levelIndex: number,
    x: number,
    z: number
  }[]
}): boolean | null

where spaceId, furnitureId, and polygon are as defined in isFurnitureInPolygon.

Need any other data?

Get in touch with any use-case that would require new queries to be exposed.