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

# ReferencePlane

> A guide plane at an angle that you choose.

## Import

```typescript theme={null}
import { ReferencePlane } from '@opengeometry/floorkit';
```

**Inheritance:** `extends OPElement implements IShape, IPlaceable`

## Constructor

```typescript theme={null}
constructor(config?: Partial<ReferencePlaneOptions>);
```

<ParamField path="config.datumType" type="DatumType.REFERENCE_PLANE" />

<ParamField path="config.origin" type="[number, number, number]">
  World-space origin of the plane.
</ParamField>

<ParamField path="config.normal" type="[number, number, number]">
  Plane normal (will be normalised).
</ParamField>

<ParamField path="config.extents" type="[number, number]">
  Half-width along the plane's local X and Y axes.
</ParamField>

<ParamField path="config.showBody" type="boolean">
  Whether the plane body is drawn as a semi-transparent polygon.
</ParamField>

<ParamField path="config.ogid" type="string" />

<ParamField path="config.labelName" type="string" />

<ParamField path="config.color" type="number">
  Line / symbol colour. Defaulted per subtype when omitted.
</ParamField>

<ParamField path="config.lineWidth" type="number">
  Line weight for the datum's 2D representation.
</ParamField>

<ParamField path="config.visibility" type="DatumVisibility">
  Whether this datum is shown in plan / model views.
</ParamField>

## Properties

<ResponseField name="ogid" type="string" />

<ResponseField name="ogType" type="string" />

<ResponseField name="subElements2D" type="Map<string, THREE.Object3D>" />

<ResponseField name="subElements3D" type="Map<string, THREE.Object3D>" />

<ResponseField name="selected" type="boolean" />

<ResponseField name="edit" type="boolean" />

<ResponseField name="locked" type="boolean" />

<ResponseField name="onDatumUpdated" type="Event<null>" />

<ResponseField name="propertySet" type="ReferencePlaneOptions" />

<ResponseField name="labelName" type="string" />

<ResponseField name="datumType" type="DatumType">
  Read-only.
</ResponseField>

<ResponseField name="profileView" type="boolean" />

<ResponseField name="modelView" type="boolean" />

## Methods

### editableSchema

```typescript theme={null}
static editableSchema(): OPEditableSchema;
```

### move

```typescript theme={null}
move(delta: Vec3): void;
```

Translate this element by `delta` (world-space, meters).

### rotate

```typescript theme={null}
rotate(_angleDeg: number, _axis?: Vec3, _anchor?: Vec3): void;
```

Rotate this element by `angleDeg` around `axis` (default Y-up), pivoted at `anchor` (default the element's own centroid).

### setOPConfig

```typescript theme={null}
setOPConfig(config: Partial<ReferencePlaneOptions>): void;
```

### getOPConfig

```typescript theme={null}
getOPConfig(): ReferencePlaneOptions;
```

### getEditAnchors

```typescript theme={null}
getEditAnchors(): EditAnchor[];
```

A single handle for the plane `origin`, free on the floor plane.

### applyEditAnchor

```typescript theme={null}
applyEditAnchor(id: string, position: [
    number,
    number,
    number
]): void;
```

### setOPMaterial

```typescript theme={null}
setOPMaterial(): void;
```

### setOPGeometry

```typescript theme={null}
setOPGeometry(): void;
```

## Types

### ReferencePlaneOptions

```typescript theme={null}
interface ReferencePlaneOptions extends DatumOptionsBase {
  datumType: DatumType.REFERENCE_PLANE;
  origin: [number, number, number];
  normal: [number, number, number];
  extents: [number, number];
  showBody: boolean;
}
```

## Related

* [`OPElement`](/floorkit/api/architecture/op-element)
* [`DatumOptionsBase`](/floorkit/api/datums/level#datumoptionsbase)
* [`DatumType`](/floorkit/api/datums/datum-defaults#datumtype)
* [`EditAnchor`](/floorkit/api/architecture/op-element#editanchor)
* [`Event`](/floorkit/api/architecture/wall-network#event)
* [`IPlaceable`](/floorkit/api/architecture/op-element#iplaceable)
* [`IShape`](/floorkit/api/shapes/cuboid-shape#ishape)
* [`OPEditableSchema`](/floorkit/api/architecture/op-element#opeditableschema)
* [`Vec3`](/floorkit/api/architecture/wall#vec3)


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