NoteTextManager

class Communicator.Markup.Note.NoteTextManager()

Constructors

constructor()

Methods

addNote()

checkPinInstance()

explode()

exportMarkup()

findById()

getActiveItem()

getActiveItemHandle()

getExplodeActive()

getIsolateActive()

getNoteTextElement()

getNoteTextList()

getPinSphereMeshId()

getPinStemMeshId()

loadData()

removeNote()

selectPin()

setActiveItem()

setActiveItemHandle()

setIsolateActive()

setNoteTextElement()

updatePinVisibility()


Constructors

constructor

Communicator.Markup.Note.NoteTextManager.constructor(viewer)
Arguments
  • viewer (Communicator.WebViewer()) –

Return type

Communicator.Markup.Note.NoteTextManager

Methods

addNote

Communicator.Markup.Note.NoteTextManager.addNote(note)

Adds a note and makes it active

Arguments
  • note (NoteText()) – NoteText to be added to the manager

Return type

void

checkPinInstance

Communicator.Markup.Note.NoteTextManager.checkPinInstance(nodeId)

Checks if a nodeId is part of a note pin

Arguments
  • nodeId (Communicator.NodeId()) – NodeId to be checked

Return type

boolean

explode

Communicator.Markup.Note.NoteTextManager.explode(magnitude)

Sets manager explode state based on explosion magnitude. Active explosion hides note pins

Arguments
  • magnitude (number()) – Explosion magnitude

Return type

Promise[void]

exportMarkup

Communicator.Markup.Note.NoteTextManager.exportMarkup()

Exports note texts to an array of JSON Objects that can be restored via loadData

Return type

[Object]

Returns

Array of JSON objects representing notes

findById

Communicator.Markup.Note.NoteTextManager.findById(id)

Checks if a UUID is associated with any existing notes

Arguments
  • id (Communicator.Uuid()) – UUID to check

Return type

boolean

getActiveItem

Communicator.Markup.Note.NoteTextManager.getActiveItem()

Get the currently active note text

Return type

{  }

Returns

Currently active note text

getActiveItemHandle

Communicator.Markup.Note.NoteTextManager.getActiveItemHandle()

Get the active handle string, such as the one returned by MarkupManager.registerMarkup

Return type

{  }

Returns

Active handle string

getExplodeActive

Communicator.Markup.Note.NoteTextManager.getExplodeActive()

Gets managers explosion state. Active explosion hides note pins

Return type

boolean

getIsolateActive

Communicator.Markup.Note.NoteTextManager.getIsolateActive()

Gets whether an isolate is currently active or not

Return type

boolean

Returns

isolate status

getNoteTextElement

Communicator.Markup.Note.NoteTextManager.getNoteTextElement()

Retrieves the note text element

Return type

Communicator.Markup.Note.NoteTextElement

Returns

note text element

getNoteTextList

Communicator.Markup.Note.NoteTextManager.getNoteTextList()

Gets an array of all NoteText items that have been added to the manager

Return type

[NoteText]

Returns

array of all NoteText items

getPinSphereMeshId

Communicator.Markup.Note.NoteTextManager.getPinSphereMeshId()

Retrieves the mesh id of the spherical head of the note pin, if there is one

Return type

{  }

Returns

MeshId of the note pin sphere, or null if there is none

getPinStemMeshId

Communicator.Markup.Note.NoteTextManager.getPinStemMeshId()

Retrieves the mesh id of the stem of the note pin, if there is one

Return type

{  }

Returns

MeshId of the note pin stem, or null if there is none

loadData

Communicator.Markup.Note.NoteTextManager.loadData(notes)

Loads notes from an iterable of JSON data like that returned by exportMarkup

Arguments
  • notes (any()) – JSON note data iterable

Return type

Promise[[boolean]]

removeNote

Communicator.Markup.Note.NoteTextManager.removeNote(note)

Removes a note from the manager

Arguments
  • note (NoteText()) – NoteText to be removed from the manager

Return type

void

selectPin

Communicator.Markup.Note.NoteTextManager.selectPin(selection)

Attempts to set the active note to the one associated with the pins elected by the provided SelectionItem

Arguments
  • selection (Communicator.Selection.SelectionItem()) – SelectionItem to attempt to find note from

Return type

boolean

setActiveItem

Communicator.Markup.Note.NoteTextManager.setActiveItem(activeItem)

Sets a new currently active note text

Arguments
  • activeItem ({  }()) – note text to be marked as currently active

Return type

void

setActiveItemHandle

Communicator.Markup.Note.NoteTextManager.setActiveItemHandle(activeItemHandle)

Set the active handle string, should be provided by MarkupManager.registerMarkup

Arguments
  • activeItemHandle ({  }()) – Active handle string

Return type

void

setIsolateActive

Communicator.Markup.Note.NoteTextManager.setIsolateActive(isolateActive)

Sets whether an isolate is currently active or not

Arguments
  • isolateActive (boolean()) –

Return type

void

setNoteTextElement

Communicator.Markup.Note.NoteTextManager.setNoteTextElement(noteTextElement)

Sets the note text element

Arguments
Return type

void

updatePinVisibility

Communicator.Markup.Note.NoteTextManager.updatePinVisibility()

Updates note pin visibility based on manager state (namely the current explode state)

Return type

Promise[void]