Three.js Blocks

Home
Documentation
Examples
Tools

RTSCamera

@three-blocks/pro
new RTSCamera(physics : Object, options : Object)
Extends
PhysicsCamera

Create an RTSCamera.

Constructor Parameters
physicsObject
Physics instance
optionsoptionalObject
Camera options
Default is {}.
  • canvasoptionalHTMLCanvasElement
    Canvas element for mouse events
  • targetoptionalTHREE.Object3D
    Target object to follow
  • focusoptionalTHREE.Vector3
    Initial focus position (when not following)
  • panOffsetoptionalTHREE.Vector3
    Initial pan offset
  • followTargetoptionalboolean
    Follow target position each frame
    Default is false.
  • distanceoptionalnumber
    Camera distance from focus
    Default is 24.
  • zoomLimitsoptionalObject
    Zoom distance limits
    Default is { min: 14, max: 40 }.
  • zoomSpeedoptionalnumber
    Mouse wheel zoom sensitivity
    Default is 0.8.
  • zoomToCursoroptionalboolean
    Keep cursor point fixed when zooming
    Default is false.
  • groundPlaneYoptionalnumber
    Ground plane height for zoom-to-cursor
    Default is 0.
  • panSpeedoptionalnumber
    Edge scroll speed (units/sec at distance 10)
    Default is 20.
  • dragPanSpeedoptionalnumber
    Drag pan multiplier
    Default is 1.
  • edgeScrolloptionalObject
    Edge scroll options
    Default is { enabled: true, size: '25%', speed: 20 }.
  • rotateSpeedoptionalnumber
    Yaw rotation speed (rad per pixel)
    Default is 0.005.
  • yawoptionalnumber
    Initial yaw (radians)
    Default is 45deg.
  • tiltoptionalnumber
    Tilt angle in radians
    Default is 55deg.
  • allowPitchoptionalboolean
    Allow pitch changes when rotating
    Default is false.
  • minTiltoptionalnumber
    Minimum tilt (radians)
  • maxTiltoptionalnumber
    Maximum tilt (radians)
  • dampingoptionalnumber
    Focus translation damping strength
    Default is 6.
  • panButtonoptionalnumber
    Mouse button for drag pan (0=left,1=middle,2=right, -1 disables)
    Default is 1.
  • rotateButtonoptionalnumber
    Mouse button for rotate (-1 disables)
    Default is -1.
  • fovoptionalnumber
    Field of view
    Default is 50.

Properties

.canvas : HTMLCanvasElement

Canvas element for mouse events.

.distance : number

Camera distance from focus.

.zoomLimits : Object

Zoom distance limits.

.zoomSpeed : number

Mouse wheel zoom sensitivity.

.panSpeed : number

Edge scroll base speed (units/sec at distance 10).

.dragPanSpeed : number

Drag pan multiplier.

.edgeScroll : Object

Edge scroll settings.

.rotateSpeed : number

Rotation speed (radians per pixel).

.yaw : number

Yaw angle (radians).

.tilt : number

Tilt angle (radians).

.allowPitch : boolean

Allow pitch changes when rotating.

.minTilt : number

Min tilt for pitch changes.

.maxTilt : number

Max tilt for pitch changes.

.zoomToCursor : boolean

Keep cursor point fixed when zooming.

.groundPlaneY : number

Ground plane height for zoom-to-cursor.

.followTarget : boolean

Follow target each frame.

.damping : number

Damping strength for focus translation.

.panButton : number

Mouse button for drag pan.

.rotateButton : number

Mouse button for rotate.

Methods

update#

update(delta : number)

Update camera state. Call each frame.

Parameters
deltanumber
Time delta in seconds

resize#

resize(width : number, height : number) : this

Handle window resize. Updates aspect ratio and projection matrix.

Parameters
widthoptionalnumber
New width
heightoptionalnumber
New height
Returns
this — For chaining

setDistance#

setDistance(distance : number) : this

Set camera distance from focus.

Parameters
distancenumber
New distance
Returns
this — For chaining

setZoomLimits#

setZoomLimits(min : number, max : number) : this

Set zoom distance limits.

Parameters
minnumber
Minimum zoom distance
maxnumber
Maximum zoom distance
Returns
this — For chaining

setFocus#

setFocus(position : THREE.Vector3) : this

Set focus position and stop following target.

Parameters
positionTHREE.Vector3
New focus position
Returns
this — For chaining

setFollowTarget#

setFollowTarget(follow : boolean) : this

Enable or disable following the target. When enabling, clears pan offset and recenters on the target.

Parameters
followboolean
Follow target
Returns
this — For chaining

recenter#

recenter() : this

Clear pan offset and recenter on target when available.

Returns
this — For chaining

setGroundPlaneY#

setGroundPlaneY(y : number) : this

Set ground plane height for zoom-to-cursor.

Parameters
ynumber
New ground plane height
Returns
this — For chaining

getPointerIntersection#

getPointerIntersection(target : THREE.Vector3) : THREE.Vector3|null

Get the current pointer intersection position from physics raycast. Returns the world position where the pointer ray intersects geometry.

Parameters
targetoptionalTHREE.Vector3
Optional vector to store the result
Returns
THREE.Vector3 | null — The intersection position, or null if no intersection

dispose#

dispose()

Clean up resources and event listeners.