new MaskSegmentHelper(mask)
Mask segment helper.
| Name | Type | Description |
|---|---|---|
mask | object | The associated mask image. |
Methods
addToHidden(segmentNumber)
Add a segment to the hidden list.
| Name | Type | Description |
|---|---|---|
segmentNumber | number | The segment number. |
deleteSegment(segmentNumber, cmdCallback, exeCallback)
Delete a segment.
| Name | Type | Description |
|---|---|---|
segmentNumber | number | The segment number. |
cmdCallback | function | The command event callback. |
exeCallback | function | The post execution callback. |
getAlphaFunc() → {function}
Get the alpha function to apply hidden colors.
The corresponding alpha function.
- Type:
- function
getSegment(segmentNumber) → {object}
Get a segment from the inner segment list.
| Name | Type | Description |
|---|---|---|
segmentNumber | number | The segment number. |
The segment.
- Type:
- object
getSegments() → {Array}
Get the inner segment list.
The list of segments.
- Type:
- Array
hasSegment(segmentNumber) → {boolean}
Check if a segment is part of the inner segment list.
| Name | Type | Description |
|---|---|---|
segmentNumber | number | The segment number. |
True if the segment is included.
- Type:
- boolean
isHidden(segmentNumber) → {boolean}
Check if a segment is in the hidden list.
| Name | Type | Description |
|---|---|---|
segmentNumber | number | The segment number. |
True if the segment is in the list.
- Type:
- boolean
maskHasSegments(numbers) → {Array}
Check if a segment is present in a mask image.
| Name | Type | Description |
|---|---|---|
numbers | Array | Array of segment numbers. |
Array of boolean set to true if the segment is present in the mask.
- Type:
- Array
removeFromHidden(segmentNumber)
Remove a segment from the hidden list.
| Name | Type | Description |
|---|---|---|
segmentNumber | number | The segment number. |
setHiddenSegments(list)
Set the hidden segment list. TODO: not sure if needed...
| Name | Type | Description |
|---|---|---|
list | Array | The list of hidden segment numbers. |
setSegments(list)
Set the inner segment list.
| Name | Type | Description |
|---|---|---|
list | Array | The segment list. |
(inner) getHiddenIndex(segmentNumber) → {number|undefined}
Get the index of a segment in the hidden list.
| Name | Type | Description |
|---|---|---|
segmentNumber | number | The segment number. |
The index in the array.
- Type:
- number |
undefined