> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ploterr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Dimensions

> Creates model dimensions and finds them by id. DimensionTool is the shared instance.

## Import

```typescript theme={null}
import { Dimensions, DimensionTool } from '@opengeometry/floorkit';
```

## Constructor

```typescript theme={null}
constructor(scene?: THREE.Scene);
```

## Properties

<ResponseField name="static instance" type="Dimensions" />

<ResponseField name="sceneRef" type="THREE.Scene" />

## Methods

### getInstance

```typescript theme={null}
static getInstance(): Dimensions;
```

### set

```typescript theme={null}
set(key: string, value: any): void;
```

### getDimensionsById

```typescript theme={null}
getDimensionsById(key: string): any;
```

### createDimension

```typescript theme={null}
createDimension(type: DimensionType): any;
```

### createDimensionIn

```typescript theme={null}
createDimensionIn(scene: THREE.Scene, type: DimensionType): any;
```

Scene-injected creation: adds the dimension to the given scene without reading the instance/global scene, so it never throws "Scene not initialized".

## DimensionTool

```typescript theme={null}
const DimensionTool: Dimensions;
```

## Types

### DimensionType

```typescript theme={null}
type DimensionType = 'length' | 'angle' | 'area' | 'radius' | 'diameter' | 'volume' | 'custom';
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.