JSArrow

API for creating and configuring 3D model arrow objects.

Create a API with Module.CreateArrow.

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

Function

getId() → string

Returns the object's Key.

Information

• Return

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

  • null: If the object is null.

Template

var strKey = object.getId();

Create(position, pan, tilt, distance, radius, head_rate, arrow_radius, color) → boolean

Creates a 3D model arrow object.

Rotation information based on the pan input value

• 0, 360 (north).

• 90 (east).

• 180 (south).

• 270 (west).

Rotation information based on the tilt input value

• 0 (front).

• tilt < 0 (upward).

• tilt > 0 (downward).

Information

Name	Type	Description
position	JSVector3D	Starting latitude and longitude of the arrow.
pan	number	Y-axis rotation setting for the arrow.
tilt	number	X-axis rotation setting for the arrow.
distance	number	Total length of the arrow.
radius	number	Thickness of the arrow shaft.
head_rate	number	Ratio of the arrowhead.
arrow_radius	number	Thickness of the arrowhead.
color	JSColor	Color of the arrow.

• Return

  • true : Object creation successful.

  • false : Object creation failed.

• Sample

  • Refer to the init function.

  • Sandbox_Arrow(3D)

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);