Measure API

Measure.MeasureAPI

Measure api loads from same scene assets. Brep files are required

Methods

dispose

▸ dispose(): Promise<void>

Returns

Promise<void>

---

get2dNormal

▸ get2dNormal(object, line): Object

returs the 2d normal of the first draw object the line hits

Parameters

Name	Type
object	DrawProduct
line	Object
line.end	ReadonlyVec2
line.start	ReadonlyVec2

Returns

Object

Name	Type
normal	ReadonlyVec2
position	ReadonlyVec2

---

getDrawMeasureEntity

▸ getDrawMeasureEntity(view, scene, entity, setting?): Promise<DrawProduct>

Returns a hierarcical structure of the element, describing how it should be drawn in 2d

Parameters

Name	Type
view	View
scene	MeasureScene
entity	DrawableEntity
setting?	MeasureSettings

Returns

Promise<DrawProduct>

---

getDrawObjectFromPoints

▸ getDrawObjectFromPoints(view, points, closed?, angles?, generateLineLabels?): DrawProduct

Returns a hierarcical structure describing how it should be drawn in 2d, should be used instead of getDrawMeasureEntity when a drawable entity is not available

Parameters

Name	Type	Default value
view	View	undefined
points	ReadonlyVec3[]	undefined
closed	boolean	true
angles	boolean	true
generateLineLabels	boolean	false

Returns

DrawProduct

---

getDrawText

▸ getDrawText(view, points, text): DrawProduct

Returns a draw object that places a text based on input points

Parameters

Name	Type
view	View
points	ReadonlyVec3[]
text	string

Returns

DrawProduct

---

loadScene

▸ loadScene(url): Promise<MeasureScene>

Same scene url as the corresponding webgl api load scene

Parameters

Name	Type
url	string | URL

Returns

Promise<MeasureScene>

---

toMarkerPoints

▸ toMarkerPoints(view, points): ReadonlyVec2[]

Converts world space points to on screen pixel points. Input and output are of equal length.

Parameters

Name	Type
view	View
points	ReadonlyVec3[]

Returns

ReadonlyVec2[]

---

toPathPoints

▸ toPathPoints(points, view): Object

Converts world space points to on screen pixel path and points

Parameters

Name	Type
points	ReadonlyVec3[]
view	View

Returns

Object

Name	Type
points2d	ReadonlyVec2[]
removedIndices	number[]
screenPoints	ReadonlyVec2[]

---

traceDrawObjects

▸ traceDrawObjects(objects, line): DrawProduct

Returns a draw object that traces intersection between the 2d paths and displays the 3d distance as a label

Parameters

Name	Type
objects	DrawProduct[]
line	Object
line.end	ReadonlyVec2
line.start	ReadonlyVec2

Returns

DrawProduct