Skip to content

Documentation / scene / OrthoCamera

Class: OrthoCamera

Defined in: libs/scene/src/camera/orthocamera.ts:10

Orthogonal camera class

Extends

Constructors

Constructor

new OrthoCamera(scene, left?, right?, bottom?, top?, near?, far?): OrthoCamera

Defined in: libs/scene/src/camera/orthocamera.ts:29

Creates an instance of OrthoCamera

Parameters

scene

Scene

The scene that the camera belongs to.

left?

number = -1

The left clip plane

number = 1

The right clip plane

bottom?

number = -1

The bottom clip plane

top?

number = 1

The top clip plane

near?

number = -1

The near clip plane

far?

number = 1

The far clip plane

Returns

OrthoCamera

Overrides

Camera.constructor

Properties

BBOXDRAW_INHERITED

readonly static BBOXDRAW_INHERITED: -1 = -1

Defined in: libs/scene/src/scene/scene_node.ts:166

Bounding-box draw mode inherited from nearest graph ancestor.

Inherited from

Camera.BBOXDRAW_INHERITED


BBOXDRAW_DISABLED

readonly static BBOXDRAW_DISABLED: 0 = 0

Defined in: libs/scene/src/scene/scene_node.ts:168

Disable bounding-box visualization.

Inherited from

Camera.BBOXDRAW_DISABLED


BBOXDRAW_LOCAL

readonly static BBOXDRAW_LOCAL: 1 = 1

Defined in: libs/scene/src/scene/scene_node.ts:170

Draw local-space bounding box.

Inherited from

Camera.BBOXDRAW_LOCAL


BBOXDRAW_WORLD

readonly static BBOXDRAW_WORLD: 2 = 2

Defined in: libs/scene/src/scene/scene_node.ts:172

Draw world-space bounding box.

Inherited from

Camera.BBOXDRAW_WORLD

Accessors

disposed

Get Signature

get disposed(): boolean

Defined in: libs/base/dist/index.d.ts:6065

Returns

boolean

Inherited from

Camera.disposed


compositor

Get Signature

get compositor(): Compositor

Defined in: libs/scene/src/camera/camera.ts:535

The compositor that owns and runs the camera's post-processing chain.

Returns

Compositor

Inherited from

Camera.compositor


interactionRect

Get Signature

get interactionRect(): [number, number, number, number]

Defined in: libs/scene/src/camera/camera.ts:541

Pointer interaction rectangle in css pixels (relative to canvas)

Returns

[number, number, number, number]

Set Signature

set interactionRect(rect): void

Defined in: libs/scene/src/camera/camera.ts:544

Parameters
rect

[number, number, number, number]

Returns

void

Inherited from

Camera.interactionRect


clearColor

Get Signature

get clearColor(): Vector4

Defined in: libs/scene/src/camera/camera.ts:550

Framebuffer clear color, or null to disable.

Returns

Vector4

Set Signature

set clearColor(v): void

Defined in: libs/scene/src/camera/camera.ts:553

Parameters
v

Vector4

Returns

void

Inherited from

Camera.clearColor


clearDepth

Get Signature

get clearDepth(): number

Defined in: libs/scene/src/camera/camera.ts:559

Framebuffer stencil clear value, disabled when null. Default is 0.

Returns

number

Set Signature

set clearDepth(v): void

Defined in: libs/scene/src/camera/camera.ts:562

Parameters
v

number

Returns

void

Inherited from

Camera.clearDepth


clearStencil

Get Signature

get clearStencil(): number

Defined in: libs/scene/src/camera/camera.ts:568

Framebuffer stencil clear value, disabled when null. Default is 0.

Returns

number

Set Signature

set clearStencil(v): void

Defined in: libs/scene/src/camera/camera.ts:571

Parameters
v

number

Returns

void

Inherited from

Camera.clearStencil


HiZ

Get Signature

get HiZ(): boolean

Defined in: libs/scene/src/camera/camera.ts:579

Whether Hi-Z acceleration is enabled.

Often improves SSR performance with little quality impact when supported.

Returns

boolean

Set Signature

set HiZ(val): void

Defined in: libs/scene/src/camera/camera.ts:582

Parameters
val

boolean

Returns

void

Inherited from

Camera.HiZ


screenSpaceShadowMask

Get Signature

get screenSpaceShadowMask(): boolean

Defined in: libs/scene/src/camera/camera.ts:593

Whether the screen-space shadow mask is enabled.

When enabled, shadow-casting lights are lit through the clustered pass and sample a pre-rendered screen-space shadow mask instead of each casting an additional full-scene additive light pass. Requires the depth prepass (always on in Forward+).

Returns

boolean

Set Signature

set screenSpaceShadowMask(val): void

Defined in: libs/scene/src/camera/camera.ts:596

Parameters
val

boolean

Returns

void

Inherited from

Camera.screenSpaceShadowMask


renderPath

Get Signature

get renderPath(): "forward"

Defined in: libs/scene/src/camera/camera.ts:602

Render path used by the scene renderer.

Returns

"forward"

Set Signature

set renderPath(_val): void

Defined in: libs/scene/src/camera/camera.ts:605

Parameters
_val

"forward"

Returns

void

Inherited from

Camera.renderPath


HDR

Get Signature

get HDR(): boolean

Defined in: libs/scene/src/camera/camera.ts:613

Whether HDR backbuffer is enabled.

Tonemap should be disabled when not using HDR backbuffer.

Returns

boolean

Set Signature

set HDR(val): void

Defined in: libs/scene/src/camera/camera.ts:616

Parameters
val

boolean

Returns

void

Inherited from

Camera.HDR


toneMap

Get Signature

get toneMap(): boolean

Defined in: libs/scene/src/camera/camera.ts:622

Whether tonemapping is enabled via the post effect.

Returns

boolean

Set Signature

set toneMap(val): void

Defined in: libs/scene/src/camera/camera.ts:625

Parameters
val

boolean

Returns

void

Inherited from

Camera.toneMap


motionBlur

Get Signature

get motionBlur(): boolean

Defined in: libs/scene/src/camera/camera.ts:631

Whether motion blur is enabled via the post effect.

Returns

boolean

Set Signature

set motionBlur(val): void

Defined in: libs/scene/src/camera/camera.ts:634

Parameters
val

boolean

Returns

void

Inherited from

Camera.motionBlur


motionBlurStrength

Get Signature

get motionBlurStrength(): number

Defined in: libs/scene/src/camera/camera.ts:638

Motion blur strength

Returns

number

Set Signature

set motionBlurStrength(val): void

Defined in: libs/scene/src/camera/camera.ts:641

Parameters
val

number

Returns

void

Inherited from

Camera.motionBlurStrength


bloom

Get Signature

get bloom(): boolean

Defined in: libs/scene/src/camera/camera.ts:650

Gets whether Bloom is enabled.

Returns

boolean

Set Signature

set bloom(val): void

Defined in: libs/scene/src/camera/camera.ts:653

Parameters
val

boolean

Returns

void

Inherited from

Camera.bloom


bloomMaxDownsampleLevels

Get Signature

get bloomMaxDownsampleLevels(): number

Defined in: libs/scene/src/camera/camera.ts:659

Maximum bloom downsample levels

Returns

number

Set Signature

set bloomMaxDownsampleLevels(val): void

Defined in: libs/scene/src/camera/camera.ts:662

Parameters
val

number

Returns

void

Inherited from

Camera.bloomMaxDownsampleLevels


bloomDownsampleLimit

Get Signature

get bloomDownsampleLimit(): number

Defined in: libs/scene/src/camera/camera.ts:671

Bloom downsample limit

Returns

number

Set Signature

set bloomDownsampleLimit(val): void

Defined in: libs/scene/src/camera/camera.ts:674

Parameters
val

number

Returns

void

Inherited from

Camera.bloomDownsampleLimit


bloomThreshold

Get Signature

get bloomThreshold(): number

Defined in: libs/scene/src/camera/camera.ts:683

Bloom threshold

Returns

number

Set Signature

set bloomThreshold(val): void

Defined in: libs/scene/src/camera/camera.ts:686

Parameters
val

number

Returns

void

Inherited from

Camera.bloomThreshold


bloomThresholdKnee

Get Signature

get bloomThresholdKnee(): number

Defined in: libs/scene/src/camera/camera.ts:695

Bloom threshold knee

Returns

number

Set Signature

set bloomThresholdKnee(val): void

Defined in: libs/scene/src/camera/camera.ts:698

Parameters
val

number

Returns

void

Inherited from

Camera.bloomThresholdKnee


bloomIntensity

Get Signature

get bloomIntensity(): number

Defined in: libs/scene/src/camera/camera.ts:707

Bloom intensity

Returns

number

Set Signature

set bloomIntensity(val): void

Defined in: libs/scene/src/camera/camera.ts:710

Parameters
val

number

Returns

void

Inherited from

Camera.bloomIntensity


colorAdjust

Get Signature

get colorAdjust(): boolean

Defined in: libs/scene/src/camera/camera.ts:717

Whether color adjustment is enabled.

Returns

boolean

Set Signature

set colorAdjust(val): void

Defined in: libs/scene/src/camera/camera.ts:720

Parameters
val

boolean

