Skip to content

Commit

Permalink
document closed option for furniture footprint
Browse files Browse the repository at this point in the history
  • Loading branch information
tibotiber committed Jul 23, 2024
1 parent 64727b5 commit 1abb07e
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/api-reference/queryclient/furniture.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ To get the ground footprint (as a polygon) of a single piece of furniture, ident
smplrClient.getFurnitureGroundFootprintById({
spaceId: string,
furnitureId: string
closed?: boolean
}): Promise<{
levelIndex: number
x: number
Expand All @@ -174,6 +175,7 @@ smplrClient.getFurnitureGroundFootprintById({

- `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.

Expand All @@ -185,14 +187,15 @@ 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` and `furnitureId` are as defined in `getFurnitureGroundFootprintById`.
where `spaceId`, `furnitureId`, and `closed` are as defined in `getFurnitureGroundFootprintById`.

## isFurnitureInPolygon

Expand Down

0 comments on commit 1abb07e

Please sign in to comment.