DashLineCommunicationLink

Dashed line link special effect class, inherited fromCommunicationLinkBase
Name Type Description
options Object The object has the following properties:
Name Type Default Description
visible Boolean true optional Effect Visibility
startUUID String The UUID of the geographic entity where the signal originates.
endUUID String The UUID of the geographic entity where the signal ends.
startOffset MPoint3D MPoint3D(0,0,0.5) optional The offset percentage of the link start point relative to the size of the start model itself.
endOffset MPoint3D MPoint3D(0,0,0.5) optional The offset percentage of the link end point relative to the size of the end model itself.
maxVisibleDistance Boolean -1 optional When the distance between the start and end positions is less than this distance, the link is diaplayed; the setting is ineffective when the value is -1.
speedV Number 5.0 optional Signal propagation speed.
lineWidth Number 1.0 optional Line width.
dashLength Number 16.0 optional Dashed line length (in pixels).
dashPattern Number 255.0 optional Dashed line with a 16-bit pattern template.
signalColor Number Color(1, 0, 0, 1) optional Signal color.
gapColor Number Color(0, 0, 0, 0) optional The color of the gaps between the dashes of a dashed line.

Extends

Methods

addEffectToScene(scene)

Add special effects to the scene.
Name Type Description
scene scene Scene
Inherited From:

clone() → DashLineCommunicationLink

Clone
Returns:
Return the cloned object.

destroy()

Release resources.
Inherited From:

fromJSON(jsonObj)

Convert the JSON object to a special effect object.
Name Type Description
jsonObj Object

getDashLength() → Number

Get the dashed line length (in pixels).
Returns:
Dashed line length.

getDashPattern() → Number

Get the pattern template of the dashed line.
Returns:
Pattern template of the dashed line

getEndOffset() → MPoint3D

Get the offset of the end point relative to the size of the start model itself.
Returns:
Offset.
Inherited From:

getEndUUID() → String

Get the UUID of the end geographic entity.
Returns:
Entity UUID.
Inherited From:

getGapColor() → Color

Get the color of the gaps between the dashes of a dashed line.
Returns:
Color of gaps between the dashes of a dashed line.

getGeoEntity() → GeoEntity

Get the geographic entity bound to the special effect.
Returns:
Geographic entity.
Inherited From:

getLineWidth() → Number

Get the line width (in pixels).
Returns:
Line width.

getLinkType() → CommunicationLinkType

Get the link type.
Returns:
Link type.
Inherited From:

getMaxVisibleDistance() → Number

Get the maximum visible diatance. When the distance between the start and end position is less than this distance, the link is displayed.
Returns:
Maximum visible distance.
Inherited From:

getName() → String

Special effect name.
Returns:
Special effect name.
Inherited From:

getOffset() → MPoint3D

Get the offset percentage relative to the entity´s size.
Returns:
The offset percentage in the X/Y/Z directions.
Inherited From:

getSignalColor() → Color

Get the signal line color.
Returns:
Signal line color.

getSpeedV() → Number

Get the propagation speed.
Returns:
Propagation speed.

getStartOffset() → MPoint3D

Get the offset percentage of the start point relative to the size of the start model itself.
Returns:
Offset.
Inherited From:

getStartUUID() → String

Get the UUID of the start geographic entity.
Returns:
Entity UUID.
Inherited From:

getType() → GeoEntityEffectType

Get the special effect type.
Returns:
Special effect type.
Inherited From:

getUUID() → String

Get the special effect UUID, which is the unique identifier.
Returns:
UUID
Inherited From:

isChangeSizeFlowModel() → Boolean

Check if the special effects adjust with the model´s scaling.
Returns:
Whether to adjust with the model´s scaling.
Inherited From:

isVisible() → Boolean

Get the special effect visibility.
Returns:
Visibility
Inherited From:

removeEffectFromScene(scene)

Remove the special effect from the scene.
Name Type Description
scene scene Scene
Inherited From:

setChangeSizeFlowModel(bChange)

Set whether the special effects adjust with the model´s scaling.
Name Type Description
bChange Boolean Whether to adjust with the model´s scaling.
Inherited From:

setDashLength(dashLength)

Set the dashed line length (in pixels).
Name Type Description
dashLength Number Dashed line length.

setDashPattern(dashPattern)

Retrieve the dashed line's template by converting numbers to binary, coloring each bit position, where a '1' indicates fill and '0' indicates no fill.
Name Type Description
dashPattern Number Dashed line's template.

setEndOffset(pntOffset)

Set the offset of the end point relative to the size of the start model itself.
Name Type Description
pntOffset MPoint3D Offset
Inherited From:

setEndUUID(endUUID)

Set the UUID of the end geographic entity.
Name Type Description
endUUID String Entity UUID.
Inherited From:

setGapColor(color)

Set the color of the gaps between the dashes of a dashed line.
Name Type Description
color Color Color of gaps between the dashes of a dashed line.

setGeoEntity(geoEntity)

Set the geographic entity bound to the special effect.
Name Type Description
geoEntity GeoEntity Geographic entity.
Inherited From:

setGeoEntityParameter(geoEntityParameter, linkGeoEntityUUID)

Set the special effect properties.
Name Type Description
geoEntityParameter GeoEntityParameter Geographic entity parameter class.
linkGeoEntityUUID String optional Entity UUID.

setLineWidth(lineWidth)

Set line width (in pixels).
Name Type Description
lineWidth Number Line width.

setMaxVisibleDistance(dMaxDistance)

Set the maximum visible distance. When the distance between the start and end position is less than this distance, the link is displayed.
Name Type Description
dMaxDistance Number Maximum visible distance
Inherited From:

setName(name)

Special effect name.
Name Type Description
name String Name
Inherited From:

setOffset(pntOffset)

Set the offset percentage relative to the model´s size.
Name Type Description
pntOffset MPoint3D The offset percentage in the X/Y/Z directions.
Inherited From:

setSignalColor(color)

Set the signal line color.
Name Type Description
color Color Signal line color.

setSpeedV(speedV)

Set the propagation speed.
Name Type Description
speedV Number Propagation speed.

setStartOffset(pntOffset)

Set the offset of the start point relative to the size of the start model itself.
Name Type Description
pntOffset MPoint3D Offset
Inherited From:

setStartUUID(startUUID)

Set the UUID of the start geographic entity.
Name Type Description
startUUID String Entity UUID
Inherited From:

setVisible(visible)

Set the special effect visibility.
Name Type Description
visible Boolean Visibility.
Inherited From:

toJSON() → String

Convert a special effect object to a JSON object.
Returns:
JSON object