Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces

geometryEditor.model.ChildVertex

Note. The constructor of the geometryEditor.model.ChildVertex class is hidden, as this class is not intended for autonomous initialization.

Extends IGeometryEditorChildModel.

Model for a child index. The constructor is not available in the package.full (a standard set of modules). This module is loaded on demand.

Fields | Methods

Fields

NameTypeDescription
editorIGeometryEditor

Geometry editor.

Inherited from IGeometryEditorChildModel.

eventsIEventManager

Event manager.

Inherited from IEventEmitter.

geometryIBaseGeometry

Geometry of the model.

Inherited from IGeometryEditorChildModel.

Methods

NameReturnsDescription
destroy()

Destructor.

Inherited from IGeometryEditorModel.

getAllVerticesNumber()

Integer

Returns the total number of vertexes in the geometry being edited.

getIndex()

Integer

Returns the index of the child vertex in the parent model.

getNextVertex()

geometryEditor.model.ChildVertex|null

Returns a reference to the model for the next vertex.

getParent()

IGeometryEditorModel

Returns the parent data model.

Inherited from IGeometryEditorChildModel.

getPixels()

Number[]

Returns the model's pixel data.

Inherited from IGeometryEditorModel.

getPrevVertex()

geometryEditor.model.ChildVertex|null

Returns a reference to the model for the previous vertex.

setGlobalPixels(pixels)

Sets global pixel coordinates of the vertex.

setIndex(index)

Sets the index of the child vertex in the parent model.

setNextVertex(nextVertex)

Sets the reference to the model for the next vertex.

setPixels(pixels)

Sets the model's pixel data.

Inherited from IGeometryEditorChildModel.

setPrevVertex(prevVertex)

Sets the reference to the model for the previous vertex.

Methods details

getAllVerticesNumber

{Integer} getAllVerticesNumber()

Returns the total number of vertexes in the geometry being edited.

getIndex

{Integer} getIndex()

Returns the index of the child vertex in the parent model.

getNextVertex

{geometryEditor.model.ChildVertex|null} getNextVertex()

Returns a reference to the model for the next vertex.

getPrevVertex

{geometryEditor.model.ChildVertex|null} getPrevVertex()

Returns a reference to the model for the previous vertex.

setGlobalPixels

{} setGlobalPixels(pixels)

Sets global pixel coordinates of the vertex.

Parameters:

ParameterDefault valueDescription
pixels*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number[]

Global pixel coordinates of the vertex.

* Mandatory parameter/option.

setIndex

{} setIndex(index)

Sets the index of the child vertex in the parent model.

Parameters:

ParameterDefault valueDescription
index*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Integer

Index of a child vertex.

* Mandatory parameter/option.

setNextVertex

{} setNextVertex(nextVertex)

Sets the reference to the model for the next vertex.

Parameters:

ParameterDefault valueDescription
nextVertex*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: geometryEditor.model.ChildVertex|null

Model for the next vertex.

* Mandatory parameter/option.

setPrevVertex

{} setPrevVertex(prevVertex)

Sets the reference to the model for the previous vertex.

Parameters:

ParameterDefault valueDescription
prevVertex*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: geometryEditor.model.ChildVertex|null

Model for the previous vertex.

* Mandatory parameter/option.