Returns

void

Inherited from

Camera.colorAdjust


colorAdjustSaturation

Get Signature

get colorAdjustSaturation(): number

Defined in: libs/scene/src/camera/camera.ts:724

Color adjustment saturation, 1 means unchanged.

Returns

number

Set Signature

set colorAdjustSaturation(val): void

Defined in: libs/scene/src/camera/camera.ts:727

Parameters
val

number

Returns

void

Inherited from

Camera.colorAdjustSaturation


colorAdjustContrast

Get Signature

get colorAdjustContrast(): number

Defined in: libs/scene/src/camera/camera.ts:734

Color adjustment contrast, 1 means unchanged.

Returns

number

Set Signature

set colorAdjustContrast(val): void

Defined in: libs/scene/src/camera/camera.ts:737

Parameters
val

number

Returns

void

Inherited from

Camera.colorAdjustContrast


colorAdjustHue

Get Signature

get colorAdjustHue(): number

Defined in: libs/scene/src/camera/camera.ts:744

Color adjustment hue in degrees.

Returns

number

Set Signature

set colorAdjustHue(val): void

Defined in: libs/scene/src/camera/camera.ts:747

Parameters
val

number

Returns

void

Inherited from

Camera.colorAdjustHue


colorAdjustSharpen

Get Signature

get colorAdjustSharpen(): number

Defined in: libs/scene/src/camera/camera.ts:754

Color adjustment sharpen amount, 0 means disabled.

Returns

number

Set Signature

set colorAdjustSharpen(val): void

Defined in: libs/scene/src/camera/camera.ts:757

Parameters
val

number

Returns

void

Inherited from

Camera.colorAdjustSharpen


FXAA

Get Signature

get FXAA(): boolean

Defined in: libs/scene/src/camera/camera.ts:766

Gets whether FXAA is enabled.

Returns

boolean

Set Signature

set FXAA(val): void

Defined in: libs/scene/src/camera/camera.ts:769

Parameters
val

boolean

Returns

void

Inherited from

Camera.FXAA


toneMapExposure

Get Signature

get toneMapExposure(): number

Defined in: libs/scene/src/camera/camera.ts:775

Tonemap exposure

Returns

number

Set Signature

set toneMapExposure(val): void

Defined in: libs/scene/src/camera/camera.ts:778

Parameters
val

number

Returns

void

Inherited from

Camera.toneMapExposure


TAA

Get Signature

get TAA(): boolean

Defined in: libs/scene/src/camera/camera.ts:787

Gets whether TAA is enabled.

Returns

boolean

Set Signature

set TAA(val): void

Defined in: libs/scene/src/camera/camera.ts:790

Parameters
val

boolean

Returns

void

Inherited from

Camera.TAA


TAADebug

Get Signature

get TAADebug(): number

Defined in: libs/scene/src/camera/camera.ts:796

Gets the debug flag for TAA

Returns

number

Set Signature

set TAADebug(val): void

Defined in: libs/scene/src/camera/camera.ts:799

Parameters
val

number

Returns

void

Inherited from

Camera.TAADebug


shadowDebugCascades

Get Signature

get shadowDebugCascades(): boolean

Defined in: libs/scene/src/camera/camera.ts:805

Enables cascade debug visualization for directional shadows.

Returns

boolean

Set Signature

set shadowDebugCascades(val): void

Defined in: libs/scene/src/camera/camera.ts:808

Parameters
val

boolean

Returns

void

Inherited from

Camera.shadowDebugCascades


SSR

Get Signature

get SSR(): boolean

Defined in: libs/scene/src/camera/camera.ts:814

Gets whether Screen Space Reflections (SSR) is enabled.

Returns

boolean

Set Signature

set SSR(val): void

Defined in: libs/scene/src/camera/camera.ts:817

Parameters
val

boolean

Returns

void

Inherited from

Camera.SSR


ssrMaxRoughness

Get Signature

get ssrMaxRoughness(): number

Defined in: libs/scene/src/camera/camera.ts:824

Gets the maximum roughness value for screen space reflections. Controls the cutoff point where surfaces are considered too rough for SSR.

Returns

number

Set Signature

set ssrMaxRoughness(val): void

Defined in: libs/scene/src/camera/camera.ts:827

Parameters
val

number

Returns

void

Inherited from

Camera.ssrMaxRoughness


ssrRoughnessFactor

Get Signature

get ssrRoughnessFactor(): number

Defined in: libs/scene/src/camera/camera.ts:834

Gets the roughness factor for SSR calculations. Affects how surface roughness influences reflection clarity.

Returns

number

Set Signature

set ssrRoughnessFactor(val): void

Defined in: libs/scene/src/camera/camera.ts:837

Parameters
val

number

Returns

void

Inherited from

Camera.ssrRoughnessFactor


ssrStride

Get Signature

get ssrStride(): number

Defined in: libs/scene/src/camera/camera.ts:844

Gets the stride value for SSR ray marching. Controls the step size during ray marching. Larger values improve performance but may miss details.

Returns

number

Set Signature

set ssrStride(val): void

Defined in: libs/scene/src/camera/camera.ts:847

Parameters
val

number

Returns

void

Inherited from

Camera.ssrStride


ssrMaxDistance

Get Signature

get ssrMaxDistance(): number

Defined in: libs/scene/src/camera/camera.ts:854

Gets the maximum distance for SSR ray marching. Defines how far rays will travel when searching for reflection intersections.

Returns

number

Set Signature

set ssrMaxDistance(val): void

Defined in: libs/scene/src/camera/camera.ts:857

Parameters
val

number

Returns

void

Inherited from

Camera.ssrMaxDistance


ssrIterations

Get Signature

get ssrIterations(): number

Defined in: libs/scene/src/camera/camera.ts:864

Gets the number of iterations for SSR ray marching. Higher values provide more accurate reflections but impact performance.

Returns

number

Set Signature

set ssrIterations(val): void

Defined in: libs/scene/src/camera/camera.ts:867

Parameters
val

number

Returns

void

Inherited from

Camera.ssrIterations


ssrThickness

Get Signature

get ssrThickness(): number

Defined in: libs/scene/src/camera/camera.ts:874

Gets the thickness value for SSR calculations. Determines the thickness threshold for surfaces when calculating reflections.

Returns

number

Set Signature

set ssrThickness(val): void

Defined in: libs/scene/src/camera/camera.ts:877

Parameters
val

number

Returns

void

Inherited from

Camera.ssrThickness


ssrCalcThickness

Get Signature

get ssrCalcThickness(): boolean

Defined in: libs/scene/src/camera/camera.ts:884

Gets whether SSR should calculate thickness automatically. When enabled, the system will dynamically compute surface thickness for reflections.

Returns

boolean

Set Signature

set ssrCalcThickness(val): void

Defined in: libs/scene/src/camera/camera.ts:887

Parameters
val

boolean

Returns

void

Inherited from

Camera.ssrCalcThickness


ssrBlurScale

Get Signature

get ssrBlurScale(): number

Defined in: libs/scene/src/camera/camera.ts:894

Gets the blur scale factor for SSR. Controls the overall intensity of the blur effect applied to reflections.

Returns

number

Set Signature

set ssrBlurScale(val): void

Defined in: libs/scene/src/camera/camera.ts:897

Parameters
val

number

Returns

void

Inherited from

Camera.ssrBlurScale


ssrBlurDepthCutoff

Get Signature

get ssrBlurDepthCutoff(): number

Defined in: libs/scene/src/camera/camera.ts:904

Gets the depth cutoff value for SSR blur. Determines at what depth difference the blur effect should be reduced or eliminated.

Returns

number

Set Signature

set ssrBlurDepthCutoff(val): void

Defined in: libs/scene/src/camera/camera.ts:907

Parameters
val

number

Returns

void

Inherited from

Camera.ssrBlurDepthCutoff


ssrBlurKernelSize

Get Signature

get ssrBlurKernelSize(): number

Defined in: libs/scene/src/camera/camera.ts:914

Gets the kernel size for the SSR blur effect. Defines the size of the blur kernel. Larger values create softer, more spread-out blur.

Returns

number

Set Signature

set ssrBlurKernelSize(val): void

Defined in: libs/scene/src/camera/camera.ts:917

Parameters
val

number

Returns

void

Inherited from

Camera.ssrBlurKernelSize


ssrBlurStdDev

Get Signature

get ssrBlurStdDev(): number

Defined in: libs/scene/src/camera/camera.ts:924

Gets the standard deviation for the SSR Gaussian blur. Controls the distribution of the blur effect. Higher values create more pronounced blur.

Returns

number

Set Signature

set ssrBlurStdDev(val): void

Defined in: libs/scene/src/camera/camera.ts:927

Parameters
val

number

Returns

void

Inherited from

Camera.ssrBlurStdDev


ssrTemporal

Get Signature

get ssrTemporal(): boolean

Defined in: libs/scene/src/camera/camera.ts:933

Gets whether SSR temporal accumulation is enabled.

Returns

boolean

Set Signature

set ssrTemporal(val): void

Defined in: libs/scene/src/camera/camera.ts:936

Parameters
val

boolean

Returns

void

Inherited from

Camera.ssrTemporal


ssrTemporalWeight

