Communicator.Selection.NodeSelectionItem

 NodeSelectionItem

A SelectionItem that is guaranteed to have a valid NodeId.

Methods

equals

  • Determines if two selection items are equal.

    Parameters

    • selectionItem: SelectionItem

      The selection item to test against.

    Returns boolean

    whether or not the two items are equal.

forJson    [deprecated]

  • forJson(): Object

getFaceEntity

getIncludeId    [deprecated]

  • getIncludeId(): InclusionKey | null

getInclusionKey

  • getInclusionKey(): InclusionKey | null
  • Gets the include id for this selection.

    Returns InclusionKey | null

    the inclusion key associated with this selection item

getLineEntity

getNodeId

getPointEntity

getPosition

  • getPosition(): Point3 | null
  • Convenience method for getting the world space position of the selection point. SelectionItems with a type of SelectionType.Part will not have a position and null will be returned.

    Returns Point3 | null

    World space position of the selection point if it can be determined.

getSelectionType

isEntitySelection

  • isEntitySelection(): this

isFaceSelection

  • isFaceSelection(): this

isLineSelection

  • isLineSelection(): this

isNodeEntitySelection

  • isNodeEntitySelection(): this

isNodeSelection

  • isNodeSelection(): this

isPointSelection

  • isPointSelection(): this

overlayIndex

toJson

  • toJson(): Object
  • Creates an object ready for JSON serialization.

    Returns Object

    The prepared object.

Static create