JSCamera

API for map camera settings.

Create the Module.getViewCamera API.

var camera = Module.getViewCamera();

Function

AltitudeDown()

Lowers the camera's altitude.

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.AltitudeDown();

AltitudeUp()

Raises the camera's altitude.

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.AltitudeUp();

AngleDown()

Lowers the camera's tilt angle.

Does not work in planar mode, which does not support rotation.

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.AngleDown();

AngleUp()

Raises the camera's tilt angle.

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.AngleUp();

FOVDecrease()

Decreases the camera's FOV.

Information

Template

Module.getViewCamera().FOVDecrease();

FOVIncrease()

Increases the camera's FOV.

Information

Template

Module.getViewCamera().FOVIncrease();

getMapZoomLevel() -> number

Returns the camera Zoom Level.

Information

• Return

  • number: The current camera's zoom level

Template

var API = {
    JSCamera : Module.getViewCamera();
};
var ZoomLevel= API.JSCamera.getMapZoomLevel();

look(from, to) → boolean

Moves the camera using two points, from and to.

Information

Name	Type	Description
from	JSVector3D	Camera position (longitude, latitude, altitude).
to	JSVector3D	Position the camera is looking at (longitude, latitude, altitude).

• Return

  • true : Success.

  • false : Failure.

• Sample

  • See function init.

  • Sandbox_Circular Path Movement

Template

Module.getViewCamera().look(new Module.JSVector3D(129.128265, 35.171834, 500.0), new Module.JSVector3D(129.128265, 35.161834, 10.0));

MapRender()

Refreshes the map rendering screen.

Information

Template

Module.getViewCamera().MapRender();

move(position, tilt, direct, speed)

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

Information

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

Template

Module.getViewCamera().move(new Module.JSVector3D(129.128265, 35.171834, 500.0), 70, 0, 0);

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.

Information

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.

Template

var API = {
    JSCamera : Module.getViewCamera();
};
var vTargetPos = new Module.JSVector3D(longitude, latitude, altitude);
API.JSCamera.moveDist(vTargetPos, 45.0, 90.0, 1, 0.0);

MoveDown()

Moves the camera backward.

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.moveDown();

MoveLeft()

Moves the camera to the left side.

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.moveLeft();

moveLonLat(longitude, latitude)

Moves the camera to a specified latitude and longitude.

Information

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

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.moveLonLat(127.0273188, 37.4977981);

moveLonLatAlt(x, y, z, type)

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

Information

Name	Type	Description
x	number	Camera longitude.
y	number	Camera latitude.
z	number	Camera altitude.
type	boolean	Apply camera movement animation.

• Sample

  • See function init.

  • Sandbox_Path Movement

Template

var height = Module.getMap().getTerrHeight(126.92836647767662, 37.52439503321471);

moveLonLatAltOval(longitude, latitude, altitude, speed)

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

Information

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.

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.moveLonLatAltOval(127.0273188, 37.4977981, 500.0, 1);

moveLonLatBoundarybyJson(option) → string

Moves the camera using min, max boundary.

Information

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

Template

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.

Information

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.

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.moveLonLatOval(127.0273188, 37.4977981, 1);

moveOval(position, tilt, direct, speed)

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

Information

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

Template

Module.getViewCamera().moveOval(new Module.JSVector3D(129.128265, 35.171834, 500.0), 70, 0, 1);

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.

Information

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.

Template

var API = {
    JSCamera : Module.getViewCamera();
};
var vTargetPos = new Module.JSVector3D(longitude, latitude, altitude);
API.JSCamera.moveOvalDist(vTargetPos, 45.0, 90.0, 0.0, 1);

MoveRight()

Moves the camera to the right side.

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.moveRight();

MoveUp()

Moves the camera forward.

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.moveUp();

pauseAutoMove(pause) -> boolean

Pauses the camera's automatic movement.

Information

Name	Type	Description
pause	boolean	Auto movement setting. True: Pause. False: Resume.

• Return

  • True : Success.

  • False : Failure.

• Sample

  • See function pauseCameraAutoMove.

  • Sandbox_Path Movement

Template

Module.getViewCamera().pauseAutoMove(true);

reset()

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

Information

Template

Module.getViewCamera().reset();

rotateLeft()

Rotates the camera to the left side of the view.

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.rotateLeft();

rotateRight()

Rotates the camera to the right side of the view.

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.rotateRight();

setDistance(Dist)

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

Information

Name	Type	Description
Dist	number	Setting distance(in meters).

Template

Module.getViewCamera().setDistance(500.0);

setAltitude(alt)

Sets the camera's altitude.

Information

Name	Type	Description
alt	number	Camera altitude.

