JSCamera

API for map camera settings.

Create the Module.getViewCamera API.

var camera = Module.getViewCamera();

Function

AltitudeDown()

Lowers the camera's altitude.

AltitudeUp()

Raises the camera's altitude.

AngleDown()

Lowers the camera's tilt angle.
Does not work in planar mode, which does not support rotation.

AngleUp()

Raises the camera's tilt angle.

FOVDecrease()

Decreases the camera's FOV.

FOVIncrease()

Increases the camera's FOV.

getMapZoomLevel() -> number

Returns the camera Zoom Level.

Return
- number: The current camera's zoom level

look(from, to) → boolean

Moves the camera using two points, from and to.

Name

Type

Description

from

JSVector3D

Camera position (longitude, latitude, altitude).

JSVector3D

Position the camera is looking at (longitude, latitude, altitude).

Return
- true : Success.
- false : Failure.
Sample
- See function init.
- Sandbox_Circular Path Movement

MapRender()

Refreshes the map rendering screen.

move(position, tilt, direct, speed)

Moves the camera to a desired location and sets Tilt, Direct.

Name

Type

Description

position

JSVector3D

Camera location coordinates (longitude, latitude, altitude).

tilt

number

Camera tilt.

direct

number

Camera direct.

speed

number

Camera speed.

Sample
- See function init.
- Sandbox_Position Movement

moveDist(location, tilt, direct, dist, speed)

Moves the camera to a specified latitude and longitude based position, then sets the camera angles (tilt, Direct), distance, and speed.

Name

Type

Description

location

JSVector3D

Camera location coordinates (longitude, latitude, altitude).

tilt

number

Tilt to set after moving.

direct

number

Direct to set after moving.

dist

number

Distance to set after moving (currently not applied).

speed

number

Camera movement speed. Speed is an integer greater than 1, with higher values indicating faster movement.

MoveDown()

Moves the camera backward.

MoveLeft()

Moves the camera to the left side.

moveLonLat(longitude, latitude)

Moves the camera to a specified latitude and longitude.

Name

Type

Description

longitude

number

Longitude of the position to move to (in degrees).

latitude

number

Latitude of the position to move to (in degrees).

moveLonLatAlt(x, y, z, type)

Moves the camera to a specified altitude, latitude, and longitude position.

Name

Type

Description

number

Camera longitude.

number

Camera latitude.

number

Camera altitude.

type

boolean

Apply camera movement animation.

Sample
- See function init.
- Sandbox_Path Movement

moveLonLatAltOval(longitude, latitude, altitude, speed)

Moves the camera to a specified altitude, latitude, and longitude with zoom in/out animation during movement.

Name

Type

Description

longitude

number

Longitude of the position to move to (in degrees).

latitude

number

Latitude of the position to move to (in degrees).

altitude

number

Altitude of the position to move to (in meters).

speed

number

Camera movement speed. Speed is an integer greater than 1, with higher values indicating faster movement.

moveLonLatBoundarybyJson(option) → string

Moves the camera using min, max boundary.

Name

Type

Description

option

JSCamera.MoveBoundaryOption

Camera min, max boundary.

Return
- true : Success.
- false : Failure.
- Failure conditions
  - If the complete tag is missing.
Sample
- See function moveTestArea.
- Sandbox_Camera Area Setting

function complete(...args) {
    console.log(args);
}

let json = {
    boundary: {
        // Camera movement position
        min: new Module.JSVector2D(area_min_lon, area_min_lat), // Bottom left
        max: new Module.JSVector2D(area_max_lon, area_max_lat), // Top right
    },
    complete: complete, // Callback after movement completion
};

moveLonLatOval(longitude, latitude, speed)

Moves the camera to a specified latitude and longitude with zoom in/out animation during movement.

Name

Type

Description

longitude

number

Longitude of the position to move to (in degrees).

latitude

number

Latitude of the position to move to (in degrees).

speed

number

Camera movement speed. Speed is an integer greater than 1, with higher values indicating faster movement.

moveOval(position, tilt, direct, speed)

Moves the camera to a specified altitude, latitude, and longitude position with animation effect.

