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
Name |
Type |
Description |
Geometry editor. Inherited from IGeometryEditorChildModel. |
||
Event manager. Inherited from IEventEmitter. |
||
Geometry of the model. Inherited from IGeometryEditorChildModel. |
Methods
Name |
Returns |
Description |
destroy() |
Destructor. Inherited from IGeometryEditorModel. |
|
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. |
Returns a reference to the model for the next vertex. |
||
Returns the parent data model. Inherited from IGeometryEditorChildModel. |
||
Number[] |
Returns the model's pixel data. Inherited from IGeometryEditorModel. |
|
Returns a reference to the model for the previous vertex. |
||
Sets global pixel coordinates of the vertex. |
||
Sets the index of the child vertex in the parent model. |
||
Sets the reference to the model for the next vertex. |
||
Sets the model's pixel data. Inherited from IGeometryEditorChildModel. |
||
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:
Parameter |
Default value |
Description |
— |
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:
Parameter |
Default value |
Description |
— |
Type: Integer Index of a child vertex. |
* Mandatory parameter/option.
setNextVertex
{} setNextVertex(nextVertex)
Sets the reference to the model for the next vertex.
Parameters:
Parameter |
Default value |
Description |
— |
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:
Parameter |
Default value |
Description |
— |
Type: geometryEditor.model.ChildVertex|null Model for the previous vertex. |
* Mandatory parameter/option.
Mandatory parameter/option.