MarkupModel

class cee.mrk.MarkupModel()

This class can be used to add markup items to a visualization.

Constructors

cee.mrk.MarkupModel.constructor()
MarkupModel(): MarkupModel

Constructor

Returns: MarkupModel

Accessors

cee.mrk.MarkupModel.ignoreViewClipping()
get ignoreViewClipping(): boolean

Enable or disable option to ignore view clipping in this model

Returns: boolean

set ignoreViewClipping(ignore: boolean): void

Parameters

ignore: boolean

Returns: void

cee.mrk.MarkupModel.name()

Name of the model.

Mainly used for debugging.

get name(): string

Name of the markup model.

Returns: string

set name(name: string): void

Name of the model.

Mainly used for debugging.

Parameters

name: string

Returns: void

cee.mrk.MarkupModel.partCount()
get partCount(): number

The number of parts in the model.

Returns: number

Methods

cee.mrk.MarkupModel.addArrowsPart()
addArrowsPart(): PartArrows

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

Returns: PartArrows

cee.mrk.MarkupModel.addImageLabelPart()
addImageLabelPart(): PartImageLabel

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

Returns: PartImageLabel

cee.mrk.MarkupModel.addIndexedTrianglesPart()
addIndexedTrianglesPart(): PartIndexedTriangles

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.

Returns: PartIndexedTriangles

cee.mrk.MarkupModel.addLabelsPart()
addLabelsPart(): PartLabels

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

Returns: PartLabels

cee.mrk.MarkupModel.addLinesPart()
addLinesPart(): PartLines

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

Returns: PartLines

cee.mrk.MarkupModel.addPointsPart()
addPointsPart(): PartPoints

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

Returns: PartPoints

cee.mrk.MarkupModel.addTexturedIndexedTrianglesPart()
addTexturedIndexedTrianglesPart(): PartTexturedIndexedTriangles

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.

Returns: PartTexturedIndexedTriangles

cee.mrk.MarkupModel.deleteAllParts()
deleteAllParts(): void

Deletes all parts in model

Returns: void

cee.mrk.MarkupModel.deletePart()
deletePart(part: Part): boolean

Delete the given part if present.

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

Parameters

part: Part

Returns: boolean

cee.mrk.MarkupModel.deletePartAt()
deletePartAt(partIndex: number): void

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

Parameters

partIndex: number

Returns: void

cee.mrk.MarkupModel.getBoundingBox()
getBoundingBox(_options: ModelBoundingBoxOptions): BoundingBox

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

Note that currently this method does not support any ModelBoundingBoxOptions

Parameters

Returns: BoundingBox

cee.mrk.MarkupModel.getDefaultCameraConfig()
getDefaultCameraConfig(): None

Returns default camera configuration, which is always null for this model.

Returns: None

cee.mrk.MarkupModel.getPartAt()
getPartAt(partIndex: number): Part

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

Parameters

partIndex: number

Returns: Part

cee.mrk.MarkupModel.rayIntersect()
rayIntersect(ray: Ray, ignoreLabels: boolean?): HitItem

Performs picking on the model.

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.

Parameters

ray: Ray

ignoreLabels: boolean = false

Returns: HitItem