Name

Type

Description

position

JSVector3D

Camera location coordinates (longitude, latitude, altitude).

tilt

number

Camera tilt.

direct

number

Camera direct.

speed

number

Camera speed.

Sample
- See function initPage.
- Sandbox_Landscape View

moveOvalDist(location, tilt, Direct, speed)

Moves the camera to a specified latitude and longitude based position, then sets the camera tilt and direction, distance with zoom in/out animation during movement.

Name

Type

Description

location

JSVector3D

Camera location coordinates (longitude, latitude, altitude).

tilt

number

Tilt to set after moving.

Direct

number

Direct to set after moving.

speed

number

Camera movement speed. Speed is an integer greater than 1, with higher values indicating faster movement.

MoveRight()

Moves the camera to the right side.

MoveUp()

Moves the camera forward.

pauseAutoMove(pause) -> boolean

Pauses the camera's automatic movement.

Name

Type

Description

pause

boolean

Auto movement setting. True: Pause. False: Resume.

Return
- True : Success.
- False : Failure.
Sample
- See function pauseCameraAutoMove.
- Sandbox_Path Movement

reset()

Resets the camera's position and distance properties to their initial state.

rotateLeft()

Rotates the camera to the left side of the view.

rotateRight()

Rotates the camera to the right side of the view.

setDistance(Dist)

Sets the distance between the camera's viewpoint and its position.

Name

Type

Description

Dist

number

Setting distance(in meters).

setAltitude(alt)

Sets the camera's altitude.

Name

Type

Description

alt

number

Camera altitude.

Sample
- See function setAltitude.
- Sandbox_Camera Setting

setAutoMovePosition(coordinates) → boolean

Sets the list of coordinates for the camera's automatic movement.

Name

Type

Description

coordinates

JSVec3Array

List of coordinates for the path of automatic movement.

Return
- true : Success.
- false : Failure.
  - If the engine is not properly loaded.
Sample
- See function setAutoMovePosition.
- Sandbox_Path Movement

var vMovePositionList = new Module.JSVec3Array();
vMovePositionList.push(new Module.JSVector3D(129.12695440075726, 35.16601614946393, 50.0));
vMovePositionList.push(new Module.JSVector3D(129.12188858001704, 35.173578909363805, 50.0));
vMovePositionList.push(new Module.JSVector3D(129.12027302076595, 35.17489727168604, 50.0));
vMovePositionList.push(new Module.JSVector3D(129.1193336034672, 35.176296224587475, 50.0));
Module.getViewCamera().setAutoMovePosition(vMovePositionList);

setAutoMoveWaitFrame(speed) → boolean

Sets the number of frames to update the camera's position during automatic movement.

Name

Type

Description

speed

number

Number of frames for updating the camera position.

Return
- true : Success.
- false : Failure.
  - If the engine is not properly loaded.
Sample
- See function setAutoMovePosition.
- Sandbox_Path Movement

setAutoMoveRoundPositions(center, distance, altitude, startAngle, endAngle, type) → boolean

Sets the camera to move in a circular path.

Name

Type

Description

center

JSVector3D

The point the camera is looking at (longitude, latitude, altitude)

distance

number

Distance between the center point and the camera

altitude

number

Camera altitude

startAngle

number

Starting direction

endAngle

number

Ending direction

type

boolean

Direction setting (true: counterclockwise, false: clockwise)

Return
- true : Success.
- false : Failure.
Sample
- See function setAutoMovePosition
- Sandbox_Circular Path Movement

SetCameraShakeEffect(type) → boolean

Sets the camera shake effect.

Name

Type

Description

type

boolean

Camera shake effect setting.

Return
- true : Success.
- false : Failure.
  - If the engine is not properly loaded.
Sample
- See function ShakeCamera.
- Sandbox_Camera Shake

SetCameraShakeStrength(value) → boolean

Sets the strength of the camera shake effect.

Name

Type

Description

value

number

Camera shake effect strength (1 ~ 100).

Return
- true : Success.
- false : Failure.
  - If the engine is not properly loaded.