• Sample

  • See function setAltitude.

  • Sandbox_Camera Setting

Template

Module.getViewCamera().setAltitude(1000);

setAutoMovePosition(coordinates) → boolean

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

Information

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

Template

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.

Information

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

Template

Module.getViewCamera().setAutoMoveWaitFrame(3);

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

Sets the camera to move in a circular path.

Information

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

Template

Module.getViewCamera().setAutoMoveRoundPositions(new Module.JSVector3D(129.12732457984308, 35.171000072302796, 4.0), 400.0, 350.0, -130.0, -160.0, true);

SetCameraShakeEffect(type) → boolean

Sets the camera shake effect.

Information

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

Template

Module.getViewCamera().SetCameraShakeEffect(true);

SetCameraShakeStrength(value) → boolean

Sets the strength of the camera shake effect.

Information

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

Template

Module.getViewCamera().SetCameraShakeStrength(50);

setPermitUnderGround(type)

Allows or disallows camera movement below the ground.

Information

Name	Type	Description
type	boolean	Permit camera movement below the ground.

Template

Module.getViewCamera().setPermitUnderGround(true);

startAutoMove() → boolean

Starts the camera's automatic movement.

Information

• Return

  • true : Success.

  • false : Failure.

• Sample

  • See function startCameraAutoMove.

  • Sandbox_Path Movement

Template

Module.getViewCamera().startAutoMove();

stopAutoMove() → boolean

Stops the camera's automatic movement.

Information

• Return

  • true : Success.

  • false : Failure.

• Sample

  • See function stopCameraAutoMove.

  • Sandbox_Path Movement

Template

Module.getViewCamera().stopAutoMove();

viewNorth()

Rotates the camera to face true north.

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.viewNorth();

ZoomIn()

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

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.ZoomIn();

ZoomOut()

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

Information

Template

var API = {
    JSCamera : Module.getViewCamera();
};
API.JSCamera.ZoomOut();

getLocation() -> JSVector3D

Returns the camera's location.

Information

• Return

  • JSVector3D: Returns the location coordinates (longitude, latitude, altitude) of the camera successfully.

  • null: Coordinate return failed.

Template

var API = {
    JSCamera : Module.getViewCamera();
};
var location = API.JSCamera.getLocation();

setLocation(position) → boolean

Sets the camera's location.

Information

Name	Type	Description
position	JSVector3D	Camera location coordinates (longitude, latitude, altitude).

• Return

  • true : Success.

  • false : Failure.

• Sample

  • See function setMove.

  • Sandbox_Camera Setting

Template

Module.getViewCamera().setLocation(new Module.JSVector3D(129.128265, 35.171834, 500.0));

Getter / Setter

getAnimationSpeed(), setAnimationSpeed(speed) -> number

Sets the speed of the camera movement animation.

Information

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

Template

var speed = Module.getViewCamera().getAnimationSpeed();
Module.getViewCamera().setAnimationSpeed(5);

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

Information

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

Template

var API = {
    JSCamera : Module.getViewCamera();
};
var direct= API.JSCamera.getDirect();
Module.getViewCamera().setDirect(0);

getFov(), setFov(fov) -> number

Sets the camera's FOV.

Information

Name	Type	Description
fov	number	Camera fov.

• Return

  • number: The current camera FOV angle in degrees.

• Sample

  • See function setFOV.

  • Sandbox_Camera Setting

Template

var API = {
    JSCamera : Module.getViewCamera();
};
var FOV= API.JSCamera.getFOV();
Module.getViewCamera().setFov(50);

getMoveMode(), setMoveMode(type) -> boolean

Returns the camera's rotation mode.

Information

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

Template

Module.getViewCamera().getMoveMode();
Module.getViewCamera().setMoveMode(true);

getLimitAltitude(), setLimitAltitude(alt) -> number

Sets the minimum altitude limit for the camera.

Information

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

Template

var API = {
    JSCamera : Module.getViewCamera();
};
var limitAltitude = API.JSCamera.getLimitAltitude();
Module.getViewCamera().setLimitAltitude(3000);

getLimitTilt(), setLimitTilt(tilt) -> number

Sets the camera's tilt angle limit.

Information

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

Template

var API = {
    JSCamera : Module.getViewCamera();
};
var limitTilt = API.JSCamera.getLimitTilt();
Module.getViewCamera().setLimitTilt(80);

getTilt(), setTilt(tilt) -> number

Returns the camera's current tilt.

Information

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

Template

var API = {
    JSCamera : Module.getViewCamera();
};
var currentTilt = API.JSCamera.getTilt();
Module.getViewCamera().setTilt(80);

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.