JSAntenna

API for creating and configuring 3D model objects for radio coverage range.

Create the Module.CreateAntenna API.

var object = Module.CreateAntenna("ID");

Function

CreateCoverageCone(position, height, radius, angle, x, segment) → boolean

Create a 3D model object for radio coverage range.

Information

Name	Type	Description
position	JSVector3D	Starting latitude and longitude for the radio signal
height	number	Height setting for radio modeling from the starting latitude and longitude
radius	number	Radius setting for radio modeling (input radius>0)
angle	number	Angle setting for radio modeling waveform (input angle>-90, angle<90)
x	number	Width setting for radio modeling waveform angle
segment	number	Precision setting for radio modeling (input segment>3)

• Return

  • true : Object creation successful

  • false : Object creation failed

  • Failure conditions.

    • effect_radius < 0 value is set

    • effect_angle < -90, effect_angle > 90 value is set

    • effect_radius < 3 value is set

• Sample

  • Refer to the create function.

  • Sandbox_Radio Coverage

Template

SetCoverageDistance(radius) → boolean

Change the model radius of the radio coverage.

Information

Name	Type	Description
radius	number	Radius setting for radio modeling (input radius > 0)

• Return

  • true : Radius setting successful

  • false : Radius setting failed

  • Failure conditions.

    • radius < 0 value is set

• Sample

  • Refer to the SetCoverageDistance function.

  • Sandbox_Radio Coverage

Template

Getter / Setter

getDescription(), setDescription(desc) → string

Set a description for the object.

Information

Name	Type	Description
desc	string	Object description string.

• Return

  • string: Successful return of the object's description string.

  • null: If the object is null.

Template

var strDesc = object.getDescription();
// ... or ...
object.setDescription("First Object.");

getName(), setName(name) → string

Sets the name of the object.

Information

Name	Type	Description
name	string	The name to set for the object.

• Return

  • string: Successful return of the object's name.

  • null: If the object is null.

Template

var objName = object.getName();
// ... or ...
object.setName("MyObject");

getVisible(), setVisible(visible) → boolean

Sets the visibility state of an object.

Information

Name	Type	Description
visible	boolean	true: Make the object visible. false: Hide the object.

• Return

  • true: Object visible state.

  • false: Object hidden state.

Template

var objName = object.getName();
// ... or ...
object.setVisible(true);