Sample
- See function SetShakeEffectStrength.
- Sandbox_Camera Shake

setPermitUnderGround(type)

Allows or disallows camera movement below the ground.

Name

Type

Description

type

boolean

Permit camera movement below the ground.

startAutoMove() → boolean

Starts the camera's automatic movement.

Return
- true : Success.
- false : Failure.
Sample
- See function startCameraAutoMove.
- Sandbox_Path Movement

stopAutoMove() → boolean

Stops the camera's automatic movement.

Return
- true : Success.
- false : Failure.
Sample
- See function stopCameraAutoMove.
- Sandbox_Path Movement

viewNorth()

Rotates the camera to face true north.

ZoomIn()

Zooms in the camera based on the center of the screen.

ZoomOut()

Zooms out the camera based on the center of the screen.

getLocation() -> JSVector3D

Returns the camera's location.

Return
- JSVector3D: Returns the location coordinates (longitude, latitude, altitude) of the camera successfully.
- null: Coordinate return failed.

setLocation(position) → boolean

Sets the camera's location.

Name

Type

Description

position

JSVector3D

Camera location coordinates (longitude, latitude, altitude).

Return
- true : Success.
- false : Failure.
Sample
- See function setMove.
- Sandbox_Camera Setting

Getter / Setter

getAnimationSpeed(), setAnimationSpeed(speed) -> number

Sets the speed of the camera movement animation.

Name

Type

Description

speed

number

Camera movement speed (between 1.0 and 10.0).

Return
- number: The speed of the movement animation.
Sample
- See function setEvent.
- Sandbox_Path Movement

getDirect(), setDirect(direct) -> number

Returns the current direction angle of the camera.
The direction angle values range between -180 degrees and 180 degrees. The direction the camera faces at each angle is as follows:
0 degrees: North
+90 degrees: East
+180 degrees (=-180 degrees): South
-90 degrees: West

Name

Type

Description

direct

number

Camera direct.

Return
- number: The current camera angle's direction angle in degrees.
Sample
- See function setDirect.
- Sandbox_Camera Setting

getFov(), setFov(fov) -> number

Sets the camera's FOV.

Name

Type

Description

fov

number

Camera fov.

Return
- number: The current camera FOV angle in degrees.
Sample
- See function setFOV.
- Sandbox_Camera Setting

getMoveMode(), setMoveMode(type) -> boolean

Returns the camera's rotation mode.

Name

Type

Description

type

boolean

Camera viewpoint.

Return
- The current camera's rotation mode.
  - True: First-person rotation mode.
  - False: Third-person rotation mode.
- False: Failure due to engine not being initialized.
Sample
- See function setPerson.
- Sandbox_Camera Setting

getLimitAltitude(), setLimitAltitude(alt) -> number

Sets the minimum altitude limit for the camera.

Name

Type

Description

alt

number

altitude limit (in meters).

Return
- number: The current minimum altitude limit of the camera in meters.
Sample
- See function initPage.
- Sandbox_Path Movement

getLimitTilt(), setLimitTilt(tilt) -> number

Sets the camera's tilt angle limit.

Name

Type

Description

tilt

number

Desired tilt angle limit.

Return
- number: The current tilt angle limit of the camera in degrees.
Sample
- See function initPage.
- Sandbox_Camera Path Movement

getTilt(), setTilt(tilt) -> number

Returns the camera's current tilt.

Name

Type

Description

tilt

number

Camera tilt.

Return
- number: The current tilt value of the camera in degrees.
Sample
- See function setTilt.
- Sandbox_Camera Setting

Type Definitions

JSCamera.MoveBoundaryOption

Options for moving the camera based on area information.

Name

Type

Attributes

Default

Description

boundary

Rect2D

Camera movement position.

complete

function

Event function after movement completion.

PreviousCamera NextLayer

Last updated 1 year ago

hashtagFunction

hashtagAltitudeDown()

hashtagAltitudeUp()

hashtagAngleDown()

hashtagAngleUp()

hashtagFOVDecrease()

hashtagFOVIncrease()

hashtaggetMapZoomLevel() -> number

