JSPipe

API for creating and modifying Pipe objects.

Create a Pipe object with Module.createPipe API.

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

Function

create(coordinates, startColor, endColor, segment, radius, width) → boolean

Creates a 3D pipe object.

Object settings through parameter variables.

A segment input value > 3 is required.

A radius input value > 0 is required.

Information

Name	Type	Description
coordinates	Collection	List of longitude, latitude, altitude coordinates.
startColor	JSColor	Start point color.
endColor	JSColor	End point color.
segment	number	Number of sides for the cross-section.
radius	number	Radius.
width	number	Line thickness in line representation.

• Return

  • true: Object creation was successful.

  • false: Object creation failed.

• Sample

  • Refer to function createUndergroundFacility.

  • Sandbox_Creating Excavation

Template

getExtent() → number

Returns the distance between Min-Max of the object boundary Box.

Information

• Return

  • number: Distance between Min-Max of the object boundary Box.

Template

var bExtends = figure.getExtent();

getId() → string

Returns the ID of the object.

Information

• Return

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

  • null: If the object is null.

Template

lat strKey = object.getId();

getPositions() → JSVec3Array

Returns a list of coordinates that make up a JSPipe object.

Information

• Return

  • JSVec3Array: Successfully returned a list of coordinates that make up a object.

  • null: Coordinate return failed.

Template

getRadius() → number

Returns the radius of the pipe.

Information

• Return

  • Pipe radius applied to object (in meters)

Template

moveVertically(altitude) → boolean

Sets the height of the 3D pipe.

Altitude input must be greater than -1000 (based on sea level altitude).

Information

Name	Type	Description
altitude	number	Height reset value.

• Return

  • true: Object setting successful.

  • false: Object setting failed.

Template

setColor(starColor, endColor) → boolean

Sets the color of the start and end points of the 3D pipe.

Information

Name	Type	Description
startColor	JSColor	Start point color.
endColor	JSColor	End point color.

• Return

  • true: Object setting successful.

  • false: Object setting failed.

Template

setFlow(startColor, endColor, segment, interval) → boolean

Sets the internal flow representation of the 3D pipe.

A segment (integer) input value >3 is required.

An interval (float) input value >0 is required.

Information

Name	Type	Description
startColor	JSColor	Flow start color.
endColor	JSColor	Flow end color.
segment	number	Number of points for flow composition.
interval	number	Interval of flow representation arrows.

• Return

  • true: Object setting successful.

  • false: Object setting failed.

• Sample

  • Refer to function createUndergroundFacility.

  • Sandbox_Creating Excavation

Template

setFlowDisplay(type) → boolean

Sets the visibility of the internal flow representation of the 3D pipe.

Information

Name	Type	Description
type	boolean	true for flow visualization. false for default visualization.

• Return

  • true: Object setting successful.

  • false: Object setting failed.

• Sample

  • Refer to function createUndergroundFacility.

  • Sandbox_Creating Excavation

Template

setFlowWaitFrame(farme) → boolean

Sets the number of frames for updating the internal flow of the 3D pipe.

Frame (integer) component count > 0 is required.

Information

Name	Type	Description
frame	number	Number of frames to update.

• Return

  • true: Object setting successful.

  • false: Object setting failed.

• Sample

  • Refer to function createUndergroundFacility.

  • Sandbox_Creating Excavation

Template

setSimplifyRange(range) → boolean

Sets the distance for simplified representation of the 3D pipe.

A range input value > 0 is required.

Simplified representation omits flow representation.

Information

Name	Type	Description
range	number	Object precision representation distance

• Return

  • true: Object setting successful.

  • false: Object setting failed.

• Sample

  • Refer to function createPipe.

  • Sandbox_Pipe

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