BasicLineCommunicationLink

This class is used to define basic linkage effects, which is 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.
signalLengthRatio Number 1.0 optional Signal length ratio (0 to 1).
signalColor Color Color(0.21, 1, 0.027, 0.78) optional Signal color.
linkLineColor Color Color(0.92, 0.92, 0.92, 0.19) optional Connection line color.
bBothWay Boolean true optional Is it bidirectional propagation?

Extends

Methods

addEffectToScene(scene)

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

clone() → BasicLineCommunicationLink

Clone
Returns:
Return the cloned object.

destroy()

Release resources.
Inherited From:

fromJSON(jsonObj)

Convert JSON to an object.
Name Type Description
jsonObj Object JSON object

getbBothWay() → Boolean

Check if the signal is bidirectional propagation.
Returns:
Is it bidirectional propagation?

getEndOffset() → MPoint3D

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

getEndUUID() → String

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

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.

getLinkLineColor() → Color

Get the connection line color.
Returns:
Connection line color.

getLinkType() → CommunicationLinkType

Get the link type.
Returns:
Signal 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:
Return the 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.

getSignalLengthRatio() → Number

Get the signal line length ratio (0 to 1).
Returns:
Signal line length ratio.

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:

setbBothWay(bBothWay)

Set whether the signal is bidirectional.
Name Type Description
bBothWay Boolean Is it propagation bidirectional?

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:

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:

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.

setLinkLineColor(color)

Set the connection line color.
Name Type Description
color Color Connection line color.

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.
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 signal line color.
Name Type Description
color Color Signal line color.

setSignalLengthRatio(signalLengthRatio)

Set the signal line length ratio.
Name Type Description
signalLengthRatio Number Signal line length ratio.

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 an object to JSON.
Returns:
JSON string.