RedlineItem

class Markup.Redline.RedlineItem(): Base class for Redline Markup. It should not be used directly.

Constructors

constructor()

Properties

_viewer

Methods

draw()
getClassName()
hit()
hitWithTolerance()
onDeselect()
onDragEnd()
onDragMove()
onDragStart()
onSelect()
remove()
toJson()

Constructors

RedlineItem.constructor(viewer)

Arguments:	viewer (`WebViewer()`) – None
Return type:	RedlineItem

Properties

RedlineItem._viewer

Type:	WebViewer

Methods

draw

RedlineItem.draw(_renderer, _view)

Arguments:	_renderer (`MarkupRenderer()`) – None _view (`View()`) – None

Called when the markup item should be redrawn on a specific view. This most typically happens when the scene is rendered.

Return type:	void

getClassName

RedlineItem.getClassName()

Gets the fully qualified class name for this markup item. E.g. “Communicator.Markup.Redline.RedlineCircle”

Returns:	fully qualified class name
Return type:	string

hit

RedlineItem.hit(_point, _view)

Arguments:	_point (`Point2()`) – None _view (`View()`) – None

Called when a hit test is performed on this markup item.

Returns:	boolean value indicating whether this item was picked
Return type:	boolean

hitWithTolerance

RedlineItem.hitWithTolerance(_point, _view, _pickTolerance)

Arguments:	_point (`Point2()`) – None _view (`View()`) – None _pickTolerance (`number()`) – None

Called when a hit test is performed on this markup item.

Returns:	boolean value indicating whether this item was picked
Return type:	boolean

onDeselect

RedlineItem.onDeselect()

Called when this markup item is deselected by the system

Return type:	void

onDragEnd

RedlineItem.onDragEnd(_position, _view)

Arguments:	_position (`Point2()`) – None _view (`View()`) – None
Return type:	boolean

onDragMove

RedlineItem.onDragMove(_position, _view)

Arguments:	_position (`Point2()`) – None _view (`View()`) – None
Return type:	boolean

onDragStart

RedlineItem.onDragStart(_position, _view)

Arguments:	_position (`Point2()`) – None _view (`View()`) – None
Return type:	boolean

onSelect

RedlineItem.onSelect()

Called when this markup item is selected by the system.

Return type:	void

remove

RedlineItem.remove()

Called when the MarkupItem is removed from the system. Any cleanup that needs to be done should be performed in this method.

Return type:	void

toJson

RedlineItem.toJson()

Creates an object ready for JSON serialization.

Returns:	The prepared object.
Return type:	object