Get Signature

get ssrTemporalWeight(): number

Defined in: libs/scene/src/camera/camera.ts:943

Gets SSR temporal blending weight in [0, 1]. Higher values rely more on reprojected history.

Returns

number

Set Signature

set ssrTemporalWeight(val): void

Defined in: libs/scene/src/camera/camera.ts:946

Parameters
val

number

Returns

void

Inherited from

Camera.ssrTemporalWeight


SSS

Get Signature

get SSS(): boolean

Defined in: libs/scene/src/camera/camera.ts:952

Gets whether Screen Space Subsurface Scattering (SSS) is enabled.

Returns

boolean

Set Signature

set SSS(val): void

Defined in: libs/scene/src/camera/camera.ts:955

Parameters
val

boolean

Returns

void

Inherited from

Camera.SSS


sssBlurScale

Get Signature

get sssBlurScale(): number

Defined in: libs/scene/src/camera/camera.ts:959

Global blur scale for screen-space SSS.

Returns

number

Set Signature

set sssBlurScale(val): void

Defined in: libs/scene/src/camera/camera.ts:962

Parameters
val

number

Returns

void

Inherited from

Camera.sssBlurScale


sssQualityPreset

Get Signature

get sssQualityPreset(): SSSQualityPreset

Defined in: libs/scene/src/camera/camera.ts:971

High-level quality preset for SSS blur controls.

This is the primary user-facing SSS quality control and only affects the blur sampling quality/performance tradeoff, not the authored look.

Returns

SSSQualityPreset

Set Signature

set sssQualityPreset(val): void

Defined in: libs/scene/src/camera/camera.ts:974

Parameters
val

SSSQualityPreset

Returns

void

Inherited from

Camera.sssQualityPreset


sssStrength

Get Signature

get sssStrength(): number

Defined in: libs/scene/src/camera/camera.ts:982

Final SSS composite strength.

Returns

number

Set Signature

set sssStrength(val): void

Defined in: libs/scene/src/camera/camera.ts:985

Parameters
val

number

Returns

void

Inherited from

Camera.sssStrength


sssTransmissionStrength

Get Signature

get sssTransmissionStrength(): number

Defined in: libs/scene/src/camera/camera.ts:989

Thin-shell transmission strength.

Returns

number

Set Signature

set sssTransmissionStrength(val): void

Defined in: libs/scene/src/camera/camera.ts:992

Parameters
val

number

Returns

void

Inherited from

Camera.sssTransmissionStrength


sssTransmissionPower

Get Signature

get sssTransmissionPower(): number

Defined in: libs/scene/src/camera/camera.ts:996

Thin-shell transmission exponent.

Returns

number

Set Signature

set sssTransmissionPower(val): void

Defined in: libs/scene/src/camera/camera.ts:999

Parameters
val

number

Returns

void

Inherited from

Camera.sssTransmissionPower


sssMultiScatter

Get Signature

get sssMultiScatter(): number

Defined in: libs/scene/src/camera/camera.ts:1003

Multi-scatter energy compensation factor.

Returns

number

Set Signature

set sssMultiScatter(val): void

Defined in: libs/scene/src/camera/camera.ts:1006

Parameters
val

number

Returns

void

Inherited from

Camera.sssMultiScatter


sssResolvedSettings

Get Signature

get sssResolvedSettings(): Readonly<SSSResolvedSettings>

Defined in: libs/scene/src/camera/camera.ts:1010

Resolved SSS blur settings after applying the quality preset.

Returns

Readonly<SSSResolvedSettings>

Inherited from

Camera.sssResolvedSettings


sssDebugView

Get Signature

get sssDebugView(): SSSDebugView

Defined in: libs/scene/src/camera/camera.ts:1014

Debug visualization for screen-space SSS buffers.

Returns

SSSDebugView

Set Signature

set sssDebugView(val): void

Defined in: libs/scene/src/camera/camera.ts:1017

Parameters
val

SSSDebugView

Returns

void

Inherited from

Camera.sssDebugView


skinSSS

Get Signature

get skinSSS(): boolean

Defined in: libs/scene/src/camera/camera.ts:1021

Gets whether the dedicated Skin SSS post effect is enabled.

Returns

boolean

Set Signature

set skinSSS(val): void

Defined in: libs/scene/src/camera/camera.ts:1024

Parameters
val

boolean

Returns

void

Inherited from

Camera.skinSSS


skinSSSStrength

Get Signature

get skinSSSStrength(): number

Defined in: libs/scene/src/camera/camera.ts:1028

Final blend strength for the dedicated Skin SSS post effect.

Returns

number

Set Signature

set skinSSSStrength(val): void

Defined in: libs/scene/src/camera/camera.ts:1031

Parameters
val

number

Returns

void

Inherited from

Camera.skinSSSStrength


skinSSSOpacity

Get Signature

get skinSSSOpacity(): number

Defined in: libs/scene/src/camera/camera.ts:1038

Bias subtracted from the blurred skin mask before compositing.

Returns

number

Set Signature

set skinSSSOpacity(val): void

Defined in: libs/scene/src/camera/camera.ts:1041

Parameters
val

number

Returns

void

Inherited from

Camera.skinSSSOpacity


skinSSSSampleStep

Get Signature

get skinSSSSampleStep(): number

Defined in: libs/scene/src/camera/camera.ts:1048

Pixel spacing between blur taps. The reference shader uses 2.

Returns

number

Set Signature

set skinSSSSampleStep(val): void

Defined in: libs/scene/src/camera/camera.ts:1051

Parameters
val

number

Returns

void

Inherited from

Camera.skinSSSSampleStep


skinSSSDepthScale

Get Signature

get skinSSSDepthScale(): number

Defined in: libs/scene/src/camera/camera.ts:1058

Depth rejection scale. The reference shader uses 80.

Returns

number

Set Signature

set skinSSSDepthScale(val): void

Defined in: libs/scene/src/camera/camera.ts:1061

Parameters
val

number

Returns

void

Inherited from

Camera.skinSSSDepthScale


skinSSSColorBoost

Get Signature

get skinSSSColorBoost(): number

Defined in: libs/scene/src/camera/camera.ts:1068

Multiplier applied to the blurred skin lighting multiplier before compositing.

Returns

number

Set Signature

set skinSSSColorBoost(val): void

Defined in: libs/scene/src/camera/camera.ts:1071

Parameters
val

number

Returns

void

Inherited from

Camera.skinSSSColorBoost


SSAO

Get Signature

get SSAO(): boolean

Defined in: libs/scene/src/camera/camera.ts:1084

Gets whether SSAO is enabled.

Returns

boolean

Set Signature

set SSAO(val): void

Defined in: libs/scene/src/camera/camera.ts:1087

Parameters
val

boolean

Returns

void

Inherited from

Camera.SSAO


SSAOScale

Get Signature

get SSAOScale(): number

Defined in: libs/scene/src/camera/camera.ts:1091

SSAO scale

Returns

number

Set Signature

set SSAOScale(val): void

Defined in: libs/scene/src/camera/camera.ts:1094

Parameters
val

number

Returns

void

Inherited from

Camera.SSAOScale


SSAOBias

Get Signature

get SSAOBias(): number

Defined in: libs/scene/src/camera/camera.ts:1101

SSAO bias

Returns

number

Set Signature

set SSAOBias(val): void

Defined in: libs/scene/src/camera/camera.ts:1104

Parameters
val

number

Returns

void

Inherited from

Camera.SSAOBias


SSAORadius

Get Signature

get SSAORadius(): number

Defined in: libs/scene/src/camera/camera.ts:1111

SSAO radius

Returns

number

Set Signature

set SSAORadius(val): void

Defined in: libs/scene/src/camera/camera.ts:1114

Parameters
val

number

Returns

void

Inherited from

Camera.SSAORadius


SSAOIntensity

Get Signature

get SSAOIntensity(): number

Defined in: libs/scene/src/camera/camera.ts:1121

SSAO intensity

Returns

number

Set Signature

set SSAOIntensity(val): void

Defined in: libs/scene/src/camera/camera.ts:1124

Parameters
val

number

Returns

void

Inherited from

Camera.SSAOIntensity


SSAOBlurDepthCutoff

Get Signature

get SSAOBlurDepthCutoff(): number

Defined in: libs/scene/src/camera/camera.ts:1131

SSAO depth cutoff

Returns

number

Set Signature

set SSAOBlurDepthCutoff(val): void

Defined in: libs/scene/src/camera/camera.ts:1134

Parameters
val

number

Returns

void

Inherited from

Camera.SSAOBlurDepthCutoff


depthPrePass

Get Signature

get depthPrePass(): boolean

Defined in: libs/scene/src/camera/camera.ts:1141

Whether to perform a depth pass

Returns

boolean

Set Signature

set depthPrePass(val): void

Defined in: libs/scene/src/camera/camera.ts:1144

Parameters
val

boolean

Returns

void

Inherited from

Camera.depthPrePass


commandBufferReuse

Get Signature

get commandBufferReuse(): boolean

Defined in: libs/scene/src/camera/camera.ts:1148

Whether to allow command buffer reuse optimization

Returns

boolean

Set Signature

set commandBufferReuse(val): void

