Class: SimpleDimensions

components.SimpleDimensions

A basic dimension tool to measure distances between 2 points in 3D and display a 3D symbol displaying the numeric value.

Hierarchy

• Component<SimpleDimensionLine[]>

  ↳ SimpleDimensions

Implements

• Createable
• Hideable
• Disposable
• Updateable
• UI

Properties

afterCreate

• Readonly afterCreate: Event<SimpleDimensions>

afterCreate

Implementation of

Createable.afterCreate

Defined in

temp/components/core/SimpleDimensions/index.ts:37

---

afterDelete

• Readonly afterDelete: Event<SimpleDimensions>

afterDelete

Implementation of

Createable.afterDelete

Defined in

temp/components/core/SimpleDimensions/index.ts:43

---

afterUpdate

• Readonly afterUpdate: Event<SimpleDimensions>

afterUpdate

Implementation of

Updateable.afterUpdate

Defined in

temp/components/core/SimpleDimensions/index.ts:34

---

beforeCreate

• Readonly beforeCreate: Event<SimpleDimensions>

Createable.beforeCreate

Defined in

temp/components/core/SimpleDimensions/index.ts:40

---

beforeDelete

• Readonly beforeDelete: Event<SimpleDimensions>

Createable.beforeDelete

Defined in

temp/components/core/SimpleDimensions/index.ts:46

---

beforeUpdate

• Readonly beforeUpdate: Event<SimpleDimensions>

beforeUpdate

Implementation of

Updateable.beforeUpdate

Defined in

temp/components/core/SimpleDimensions/index.ts:31

---

name

• Readonly name: "SimpleDimensions"

name

Overrides

Component.name

Defined in

temp/components/core/SimpleDimensions/index.ts:28

---

onCreate

• onCreate: Event<SimpleDimensionLine>

Createable.onCreate

Defined in

temp/components/core/SimpleDimensions/index.ts:49

---

onDelete

• onDelete: Event<SimpleDimensionLine>

Createable.onDelete

Defined in

temp/components/core/SimpleDimensions/index.ts:52

---

previewElement

• previewElement: CSS2DObject

The symbol that is displayed where the dimension will be drawn.

Defined in

temp/components/core/SimpleDimensions/index.ts:61

---

snapDistance

• snapDistance: number = 0.25

The minimum distance to force the dimension cursor to a vertex.

Defined in

temp/components/core/SimpleDimensions/index.ts:57

Accessors

color

• set color(color): void

The Color of the geometry of the dimensions.

Parameters

Name	Type
color	Color

Returns

void

Defined in

temp/components/core/SimpleDimensions/index.ts:125

---

enabled

• get enabled(): boolean

enabled

Returns

boolean

Overrides

Component.enabled

Defined in

temp/components/core/SimpleDimensions/index.ts:91

• set enabled(state): void

enabled

Parameters

Name	Type
state	boolean

Returns

void

Overrides

Component.enabled

Defined in

temp/components/core/SimpleDimensions/index.ts:96

---

geometry

• get geometry(): BufferGeometry<NormalBufferAttributes>

The geometry used in both endpoints of all the dimensions.

Returns

BufferGeometry<NormalBufferAttributes>

Defined in

temp/components/core/SimpleDimensions/index.ts:131

• set geometry(geometry): void

The geometry used in both endpoints of all the dimensions.

Parameters

Name	Type
geometry	BufferGeometry<NormalBufferAttributes>

Returns

void

Defined in

temp/components/core/SimpleDimensions/index.ts:136

---

visible

• get visible(): boolean

visible

Returns

boolean

Implementation of

Hideable.visible

Defined in

temp/components/core/SimpleDimensions/index.ts:106

• set visible(state): void

visible

Parameters

Name	Type
state	boolean

Returns

void

Implementation of

Hideable.visible

Defined in

temp/components/core/SimpleDimensions/index.ts:111

Methods

cancelDrawing

▸ cancelDrawing(): void

Cancels the drawing of the current dimension.

Returns

void

Defined in

temp/components/core/SimpleDimensions/index.ts:271

---

create

▸ create(plane?): void

Starts or finishes drawing a new dimension line.

Parameters

Name	Type	Description
plane?	Object3D<Event>	forces the dimension to be drawn on a plane. Use this if you are drawing dimensions in floor plan navigation.

Returns

void

Implementation of

Createable.create

Defined in

temp/components/core/SimpleDimensions/index.ts:235

---

delete

▸ delete(): void

Deletes the dimension that the user is hovering over with the mouse or touch event.

Returns

void

Implementation of

Createable.delete

Defined in

temp/components/core/SimpleDimensions/index.ts:245

---

deleteAll

▸ deleteAll(): void

Deletes all the dimensions that have been previously created.

Returns

void

Defined in

temp/components/core/SimpleDimensions/index.ts:262

---

dispose

▸ dispose(): void

dispose

Returns

void

Implementation of

Disposable.dispose

Defined in

temp/components/core/SimpleDimensions/index.ts:200

---

get

▸ get(): SimpleDimensionLine[]

get

Returns

SimpleDimensionLine[]

Overrides

Component.get

Defined in

temp/components/core/SimpleDimensions/index.ts:195

---

hasUI

▸ hasUI(): this is UI

Whether is component implements any kind of UI.

Returns

this is UI

Inherited from

Component.hasUI

Defined in

temp/components/base-types/component.ts:48

---

isDisposeable

▸ isDisposeable(): this is Disposable

Whether is component is Disposable.

Returns

this is Disposable

Inherited from

Component.isDisposeable

Defined in

temp/components/base-types/component.ts:28

---

isHideable

▸ isHideable(): this is Hideable

Whether is component is Hideable.

Returns

this is Hideable

Inherited from

Component.isHideable

Defined in

temp/components/base-types/component.ts:43

---

isResizeable

▸ isResizeable(): this is Resizeable

Whether is component is Resizeable.

Returns

this is Resizeable

Inherited from

Component.isResizeable

Defined in

temp/components/base-types/component.ts:33

---

isUpdateable

▸ isUpdateable(): this is Updateable

Whether is component is Updateable.

Returns

this is Updateable

Inherited from

Component.isUpdateable

Defined in

temp/components/base-types/component.ts:38

---

update

▸ update(_delta): void

update

Parameters

Name	Type
_delta	number

Returns

void

Implementation of

Updateable.update

Defined in

temp/components/core/SimpleDimensions/index.ts:211