JSColorPolygon

API for creating and modifying gradient polygon objects.

Create a API with Module.createColorPolygon.

var colorPolygon = Module.createColorPolygon("ID");

Function

getId() → string

Returns the Key of the object.

Information

• Return

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

  • null: If the object is null.

Template

var strKey = object.getId();

SetVerticalPlane(coordinates, parts, height, startColor, endColor) → boolean

Creates a vertical wall polygon object.

Object is configured with parameter.

Information

Name	Type	Description
coordinates	JSVec3Array	List of longitude, latitude, altitude coordinates.
parts	Collection	List of the number of points composing the polygon.
height	number	Height of the polygon.
startColor	JSColor	Gradient start color.
endColor	JSColor	Gradient end color.

• Return

  • true : Object creation successful.

  • false : Object creation failed.

  • failure condition.

    • No components in the entered coordinates or the number of vertices is less than 2.

    • No components in the entered parts or less than 1 part.

• Sample

  • Refer to function createVerticalPlane.

  • Sandbox_Polygon Gradient

Template

var colorPolygon = Module.createColorPolygon("TEST_VERTICAL_POLYGON");

var basePositions = [
    [129.12599597147187, 35.17339329004985, 50.0],
    [129.1264736891435, 35.172432534300555, 50.0],
    [129.12705822860582, 35.172119138064076, 50.0],
    [129.12837813524428, 35.17198042514761, 50.0],
    [129.12925806742587, 35.171677294599604, 50.0],
    [129.13014427905534, 35.1712405752301, 50.0],
    [129.13067851056573, 35.170639446735436, 50.0],
];

var coordinates = new Module.JSVec3Array();
var parts = new Module.Collection();

for (var i = 0; i < basePositions.length; i++) {
    coordinates.push(new Module.JSVector3D(basePositions[i][0], basePositions[i][1], basePositions[i][2]));
}
parts.add(basePositions.length);

colorPolygon.SetVerticalPlane(coordinates, parts, -50.0, new Module.JSColor(0, 255, 255, 0), new Module.JSColor(255, 255, 0, 0));

SetCullMode(type) → boolean

Sets the culling option for the vertical wall polygon.

The culling option based on the input value of type is 0(both sides), 1(both sides), 2(CW), 3(CCW).

The initial culling option setting is 3.

Information

Name	Type	Description
type	number	Polygon culling mode

• Return

  • true : Option setting successful.

  • false : Option setting failed.

• Sample

  • Refer to function createVerticalPlane.

  • Sandbox_Polygon Gradient

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