MarkupView

class Communicator.Markup.MarkupView()

Methods

addMarkupItem

Communicator.Markup.MarkupView.addMarkupItem(markupItem)

Adds a markup item to this view

Arguments

markupItem (Communicator.Markup.MarkupItem()) – the markup to be added to this view.

Return type

void

forJson

Communicator.Markup.MarkupView.forJson()

Note

forJson is deprecated: Use toJson instead.

Return type: Object

getCamera

Communicator.Markup.MarkupView.getCamera()

Gets the camera of this view

Return type: Communicator.Camera
Returns: the camera of this view

getColorMap

Communicator.Markup.MarkupView.getColorMap()

Return type: Map[Communicator.NodeId, Communicator.Color]
Returns: A color map associating NodeIds to Colors.

getCuttingPlaneData

Communicator.Markup.MarkupView.getCuttingPlaneData()

Return type: Object
Returns: a JSON object with the cutting plane data associated with this view

getDefaultVisibility

Communicator.Markup.MarkupView.getDefaultVisibility()

Return type: boolean

getExplodeMagnitude

Communicator.Markup.MarkupView.getExplodeMagnitude()

Return type: number
Returns: the explode value associated with this view

getFaceVisibility

Communicator.Markup.MarkupView.getFaceVisibility()

Gets face visibility setting for this view

Return type: boolean
Returns: face visibility setting for this view

getLineVisibility

Communicator.Markup.MarkupView.getLineVisibility()

Gets line visibility setting for this view

Return type: boolean
Returns: line visibility setting for this view

getMarkup

Communicator.Markup.MarkupView.getMarkup()

Gets an array of markup items associated with this view

Return type: [Communicator.Markup.MarkupItem]
Returns: face visibility setting for this view

getName

Communicator.Markup.MarkupView.getName()

Gets the name of this view

Return type: string
Returns: name of this view

getSheetId

Communicator.Markup.MarkupView.getSheetId()

Gets the sheet id for this view

Return type: { }
Returns: the id of the sheet for this view. If no view was active at the time of creation this function will return null.

getSnapshotImage

Communicator.Markup.MarkupView.getSnapshotImage()

Return type: { }

getUniqueId

Communicator.Markup.MarkupView.getUniqueId()

Gets the unique identifier of this view

Return type: Communicator.Uuid
Returns: unique identifier of this view

getVisibilityExceptions

Communicator.Markup.MarkupView.getVisibilityExceptions()

Return type: Set[Communicator.NodeId]

removeMarkup

Communicator.Markup.MarkupView.removeMarkup(item)

Removes a markup item from the view

Arguments

item (Communicator.Markup.MarkupItem()) –

Return type

boolean

Returns

result of the removal operation

setColorMap

Communicator.Markup.MarkupView.setColorMap(colorMap)

Takes a color map associating NodeIds to Colors and associates it with this view.

Arguments

colorMap (Map[Communicator.NodeId, Communicator.Color]()) –

Return type

void

setCuttingPlaneData

Communicator.Markup.MarkupView.setCuttingPlaneData(cuttingPlaneData)

Takes a JSON cutting plane data object and associates it with this view

Arguments

cuttingPlaneData (Object()) –

Return type

void

setDefaultVisibility

Communicator.Markup.MarkupView.setDefaultVisibility(defaultVisibility)

Arguments

defaultVisibility (boolean()) –

Return type

void

setExplodeMagnitude

Communicator.Markup.MarkupView.setExplodeMagnitude(explodeMagnitude)

Takes an explode magnitude and associates it with this view

Arguments

explodeMagnitude (number()) –

Return type

void

setFaceVisibility

Communicator.Markup.MarkupView.setFaceVisibility(faceVisibility)

Sets face visibility for this view

Arguments

faceVisibility (boolean()) – face visibility setting for this view

Return type

void

setLineVisibility

Communicator.Markup.MarkupView.setLineVisibility(lineVisibility)

Sets line visibility for this view

Arguments

lineVisibility (boolean()) – line visibility setting for this view

Return type

void

setName

Communicator.Markup.MarkupView.setName(name)

Sets the name for this view

Arguments

name (string()) – name to set

Return type

void

setSnapshotImage

Communicator.Markup.MarkupView.setSnapshotImage(image)

Arguments

image (HTMLImageElement()) –

Return type

void

setVisibilityExceptions

Communicator.Markup.MarkupView.setVisibilityExceptions(nodeIds)

Arguments

nodeIds (Set[Communicator.NodeId]()) –

Return type

void

toJson

Communicator.Markup.MarkupView.toJson()

Creates an object ready for JSON serialization.

Return type: Object
Returns: The prepared object.