Defined in: libs/scene/src/camera/camera.ts:1151

Parameters
val

boolean

Returns

void

Inherited from

Camera.commandBufferReuse


adapted

Get Signature

get adapted(): boolean

Defined in: libs/scene/src/camera/camera.ts:1155

Whether this camera is adapted to screen settins

Returns

boolean

Set Signature

set adapted(val): void

Defined in: libs/scene/src/camera/camera.ts:1158

Parameters
val

boolean

Returns

void

Inherited from

Camera.adapted


oit

Get Signature

get oit(): OIT

Defined in: libs/scene/src/camera/camera.ts:1167

OIT

Returns

OIT

Set Signature

set oit(val): void

Defined in: libs/scene/src/camera/camera.ts:1170

Parameters
val

OIT

Returns

void

Inherited from

Camera.oit


oitMode

Get Signature

get oitMode(): CameraOITMode

Defined in: libs/scene/src/camera/camera.ts:1178

OIT mode

Returns

CameraOITMode

Set Signature

set oitMode(val): void

Defined in: libs/scene/src/camera/camera.ts:1181

Parameters
val

CameraOITMode

Returns

void

Inherited from

Camera.oitMode


oitABufferLayers

Get Signature

get oitABufferLayers(): number

Defined in: libs/scene/src/camera/camera.ts:1189

ABuffer OIT layer budget.

Returns

number

Set Signature

set oitABufferLayers(val): void

Defined in: libs/scene/src/camera/camera.ts:1192

Parameters
val

number

Returns

void

Inherited from

Camera.oitABufferLayers


oitDualDepthPeels

Get Signature

get oitDualDepthPeels(): number

Defined in: libs/scene/src/camera/camera.ts:1202

Dual depth peeling OIT peel iteration count.

Returns

number

Set Signature

set oitDualDepthPeels(val): void

Defined in: libs/scene/src/camera/camera.ts:1205

Parameters
val

number

Returns

void

Inherited from

Camera.oitDualDepthPeels


clipMask

Get Signature

get clipMask(): number

Defined in: libs/scene/src/camera/camera.ts:1218

Clip plane mask

Returns

number

Set Signature

set clipMask(val): void

Defined in: libs/scene/src/camera/camera.ts:1221

Parameters
val

number

Returns

void

Inherited from

Camera.clipMask


viewport

Get Signature

get viewport(): readonly number[]

Defined in: libs/scene/src/camera/camera.ts:1225

Viewport used for rendering, if null, use full framebuffer size

Returns

readonly number[]

Set Signature

set viewport(rect): void

Defined in: libs/scene/src/camera/camera.ts:1234

Parameters
rect

readonly number[]

Returns

void

Inherited from

Camera.viewport


scissor

Get Signature

get scissor(): readonly number[]

Defined in: libs/scene/src/camera/camera.ts:1238

Scissor rectangle used for rendering, if null, use viewport value

Returns

readonly number[]

Set Signature

set scissor(rect): void

Defined in: libs/scene/src/camera/camera.ts:1241

Parameters
rect

readonly number[]

Returns

void

Inherited from

Camera.scissor


relativeViewport

Get Signature

get relativeViewport(): readonly number[]

Defined in: libs/scene/src/camera/camera.ts:1244

Returns

readonly number[]

Inherited from

Camera.relativeViewport


screenConfig

Get Signature

get screenConfig(): Immutable<ScreenConfig>

Defined in: libs/scene/src/camera/camera.ts:1256

Screen configuration used for adapting the camera viewport

Returns

Immutable<ScreenConfig>

Set Signature

set screenConfig(config): void

Defined in: libs/scene/src/camera/camera.ts:1259

Parameters
config

Immutable<ScreenConfig>

Returns

void

Inherited from

Camera.screenConfig


screenViewport

Get Signature

get screenViewport(): readonly number[]

Defined in: libs/scene/src/camera/camera.ts:1265

Screen viewport used for adapting the camera viewport

Returns

readonly number[]

Set Signature

set screenViewport(viewport): void

Defined in: libs/scene/src/camera/camera.ts:1268

Parameters
viewport

readonly number[]

Returns

void

Inherited from

Camera.screenViewport


viewMatrix

Get Signature

get viewMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/camera/camera.ts:1434

View matrix of the camera

Remarks

Camera's view matrix will transform a point from the world space to the camera space

Returns

Immutable<Matrix4x4>

Inherited from

Camera.viewMatrix


viewProjectionMatrix

Get Signature

get viewProjectionMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/camera/camera.ts:1440

Returns

Immutable<Matrix4x4>

Inherited from

Camera.viewProjectionMatrix


invViewProjectionMatrix

Get Signature

get invViewProjectionMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/camera/camera.ts:1452

The inverse-view-projection matrix of the camera

Remarks

The inverse-view-projection matrix transforms a point from the clip space to the camera space

Returns

Immutable<Matrix4x4>

Inherited from

Camera.invViewProjectionMatrix


frustum

Get Signature

get frustum(): Immutable<Frustum>

Defined in: libs/scene/src/camera/camera.ts:1459

Gets the frustum of the camera

Returns

Immutable<Frustum>

Inherited from

Camera.frustum


frustumViewSpace

Get Signature

get frustumViewSpace(): Immutable<Frustum>

Defined in: libs/scene/src/camera/camera.ts:1465

Returns

Immutable<Frustum>

Inherited from

Camera.frustumViewSpace


controller

Get Signature

get controller(): BaseCameraController

Defined in: libs/scene/src/camera/camera.ts:1475

The camera controller

Returns

BaseCameraController

Set Signature

set controller(controller): void

Defined in: libs/scene/src/camera/camera.ts:1478

Parameters
controller

BaseCameraController

Returns

void

Inherited from

Camera.controller


window

Get Signature

get window(): readonly number[]

Defined in: libs/scene/src/camera/orthocamera.ts:41

Sub-window of the frustum

Returns

readonly number[]

Set Signature

