MarkupModel

class cee.mrk.MarkupModel(): This class can be used to add markup items to a visualization.

Constructors

constructor

Accessors

ignoreViewClipping
name
partCount

Methods

addArrowsPart
addImageLabelPart
addIndexedTrianglesPart
addLabelsPart
addLinesPart
addPointsPart
addTexturedIndexedTrianglesPart
deleteAllParts
deletePart
deletePartAt
getBoundingBox
getPartAt
rayIntersect

Constructors

constructor

cee.mrk.MarkupModel.constructor()

Constructor

Return type: cee.mrk.MarkupModel

Accessors

cee.mrk.MarkupModel.ignoreViewClipping: Enable or disable option to ignore view clipping in this model

cee.mrk.MarkupModel.name: Name of the markup model.

cee.mrk.MarkupModel.partCount: The number of parts in the model.

Methods

addArrowsPart

cee.mrk.MarkupModel.addArrowsPart()

Adds a part for drawing points. Use the returned PartPoints to add points to the new part.

Return type: cee.mrk.PartArrows

addImageLabelPart

cee.mrk.MarkupModel.addImageLabelPart()

Add a part with an image attached to a 3d coordinate

Return type: cee.mrk.PartImageLabel

addIndexedTrianglesPart

cee.mrk.MarkupModel.addIndexedTrianglesPart()

Adds a part containing indexed triangles to the markup model. Use the returned PartIndexedTriangles to set the mesh data and color of the new part.

Return type: cee.mrk.PartIndexedTriangles

addLabelsPart

cee.mrk.MarkupModel.addLabelsPart()

Adds a part containing positioned text labels to the markup model. Use the returned PartLabels to add text labels to the new part.

Return type: cee.mrk.PartLabels

addLinesPart

cee.mrk.MarkupModel.addLinesPart()

Adds a part for drawing lines. Use the returned PartLines to add lines to the new part.

Return type: cee.mrk.PartLines

addPointsPart

cee.mrk.MarkupModel.addPointsPart()

Adds a part for drawing points. Use the returned PartPoints to add points to the new part.

Return type: cee.mrk.PartPoints

addTexturedIndexedTrianglesPart

cee.mrk.MarkupModel.addTexturedIndexedTrianglesPart()

Adds a part containing textured indexed triangles to the markup model. Use the returned PartTexturedIndexedTriangles to set the mesh data and texture of the new part.

Return type: cee.mrk.PartTexturedIndexedTriangles

deleteAllParts

cee.mrk.MarkupModel.deleteAllParts()

Deletes all parts in model

Return type: void

deletePart

cee.mrk.MarkupModel.deletePart(part)

Delete the given part if present.

Arguments

part (cee.mrk.Part) –

Return type

boolean

Returns true if the part was found and deleted, false if not.

deletePartAt

cee.mrk.MarkupModel.deletePartAt(partIndex)

Deletes the part at the given (zero-based) index.

Arguments

partIndex (number) –

Return type

void

getBoundingBox

cee.mrk.MarkupModel.getBoundingBox()

Returns the BoundingBox (in world coordinates) of the model.

Return type: cee.BoundingBox

getPartAt

cee.mrk.MarkupModel.getPartAt(partIndex)

Returns an active reference to the part at the given (zero-based) index.

Arguments

partIndex (number) –

Return type

cee.mrk.Part

rayIntersect

cee.mrk.MarkupModel.rayIntersect(ray, ignoreLabels)

Performs picking on the model.

Arguments

ray (cee.Ray) –
ignoreLabels (boolean) –

Return type

cee.mrk.HitItem

If something was hit, returns a HitItem containing information about the part and primitive that was hit.

If nothing was hit, returns null.

Labels have a “special treatment” ray intersect where hitting the label will cause a hit on the label attachment point. This is not always what is intended, e.g. when doing zoom to cursor. Set ignoreLabels to true to skip labels when doing ray intersect.