hashtaglook(from, to) → boolean

hashtagMapRender()

hashtagmove(position, tilt, direct, speed)

hashtagmoveDist(location, tilt, direct, dist, speed)

hashtagMoveDown()

hashtagMoveLeft()

hashtagmoveLonLat(longitude, latitude)

hashtagmoveLonLatAlt(x, y, z, type)

hashtagmoveLonLatAltOval(longitude, latitude, altitude, speed)

hashtagmoveLonLatBoundarybyJson(option) → string

hashtagmoveLonLatOval(longitude, latitude, speed)

hashtagmoveOval(position, tilt, direct, speed)

hashtagmoveOvalDist(location, tilt, Direct, speed)

hashtagMoveRight()

hashtagMoveUp()

hashtagpauseAutoMove(pause) -> boolean

hashtagreset()

hashtagrotateLeft()

hashtagrotateRight()

hashtagsetDistance(Dist)

hashtagsetAltitude(alt)

hashtagsetAutoMovePosition(coordinates) → boolean

hashtagsetAutoMoveWaitFrame(speed) → boolean

hashtagsetAutoMoveRoundPositions(center, distance, altitude, startAngle, endAngle, type) → boolean

hashtagSetCameraShakeEffect(type) → boolean

hashtagSetCameraShakeStrength(value) → boolean

hashtagsetPermitUnderGround(type)

hashtagstartAutoMove() → boolean

hashtagstopAutoMove() → boolean

hashtagviewNorth()

hashtagZoomIn()

hashtagZoomOut()

hashtaggetLocation() -> JSVector3D

hashtagsetLocation(position) → boolean

hashtagGetter / Setter

hashtaggetAnimationSpeed(), setAnimationSpeed(speed) -> number

hashtaggetDirect(), setDirect(direct) -> number

hashtaggetFov(), setFov(fov) -> number

hashtaggetMoveMode(), setMoveMode(type) -> boolean

hashtaggetLimitAltitude(), setLimitAltitude(alt) -> number

hashtaggetLimitTilt(), setLimitTilt(tilt) -> number

hashtaggetTilt(), setTilt(tilt) -> number

hashtagType Definitions

hashtagJSCamera.MoveBoundaryOption

Function

AltitudeDown()

AltitudeUp()

AngleDown()

AngleUp()

FOVDecrease()

FOVIncrease()

getMapZoomLevel() -> number

look(from, to) → boolean

MapRender()

move(position, tilt, direct, speed)

moveDist(location, tilt, direct, dist, speed)

MoveDown()

MoveLeft()

moveLonLat(longitude, latitude)

moveLonLatAlt(x, y, z, type)

moveLonLatAltOval(longitude, latitude, altitude, speed)

moveLonLatBoundarybyJson(option) → string

moveLonLatOval(longitude, latitude, speed)

moveOval(position, tilt, direct, speed)

moveOvalDist(location, tilt, Direct, speed)

MoveRight()

MoveUp()

pauseAutoMove(pause) -> boolean

reset()

rotateLeft()

rotateRight()

setDistance(Dist)

setAltitude(alt)

setAutoMovePosition(coordinates) → boolean

setAutoMoveWaitFrame(speed) → boolean

setAutoMoveRoundPositions(center, distance, altitude, startAngle, endAngle, type) → boolean

SetCameraShakeEffect(type) → boolean

SetCameraShakeStrength(value) → boolean

setPermitUnderGround(type)

startAutoMove() → boolean

stopAutoMove() → boolean

viewNorth()

ZoomIn()

ZoomOut()

getLocation() -> JSVector3D

setLocation(position) → boolean

Getter / Setter

getAnimationSpeed(), setAnimationSpeed(speed) -> number

getDirect(), setDirect(direct) -> number

getFov(), setFov(fov) -> number

getMoveMode(), setMoveMode(type) -> boolean

getLimitAltitude(), setLimitAltitude(alt) -> number

getLimitTilt(), setLimitTilt(tilt) -> number

getTilt(), setTilt(tilt) -> number

Type Definitions

JSCamera.MoveBoundaryOption