set window(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:44

Parameters
val

readonly number[]

Returns

void


near

Get Signature

get near(): number

Defined in: libs/scene/src/camera/orthocamera.ts:49

The near clip plane

Returns

number

Set Signature

set near(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:52

Parameters
val

number

Returns

void


far

Get Signature

get far(): number

Defined in: libs/scene/src/camera/orthocamera.ts:59

The far clip plane

Returns

number

Set Signature

set far(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:62

Parameters
val

number

Returns

void


left

Get Signature

get left(): number

Defined in: libs/scene/src/camera/orthocamera.ts:69

The left clip plane

Returns

number

Set Signature

set left(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:72

Parameters
val

number

Returns

void


right

Get Signature

get right(): number

Defined in: libs/scene/src/camera/orthocamera.ts:79

The right clip plane

Returns

number

Set Signature

set right(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:82

Parameters
val

number

Returns

void


top

Get Signature

get top(): number

Defined in: libs/scene/src/camera/orthocamera.ts:89

The top clip plane

Returns

number

Set Signature

set top(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:92

Parameters
val

number

Returns

void


bottom

Get Signature

get bottom(): number

Defined in: libs/scene/src/camera/orthocamera.ts:99

The bottom clip plane

Returns

number

Set Signature

set bottom(val): void

Defined in: libs/scene/src/camera/orthocamera.ts:102

Parameters
val

number

Returns

void


placeToOctree

Get Signature

get placeToOctree(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:312

Whether the node should be inserted into the scene's spatial structure.

Remarks

Toggling this hints the scene to (re)place the node in octree/acceleration structures.

Returns

boolean

Set Signature

set placeToOctree(val): void

Defined in: libs/scene/src/scene/scene_node.ts:315

Parameters
val

boolean

Returns

void

Inherited from

Camera.placeToOctree


runtimeId

Get Signature

get runtimeId(): number

Defined in: libs/scene/src/scene/scene_node.ts:326

Node's runtime unique identifier

Returns

number

Inherited from

Camera.runtimeId


persistentId

Get Signature

get persistentId(): string

Defined in: libs/scene/src/scene/scene_node.ts:335

Node's persistent identifier.

Remarks

Changing this affects serialization and registry lookup; ensure uniqueness.

Returns

string

Set Signature

set persistentId(id): void

Defined in: libs/scene/src/scene/scene_node.ts:338

Parameters
id

string

Returns

void

Inherited from

Camera.persistentId


prefabId

Get Signature

get prefabId(): string

Defined in: libs/scene/src/scene/scene_node.ts:347

If not empty, this node was loaded from a prefab

Remarks

Internal used for serialization

Returns

string

Set Signature

set prefabId(id): void

Defined in: libs/scene/src/scene/scene_node.ts:350

Parameters
id

string

Returns

void

Inherited from

Camera.prefabId


jointTypeT

Get Signature

get jointTypeT(): "none" | "animated" | "static"

Defined in: libs/scene/src/scene/scene_node.ts:366

Translation type if this is a joint node of any skeleton

Remarks

Internal used for serialization

Returns

"none" | "animated" | "static"

Set Signature

set jointTypeT(val): void

Defined in: libs/scene/src/scene/scene_node.ts:369

Parameters
val

"none" | "animated" | "static"

Returns

void

Inherited from

Camera.jointTypeT


jointTypeS

Get Signature

get jointTypeS(): "none" | "animated" | "static"

Defined in: libs/scene/src/scene/scene_node.ts:378

Scale type if this is a joint node of any skeleton

Remarks

Internal used for serialization

Returns

"none" | "animated" | "static"

Set Signature

set jointTypeS(val): void

Defined in: libs/scene/src/scene/scene_node.ts:381

Parameters
val

"none" | "animated" | "static"

Returns

void

Inherited from

Camera.jointTypeS


jointTypeR

Get Signature

get jointTypeR(): "none" | "animated" | "static"

Defined in: libs/scene/src/scene/scene_node.ts:390

Rotation type if this is a joint node of any skeleton

Remarks

Internal used for serialization

Returns

"none" | "animated" | "static"

Set Signature

set jointTypeR(val): void

Defined in: libs/scene/src/scene/scene_node.ts:393

Parameters
val

"none" | "animated" | "static"

Returns

void

Inherited from

Camera.jointTypeR


metaData

Get Signature

get metaData(): Metadata

Defined in: libs/scene/src/scene/scene_node.ts:402

Arbitrary metadata associated with this node.

Remarks

Stored and transported with the node; format is application-defined.

Returns

Metadata

Set Signature

set metaData(val): void

Defined in: libs/scene/src/scene/scene_node.ts:405

Parameters
val

Metadata

Returns

void

Inherited from

Camera.metaData


script

Get Signature

get script(): string

Defined in: libs/scene/src/scene/scene_node.ts:414

Attached script filename or identifier (engine-specific).

Remarks

Integrates with the engine’s scripting system if available.

Returns

string

Set Signature

set script(fileName): void

Defined in: libs/scene/src/scene/scene_node.ts:417

Parameters
fileName

string

Returns

void

Inherited from

Camera.script


scriptConfig

Get Signature

get scriptConfig(): object | unknown[]

Defined in: libs/scene/src/scene/scene_node.ts:430

Script component configuration payload used by editor/runtime script components.

Returns

object | unknown[]

Set Signature

set scriptConfig(value): void

Defined in: libs/scene/src/scene/scene_node.ts:433

Parameters
value

object | unknown[]

Returns

void

Inherited from

Camera.scriptConfig


scripts

Get Signature

get scripts(): ScriptAttachment[]

Defined in: libs/scene/src/scene/scene_node.ts:447

All script attachments on this node.

Returns

ScriptAttachment[]

Set Signature

set scripts(value): void

Defined in: libs/scene/src/scene/scene_node.ts:450

Parameters
value

ScriptAttachment[]

Returns

void

Inherited from

Camera.scripts


scriptConfigs

Get Signature

get scriptConfigs(): unknown[]

Defined in: libs/scene/src/scene/scene_node.ts:456

Script configs for all script attachments.

Returns

unknown[]

Set Signature

set scriptConfigs(value): void

Defined in: libs/scene/src/scene/scene_node.ts:459

Parameters
value

unknown[]

Returns

void

Inherited from

Camera.scriptConfigs


name

Get Signature

get name(): string

Defined in: libs/scene/src/scene/scene_node.ts:474

Display name of the node (for UI/debugging).

Returns

string

Set Signature

set name(val): void

Defined in: libs/scene/src/scene/scene_node.ts:477

Parameters
val

string

Returns

void

Inherited from

Camera.name


scene

Get Signature

get scene(): Scene

Defined in: libs/scene/src/scene/scene_node.ts:481

The owning scene.

Returns

Scene

Inherited from

Camera.scene


attached

Get Signature

get attached(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:487

Whether this node is currently attached under the scene's root.

Returns

boolean

Inherited from

Camera.attached


sealed

Get Signature

get sealed(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:501

If true, the node is logically sealed; some operations (like cloning as child) may be restricted by engine policies.

Returns

boolean

Set Signature

set sealed(val): void

Defined in: libs/scene/src/scene/scene_node.ts:504

Parameters
val

boolean

Returns

void

Inherited from

Camera.sealed


animationSet

Get Signature

get animationSet(): AnimationSet

Defined in: libs/scene/src/scene/scene_node.ts:513

Lazily created animation set for this node.

Remarks

Accessing this schedules the node for update in the scene.

Returns

AnimationSet

Inherited from

Camera.animationSet


sharedModel

Get Signature

get sharedModel(): SharedModel

Defined in: libs/scene/src/scene/scene_node.ts:523

Shared model reference for instancing/streaming systems.

Returns

SharedModel

Set Signature

set sharedModel(model): void

Defined in: libs/scene/src/scene/scene_node.ts:526

Parameters
model

SharedModel

Returns

void

Inherited from

Camera.sharedModel


morphTargetGroups

Get Signature

get morphTargetGroups(): SceneMorphTargetGroup[]

Defined in: libs/scene/src/scene/scene_node.ts:530

Runtime morph target groups bound to this model instance.

Returns

SceneMorphTargetGroup[]

Set Signature

set morphTargetGroups(groups): void

Defined in: libs/scene/src/scene/scene_node.ts:533

Parameters
groups

SceneMorphTargetGroup[]

Returns

void

Inherited from

Camera.morphTargetGroups


clipTestEnabled

Get Signature

get clipTestEnabled(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:774

Clip mode

Returns

boolean

Set Signature

set clipTestEnabled(val): void

Defined in: libs/scene/src/scene/scene_node.ts:777

Parameters
val

boolean

Returns

void

Inherited from

Camera.clipTestEnabled


hidden

Get Signature

get hidden(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:781

Computed value of show state

Returns

boolean

Inherited from

Camera.hidden


showState

Get Signature

get showState(): SceneNodeVisible

Defined in: libs/scene/src/scene/scene_node.ts:789

Show state

Returns

SceneNodeVisible

Set Signature

set showState(val): void

Defined in: libs/scene/src/scene/scene_node.ts:792

Parameters
val

SceneNodeVisible

Returns

void

Inherited from

Camera.showState


pickable

Get Signature

get pickable(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:810

Whether this node is enabled for CPU picking

Returns

boolean

Set Signature

set pickable(val): void

Defined in: libs/scene/src/scene/scene_node.ts:813

Parameters
val

boolean

Returns

void

Inherited from

Camera.pickable


gpuPickable

Get Signature

get gpuPickable(): boolean

Defined in: libs/scene/src/scene/scene_node.ts:817

Whether this node is enabled for GPU picking

Returns

boolean

Set Signature

set gpuPickable(val): void

Defined in: libs/scene/src/scene/scene_node.ts:820

Parameters
val

boolean

Returns

void

Inherited from

Camera.gpuPickable


computedBoundingBoxDrawMode

Get Signature

get computedBoundingBoxDrawMode(): number

Defined in: libs/scene/src/scene/scene_node.ts:902

Computed value for bounding box draw mode

Returns

number

Inherited from

Camera.computedBoundingBoxDrawMode


boundingBoxDrawMode

Get Signature

get boundingBoxDrawMode(): number

Defined in: libs/scene/src/scene/scene_node.ts:913

Bounding box draw mode

Returns

number

Set Signature

set boundingBoxDrawMode(mode): void

Defined in: libs/scene/src/scene/scene_node.ts:916

Parameters
mode

number

Returns

void

Inherited from

Camera.boundingBoxDrawMode


parent

Get Signature

get parent(): SceneNode

Defined in: libs/scene/src/scene/scene_node.ts:1204

Parent of the xform

Returns

SceneNode

Set Signature

set parent(p): void

Defined in: libs/scene/src/scene/scene_node.ts:1207

Parameters
p

SceneNode

Returns

void

Inherited from

Camera.parent


children

Get Signature

get children(): SceneNode[]

Defined in: libs/scene/src/scene/scene_node.ts:1213

Children of this xform

Returns

SceneNode[]

Inherited from

Camera.children


position

Get Signature

get position(): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1219

Position of the xform relative to it's parent

Returns

Vector3

Set Signature

set position(val): void

Defined in: libs/scene/src/scene/scene_node.ts:1222

Parameters
val

Vector3

Returns

void

Inherited from

Camera.position


scale

Get Signature

get scale(): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1228

Scaling of the xform

Returns

Vector3

Set Signature

set scale(val): void

Defined in: libs/scene/src/scene/scene_node.ts:1231

Parameters
val

Vector3

Returns

void

Inherited from

Camera.scale


rotation

Get Signature

get rotation(): Quaternion

Defined in: libs/scene/src/scene/scene_node.ts:1237

Rotation of the xform

Returns

Quaternion

Set Signature

set rotation(val): void

Defined in: libs/scene/src/scene/scene_node.ts:1240

Parameters
val

Quaternion

Returns

void

Inherited from

Camera.rotation


localMatrix

Get Signature

get localMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/scene/scene_node.ts:1346

Local transformation matrix of the xform

Returns

Immutable<Matrix4x4>

Set Signature

set localMatrix(matrix): void

Defined in: libs/scene/src/scene/scene_node.ts:1353

Parameters
matrix

Immutable<Matrix4x4>

Returns

void

Inherited from

Camera.localMatrix


worldMatrix

Get Signature

get worldMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/scene/scene_node.ts:1357

World transformation matrix of the xform

Returns

Immutable<Matrix4x4>

Inherited from

Camera.worldMatrix


worldMatrixDet

Get Signature

get worldMatrixDet(): number

Defined in: libs/scene/src/scene/scene_node.ts:1362

The determinant of world matrix

Returns

number

Inherited from

Camera.worldMatrixDet


invWorldMatrix

Get Signature

get invWorldMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/scene/scene_node.ts:1367

Inverse of the world transformation matrix of the xform

Returns

Immutable<Matrix4x4>

Inherited from

Camera.invWorldMatrix

Methods

on()

Call Signature

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:635

IEventTarget.on

Type Parameters
K

K extends "dispose" | "nodeattached" | "noderemoved" | "visiblechanged" | "transformchanged" | "bvchanged"

Parameters
type

K

listener

EventListener<object & object, K>

context?

unknown

Returns

void

Inherited from

Camera.on

Call Signature

on<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:594

IEventTarget.on

Type Parameters
K

K extends "dispose"

Parameters
type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

Camera.on


once()

Call Signature

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:639

IEventTarget.once

Type Parameters
K

K extends "dispose" | "nodeattached" | "noderemoved" | "visiblechanged" | "transformchanged" | "bvchanged"

Parameters
type

K

listener

EventListener<object & object, K>

context?

unknown

Returns

void

Inherited from

Camera.once

Call Signature

once<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:598

IEventTarget.once

Type Parameters
K

K extends "dispose"

Parameters
type

K

listener

EventListener<{ dispose: []; }, K>

context?

unknown

Returns

void

Inherited from

Camera.once


off()

Call Signature

off<K>(type, listener, context?): void

Defined in: libs/base/dist/index.d.ts:643

IEventTarget.off

Type Parameters
K

K extends "dispose" | "nodeattached" | "noderemoved" | "visiblechanged" | "transformchanged" | "bvchanged"

Parameters
type

K

listener

EventListener<object & object, K>

context?

unknown

Returns

void

Inherited from

Camera.off

Call Signature

off<K>(type, listener?, context?): void

Defined in: libs/base/dist/index.d.ts:602

IEventTarget.off

Type Parameters
K

K extends "dispose"

Parameters
type

K

listener?

EventListener<{ dispose: []; }>

context?

unknown

Returns

void

Inherited from

Camera.off


dispatchEvent()

Call Signature

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:647

IEventTarget.dispatchEvent

Type Parameters
K

K extends "dispose" | "nodeattached" | "noderemoved" | "visiblechanged" | "transformchanged" | "bvchanged"

Parameters
type

K

args

...object & object[K]

Returns

void

Inherited from

Camera.dispatchEvent

Call Signature

dispatchEvent<K>(type, ...args): void

Defined in: libs/base/dist/index.d.ts:606

IEventTarget.dispatchEvent

Type Parameters
K

K extends "dispose"

Parameters
type

K

args

...object[K]

Returns

void

Inherited from

Camera.dispatchEvent


dispose()

dispose(): void

Defined in: libs/base/dist/index.d.ts:6066

Returns

void

Inherited from

Camera.dispose


handleEvent()

handleEvent<T>(ev, type?): boolean

Defined in: libs/scene/src/camera/camera.ts:1277

Handle input events

Type Parameters

T

T extends IBaseEvent<any>

Parameters

ev

T

input event object

type?

string

event type, default to ev.type

Returns

boolean

Boolean value indicates whether the event was handled.

Inherited from

Camera.handleEvent


constructRay()

constructRay(x, y): Ray

Defined in: libs/scene/src/camera/camera.ts:1320

Constructs a ray based on the given screen coordinates.

Parameters

x

number

The x-component of the screen coordinates, relative to the top-left corner of the viewport.

y

number

The y-component of the screen coordinates, relative to the top-left corner of the viewport.

Returns

Ray

The ray originating from the camera position and passing through the given screen coordinates.

Inherited from

Camera.constructRay


lookAt()

lookAt(eye, target, up): OrthoCamera

Defined in: libs/scene/src/camera/camera.ts:1344

Place the camera by specifying the camera position and the target point

Parameters

eye

Vector3

The camera position

target

Vector3

The target point to look at

up

Vector3

The up vector

Returns

OrthoCamera

self

Inherited from

Camera.lookAt


lookAtCubeFace()

lookAtCubeFace(face, position?): OrthoCamera

Defined in: libs/scene/src/camera/camera.ts:1353

Place the camera to look at a given cube face at a given camera position

Parameters

face

CubeFace

The cube face to look at

position?

Vector3

The camera position

Returns

OrthoCamera

self

Inherited from

Camera.lookAtCubeFace


getProjectionMatrix()

getProjectionMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/camera/camera.ts:1401

Gets the projection matrix of the camera

Returns

Immutable<Matrix4x4>

The projection matrix

Inherited from

Camera.getProjectionMatrix


getInvProjectionMatrix()

getInvProjectionMatrix(): Immutable<Matrix4x4>

Defined in: libs/scene/src/camera/camera.ts:1411

Gets the inverse projection matrix of the camera

Returns

Immutable<Matrix4x4>

The projection matrix

Inherited from

Camera.getInvProjectionMatrix


getRotationMatrix()

getRotationMatrix(): Matrix4x4

Defined in: libs/scene/src/camera/camera.ts:1417

Returns

Matrix4x4

Inherited from

Camera.getRotationMatrix


isCamera()

isCamera(): this is Camera

Defined in: libs/scene/src/camera/camera.ts:1482

true if this is a camera node, false otherwise

Returns

this is Camera

Inherited from

Camera.isCamera


getNearPlane()

getNearPlane(): number

Defined in: libs/scene/src/camera/camera.ts:1486

Gets the near clip plane of the camera

Returns

number

Inherited from

Camera.getNearPlane


getFarPlane()

getFarPlane(): number

Defined in: libs/scene/src/camera/camera.ts:1490

Gets the far clip plane of the camera

Returns

number

Inherited from

Camera.getFarPlane


getFOV()

getFOV(): number

Defined in: libs/scene/src/camera/camera.ts:1494

Gets the vertical field of view of the camera

Returns

number

Inherited from

Camera.getFOV


getTanHalfFovy()

getTanHalfFovy(): number

Defined in: libs/scene/src/camera/camera.ts:1498

Gets the tangent of half of the vertical field of view

Returns

number

Inherited from

Camera.getTanHalfFovy


getAspect()

getAspect(): number

Defined in: libs/scene/src/camera/camera.ts:1502

Gets the aspect ratio

Returns

number

Inherited from

Camera.getAspect


isPerspective()

isPerspective(): boolean

Defined in: libs/scene/src/camera/camera.ts:1506

Returns true if the camera is perspective

Returns

boolean

Inherited from

Camera.isPerspective


isOrtho()

isOrtho(): boolean

Defined in: libs/scene/src/camera/camera.ts:1510

Returns true if the camera is orthographic

Returns

boolean

Inherited from

Camera.isOrtho


getHistoryData()

getHistoryData(): CameraHistoryData

Defined in: libs/scene/src/camera/camera.ts:1517

Gets the camera history data which is used in temporal reprojection

Returns

CameraHistoryData

Camera history data

Inherited from

Camera.getHistoryData


clearHistoryData()

clearHistoryData(): void

Defined in: libs/scene/src/camera/camera.ts:1533

Clears the camera history data which is used in temporal reprojection

Returns

void

Inherited from

Camera.clearHistoryData


render()

render(scene): void

Defined in: libs/scene/src/camera/camera.ts:1670

Renders a scene

Parameters

scene

Scene

The scene to be rendered

Returns

void

Inherited from

Camera.render


pickAsync()

pickAsync(posX, posY): Promise<PickResult>

Defined in: libs/scene/src/camera/camera.ts:1721

Parameters

posX

number

posY

number

Returns

Promise<PickResult>

Inherited from

Camera.pickAsync


updateController()

updateController(): void

Defined in: libs/scene/src/camera/camera.ts:1750

Updates the controller state

Returns

void

Inherited from

Camera.updateController


resetController()

resetController(): void

Defined in: libs/scene/src/camera/camera.ts:1756

Reset the controller

Returns

void

Inherited from

Camera.resetController


getHistoryResourceManager()

getHistoryResourceManager(): HistoryResourceManager<Texture2D<unknown>>

Defined in: libs/scene/src/camera/camera.ts:1790

Gets the camera history resource manager for temporal effects.

Returns

HistoryResourceManager<Texture2D<unknown>>

Inherited from

Camera.getHistoryResourceManager


onDispose()

protected onDispose(): void

Defined in: libs/scene/src/camera/camera.ts:1846

Returns

void

Inherited from

Camera.onDispose


setPerspective()

setPerspective(): this

Defined in: libs/scene/src/camera/orthocamera.ts:114

Not valid for OrthoCamera

Returns

this

Remarks

This method is only valid for Camera class or PerspectiveCamera class.

Overrides

Camera.setPerspective


setOrtho()

setOrtho(left, right, bottom, top, near, far): OrthoCamera

Defined in: libs/scene/src/camera/orthocamera.ts:120

Setup a orthogonal projection matrix for the camera

Parameters

left

number

Left bound of the frustum

right

number

Right bound of the frustum

bottom

number

Bottom bound of the frustum

top

number

Top bound of the frustum

near

number

Near bound of the frustum.

far

number

Far bound of the frustum.

Returns

OrthoCamera

self

Overrides

Camera.setOrtho


setProjectionMatrix()

setProjectionMatrix(matrix): void

Defined in: libs/scene/src/camera/orthocamera.ts:134

Setup a projection matrix for the camera

Parameters

matrix

Matrix4x4

The projection matrix

Returns

void

Overrides

Camera.setProjectionMatrix


getPrefabNode()

getPrefabNode(): SceneNode

Defined in: libs/scene/src/scene/scene_node.ts:357

Get prefab node this node belongs to, or null if this node does not belongs to any prefab

Returns

SceneNode

prefab node this node belongs to

Inherited from

Camera.getPrefabNode


clone()

clone(): Promise<OrthoCamera>

Defined in: libs/scene/src/scene/scene_node.ts:547

Clone this node.

Returns

Promise<OrthoCamera>

New node instance

Remarks

If a shared model exists, it may create an instanced node. The clone is attached under the same parent; children are cloned based on method and recursive.

Inherited from

Camera.clone


hasChild()

hasChild(child): boolean

Defined in: libs/scene/src/scene/scene_node.ts:577

Whether the given node is a direct child of this node.

Parameters

child

SceneNode

The node to be checked

Returns

boolean

true if the given node is a direct child of this node, false otherwise

Inherited from

Camera.hasChild


removeChildren()

removeChildren(): void

Defined in: libs/scene/src/scene/scene_node.ts:583

Remove all children from this node.

Returns

void

Inherited from

Camera.removeChildren


isParentOf()

isParentOf(child): boolean

Defined in: libs/scene/src/scene/scene_node.ts:591

Whether this node is an ancestor (direct or indirect) of the given node.

Parameters

child

SceneNode

Returns

boolean

Inherited from

Camera.isParentOf


remove()

remove(): OrthoCamera

Defined in: libs/scene/src/scene/scene_node.ts:602

Detach this node from its parent.

Returns

OrthoCamera

this

Inherited from

Camera.remove


traverse()

traverse(v): void

Defined in: libs/scene/src/scene/scene_node.ts:611

Depth-first traversal of this node's subtree (pre-order).

Parameters

v

Visitor<SceneNode>

Visitor invoked on each node.

Returns

void

Inherited from

Camera.traverse


iterate()

iterate(callback): boolean

Defined in: libs/scene/src/scene/scene_node.ts:625

Iterate self and descendants in pre-order.

Warning: Do not remove children during this iteration. To allow removal, use iterateBottomToTop.

Parameters

callback

NodeIterateFunc

Called for each node; if returns true, iteration stops.

Returns

boolean

If returns true, the iteration will immediately stop.

Inherited from

Camera.iterate


iterateBottomToTop()

iterateBottomToTop(callback): boolean

Defined in: libs/scene/src/scene/scene_node.ts:644

Iterate self and descendants in reverse post-order (bottom-to-top).

Child nodes can be safely removed during this iteration.

Parameters

callback

NodeIterateFunc

Called for each node; if returns true, iteration stops.

Returns

boolean

If returns true, the iteration will immediately stop.

Inherited from

Camera.iterateBottomToTop


isGraphNode()

isGraphNode(): this is GraphNode

Defined in: libs/scene/src/scene/scene_node.ts:657

Type guard: true if this node is a graph node.

Returns

this is GraphNode

Inherited from

Camera.isGraphNode


isLight()

isLight(): this is BaseLight

Defined in: libs/scene/src/scene/scene_node.ts:661

Type guard: true if this node is a light.

Returns

this is BaseLight

Inherited from

Camera.isLight


isMesh()

isMesh(): this is Mesh

Defined in: libs/scene/src/scene/scene_node.ts:665

Type guard: true if this node is a mesh.

Returns

this is Mesh

Inherited from

Camera.isMesh


isSprite()

isSprite(): this is Sprite

Defined in: libs/scene/src/scene/scene_node.ts:669

Type guard: true if this node is a sprite

Returns

this is Sprite

Inherited from

Camera.isSprite


isMSDFTextSprite()

isMSDFTextSprite(): this is MSDFTextSprite

Defined in: libs/scene/src/scene/scene_node.ts:673

Type guard: true if this node is a MSDF text sprite

Returns

this is MSDFTextSprite

Inherited from

Camera.isMSDFTextSprite


isMSDFText()

isMSDFText(): this is MSDFText

Defined in: libs/scene/src/scene/scene_node.ts:677

Type guard: true if this node is a MSDF text sprite

Returns

this is MSDFText

Inherited from

Camera.isMSDFText


isWater()

isWater(): this is Water

Defined in: libs/scene/src/scene/scene_node.ts:681

Type guard: true if this node is a water node.

Returns

this is Water

Inherited from

Camera.isWater


isParticleSystem()

isParticleSystem(): this is ParticleSystem

Defined in: libs/scene/src/scene/scene_node.ts:685

Type guard: true if this node is a particle system.

Returns

this is ParticleSystem

Inherited from

Camera.isParticleSystem


isBatchGroup()

isBatchGroup(): this is BatchGroup

Defined in: libs/scene/src/scene/scene_node.ts:689

Type guard: true if this node is a batch group.

Returns

this is BatchGroup

Inherited from

Camera.isBatchGroup


isClipmapTerrain()

isClipmapTerrain(): this is ClipmapTerrain

Defined in: libs/scene/src/scene/scene_node.ts:693

Type guard: true if this node is a clipmap terrain.

Returns

this is ClipmapTerrain

Inherited from

Camera.isClipmapTerrain


isPunctualLight()

isPunctualLight(): this is PunctualLight

Defined in: libs/scene/src/scene/scene_node.ts:701

true if this is a punctual light node, false otherwise

Returns

this is PunctualLight

Inherited from

Camera.isPunctualLight


computeBoundingVolume()

computeBoundingVolume(): BoundingVolume

Defined in: libs/scene/src/scene/scene_node.ts:708

Computes the bounding volume of the node

Returns

BoundingVolume

The output bounding volume

Inherited from

Camera.computeBoundingVolume


getBoundingVolume()

getBoundingVolume(): BoundingVolume

Defined in: libs/scene/src/scene/scene_node.ts:715

Gets the bounding volume of the node

Returns

BoundingVolume

The bounding volume of the node

Inherited from

Camera.getBoundingVolume


setBoundingVolume()

setBoundingVolume(bv): void

Defined in: libs/scene/src/scene/scene_node.ts:726

Sets the bounding volume of the node

Parameters

bv

BoundingVolume

The bounding volume to set

Returns

void

Inherited from

Camera.setBoundingVolume


getWorldBoundingVolume()

getWorldBoundingVolume(): BoundingVolume

Defined in: libs/scene/src/scene/scene_node.ts:737

Gets the world space bounding volume of the node

Returns

BoundingVolume

The world space bounding volume of the node

Inherited from

Camera.getWorldBoundingVolume


computeWorldBoundingVolume()

computeWorldBoundingVolume(localBV): BoundingVolume

Defined in: libs/scene/src/scene/scene_node.ts:747

Computes the world space bounding volume of the node

Parameters

localBV

BoundingVolume

Returns

BoundingVolume

The output bounding volume

Inherited from

Camera.computeWorldBoundingVolume


invalidateBoundingVolume()

invalidateBoundingVolume(): void

Defined in: libs/scene/src/scene/scene_node.ts:753

Force the bounding volume to be recalculated

Returns

void

Inherited from

Camera.invalidateBoundingVolume


invalidateWorldBoundingVolume()

invalidateWorldBoundingVolume(transformChanged): void

Defined in: libs/scene/src/scene/scene_node.ts:758

Force the world space bounding volume to be recalculated

Parameters

transformChanged

boolean

Returns

void

Inherited from

Camera.invalidateWorldBoundingVolume


findNodeById()

findNodeById<T>(id): T

Defined in: libs/scene/src/scene/scene_node.ts:830

Finds a scene node by its persistent ID.

Type Parameters

T

T extends SceneNode

Expected node type.

Parameters

id

string

Persistent identifier to match against SceneNode.persistentId.

Returns

T

The first matching node, or null if not found.

Inherited from

Camera.findNodeById


findSkeletonById()

findSkeletonById(id): SkinBinding

Defined in: libs/scene/src/scene/scene_node.ts:845

Finds a skeleton object by its persistent ID.

Parameters

id

string

Persistent identifier to match against Skeleton.persistentId.

Returns

SkinBinding

The first matchign node, or null if not found.

Inherited from

Camera.findSkeletonById


findSkinBindingById()

findSkinBindingById(id): SkinBinding

Defined in: libs/scene/src/scene/scene_node.ts:853

Finds a skin binding by its persistent ID.

Parameters

id

string

Persistent identifier to match against SkinBinding.persistentId.

Returns

SkinBinding

The first matching binding, or null if not found.

Inherited from

Camera.findSkinBindingById


findSkeletonRigById()

findSkeletonRigById(id): SkeletonRig

Defined in: libs/scene/src/scene/scene_node.ts:868

Finds a shared skeleton rig by its persistent ID.

Parameters

id

string

Persistent identifier to match against SkeletonRig.persistentId.

Returns

SkeletonRig

The first matching rig, or null if not found.

Inherited from

Camera.findSkeletonRigById


findNodeByName()

findNodeByName<T>(name): T

Defined in: libs/scene/src/scene/scene_node.ts:890

Finds a scene node by name.

If multiple nodes share the same name, returns the first match encountered during traversal.

Type Parameters

T

T extends SceneNode

Expected node type.

Parameters

name

string

Node name to match.

Returns

T

The first matching node, or null if not found.

Remarks

Names are not guaranteed unique. Prefer IDs for stable references.

Inherited from

Camera.findNodeByName


getSerializedMorphTargetGroups()

getSerializedMorphTargetGroups(): SerializedMorphTargetGroup[]

Defined in: libs/scene/src/scene/scene_node.ts:973

Returns serialized morph target groups for this node.

Returns

SerializedMorphTargetGroup[]

Inherited from

Camera.getSerializedMorphTargetGroups


setSerializedMorphTargetGroups()

setSerializedMorphTargetGroups(groups): void

Defined in: libs/scene/src/scene/scene_node.ts:991

Restores serialized morph target groups for this node.

Parameters

groups

SerializedMorphTargetGroup[]

Returns

void

Inherited from

Camera.setSerializedMorphTargetGroups


invalidateTransform()

invalidateTransform(invalidateLocal?): void

Defined in: libs/scene/src/scene/scene_node.ts:1027

Force transform update and notify descendants.

Parameters

invalidateLocal?

boolean = true

If true, also invalidate local matrix; otherwise only invalidate world matrix.

Returns

void

Inherited from

Camera.invalidateTransform


setMorphTargetWeight()

setMorphTargetWeight(name, weight): void

Defined in: libs/scene/src/scene/scene_node.ts:1035

Set morph target weight by name for all meshes in the subtree.

Parameters

name

string

Morph target name

weight

number

Morph target weight

Returns

void

Inherited from

Camera.setMorphTargetWeight


setMorphTargetGroupWeight()

setMorphTargetGroupWeight(name, weight): void

Defined in: libs/scene/src/scene/scene_node.ts:1051

Set morph target group weight for the model instance.

Parameters

name

string

Morph target group name

weight

number

Group weight

Returns

void

Inherited from

Camera.setMorphTargetGroupWeight


getMorphTargetGroupWeight()

getMorphTargetGroupWeight(name): number

Defined in: libs/scene/src/scene/scene_node.ts:1073

Get morph target group weight.

Parameters

name

string

Morph target group name

Returns

number

The group weight, or 0 if no group was found

Inherited from

Camera.getMorphTargetGroupWeight


collectMorphTargetNames()

collectMorphTargetNames(): string[]

Defined in: libs/scene/src/scene/scene_node.ts:1081

Collect all morph target names from meshes in the subtree.

Returns

string[]

Array of unique morph target names

Inherited from

Camera.collectMorphTargetNames


collectMorphTargetGroupNames()

collectMorphTargetGroupNames(): string[]

Defined in: libs/scene/src/scene/scene_node.ts:1097

Collect all model-level morph target group names.

Returns

string[]

Array of morph target group names

Inherited from

Camera.collectMorphTargetGroupNames


onPostClone()

protected onPostClone(): void | Promise<void>

Defined in: libs/scene/src/scene/scene_node.ts:1106

Get called when the node was just created by cloning from other node

Returns

void | Promise<void>

Inherited from

Camera.onPostClone


_onAttached()

protected _onAttached(): void

Defined in: libs/scene/src/scene/scene_node.ts:1174

Get called when this node is attached to scene

Returns

void

Inherited from

Camera._onAttached


_onDetached()

protected _onDetached(): void

Defined in: libs/scene/src/scene/scene_node.ts:1178

Get called when this node is detached from scene

Returns

void

Inherited from

Camera._onDetached


worldToThis()

Call Signature

worldToThis(v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1249

Transform world coordinate to local space

Parameters
v

Vector3

point or vector in world space

result?

Vector3

The output result

Returns

Vector3

The transformed local space coordinate

Inherited from

Camera.worldToThis

Call Signature

worldToThis(v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1250

Transform world coordinate to local space

Parameters
v

Vector4

point or vector in world space

result?

Vector4

The output result

Returns

Vector4

The transformed local space coordinate

Inherited from

Camera.worldToThis


otherToThis()

Call Signature

otherToThis(other, v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1269

Transform coordinate in other coordinate space to local space

Parameters
other

SceneNode

The other coordinate space

v

Vector3

point or vector in other coordinate space

result?

Vector3

The output result

Returns

Vector3

The transformed local space coordinate

Inherited from

Camera.otherToThis

Call Signature

otherToThis(other, v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1270

Transform coordinate in other coordinate space to local space

Parameters
other

SceneNode

The other coordinate space

v

Vector4

point or vector in other coordinate space

result?

Vector4

The output result

Returns

Vector4

The transformed local space coordinate

Inherited from

Camera.otherToThis


thisToWorld()

Call Signature

thisToWorld(v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1280

Transform local coordinate to world space

Parameters
v

Vector3

point or vector in local space

result?

Vector3

The output result

Returns

Vector3

The transformed world space coordinate

Inherited from

Camera.thisToWorld

Call Signature

thisToWorld(v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1281

Transform local coordinate to world space

Parameters
v

Vector4

point or vector in local space

result?

Vector4

The output result

Returns

Vector4

The transformed world space coordinate

Inherited from

Camera.thisToWorld


thisToOther()

Call Signature

thisToOther(other, v, result?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1300

Transform local space coordinate to other coordinate space

Parameters
other

SceneNode

The other coordinate space

v

Vector3

point or vector in localspace

result?

Vector3

The output result

Returns

Vector3

The transformed coordinate in other coordinate space

Inherited from

Camera.thisToOther

Call Signature

thisToOther(other, v, result?): Vector4

Defined in: libs/scene/src/scene/scene_node.ts:1301

Transform local space coordinate to other coordinate space

Parameters
other

SceneNode

The other coordinate space

v

Vector4

point or vector in localspace

result?

Vector4

The output result

Returns

Vector4

The transformed coordinate in other coordinate space

Inherited from

Camera.thisToOther


getWorldPosition()

getWorldPosition(outPos?): Vector3

Defined in: libs/scene/src/scene/scene_node.ts:1309

Gets the position of the xform in world space

Parameters

outPos?

Vector3

Returns

Vector3

position of the xform in world space

Inherited from

Camera.getWorldPosition


moveBy()

moveBy(delta): OrthoCamera

Defined in: libs/scene/src/scene/scene_node.ts:1320

Moves the xform by an offset vector

Parameters

delta

Vector3

The offset vector

Returns

OrthoCamera

self

Inherited from

Camera.moveBy


scaleBy()

scaleBy(factor): OrthoCamera

Defined in: libs/scene/src/scene/scene_node.ts:1329

Scales the xform by a given scale factor

Parameters

factor

Vector3

The scale factor

Returns

OrthoCamera

self

Inherited from

Camera.scaleBy


setLocalTransform()

setLocalTransform(matrix): OrthoCamera

Defined in: libs/scene/src/scene/scene_node.ts:1338

Sets the local transform matrix of the xform

Parameters

matrix

Matrix4x4

The transform matrix to set

Returns

OrthoCamera

self

Inherited from

Camera.setLocalTransform


calculateLocalTransform()

calculateLocalTransform(outMatrix): void

Defined in: libs/scene/src/scene/scene_node.ts:1375

Calculate local transform matrix

Parameters

outMatrix

Matrix4x4

Matrix object that holds the result of calculation

Returns

void

Inherited from

Camera.calculateLocalTransform


calculateWorldTransform()

calculateWorldTransform(outMatrix): void

Defined in: libs/scene/src/scene/scene_node.ts:1382

Calculate world transform matrix

Parameters

outMatrix

Matrix4x4

Matrix object that holds the result of calculation

Returns

void

Inherited from

Camera.calculateWorldTransform


update()

update(frameId, elapsedInSeconds, deltaInSeconds): void

Defined in: libs/scene/src/scene/scene_node.ts:1406

Update node state once per-frame

Parameters

frameId

number

Current frame id

elapsedInSeconds

number

Elapsed time from game start in seconds

deltaInSeconds

number

Elapsed time since previous frame in seconds

Returns

void

Inherited from

Camera.update


updatePerCamera()

updatePerCamera(_camera, _elapsedInSeconds, _deltaInSeconds): void

Defined in: libs/scene/src/scene/scene_node.ts:1426

Update node state once per-camera

Parameters

_camera

Camera

Updates according to which camera

_elapsedInSeconds

number

Elapsed time from game start in seconds

_deltaInSeconds

number

Elapsed time since previous frame in seconds

Returns

void

Inherited from

Camera.updatePerCamera


reparent()

reparent(p?): OrthoCamera

Defined in: libs/scene/src/scene/scene_node.ts:1432

Removes this node from it's parent and add this node to another parent node if required

Parameters

p?

SceneNode

The new parent node that this node should be added to or null

Returns

OrthoCamera

self

Inherited from

Camera.reparent

Released under the MIT License.