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
The scene that the camera belongs to.
left?
number = -1
The left clip plane
right?
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
Properties
_HiZNearest
protected_HiZNearest:boolean
Defined in: libs/scene/src/camera/camera.ts:274
Inherited from
_skinSSSGlow
protected_skinSSSGlow:number
Defined in: libs/scene/src/camera/camera.ts:446
Inherited from
_skinSSSProfilePreset
protected_skinSSSProfilePreset:SubsurfaceProfilePreset
Defined in: libs/scene/src/camera/camera.ts:447
Inherited from
_skinSSSProfile
protected_skinSSSProfile:SubsurfaceProfile
Defined in: libs/scene/src/camera/camera.ts:448
Inherited from
_skinSSSScatterTint
protectedreadonly_skinSSSScatterTint:Vector4
Defined in: libs/scene/src/camera/camera.ts:449
Inherited from
BBOXDRAW_INHERITED
readonlystaticBBOXDRAW_INHERITED:-1=-1
Defined in: libs/scene/src/scene/scene_node.ts:167
Bounding-box draw mode inherited from nearest graph ancestor.
Inherited from
BBOXDRAW_DISABLED
readonlystaticBBOXDRAW_DISABLED:0=0
Defined in: libs/scene/src/scene/scene_node.ts:169
Disable bounding-box visualization.
Inherited from
BBOXDRAW_LOCAL
readonlystaticBBOXDRAW_LOCAL:1=1
Defined in: libs/scene/src/scene/scene_node.ts:171
Draw local-space bounding box.
Inherited from
BBOXDRAW_WORLD
readonlystaticBBOXDRAW_WORLD:2=2
Defined in: libs/scene/src/scene/scene_node.ts:173
Draw world-space bounding box.
Inherited from
Accessors
disposed
Get Signature
get disposed():
boolean
Defined in: libs/base/dist/index.d.ts:6107
Returns
boolean
Inherited from
compositor
Get Signature
get compositor():
Compositor
Defined in: libs/scene/src/camera/camera.ts:662
The compositor that owns and runs the camera's post-processing chain.
Returns
Inherited from
interactionRect
Get Signature
get interactionRect(): [
number,number,number,number]
Defined in: libs/scene/src/camera/camera.ts:668
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:671
Parameters
rect
[number, number, number, number]
Returns
void
Inherited from
clearColor
Get Signature
get clearColor():
Vector4
Defined in: libs/scene/src/camera/camera.ts:677
Framebuffer clear color, or null to disable.
Returns
Vector4
Set Signature
set clearColor(
v):void
Defined in: libs/scene/src/camera/camera.ts:680
Parameters
v
Vector4
Returns
void
Inherited from
clearDepth
Get Signature
get clearDepth():
number
Defined in: libs/scene/src/camera/camera.ts:686
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:689
Parameters
v
number
Returns
void
Inherited from
clearStencil
Get Signature
get clearStencil():
number
Defined in: libs/scene/src/camera/camera.ts:695
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:698
Parameters
v
number
Returns
void
Inherited from
HiZ
Get Signature
get HiZ():
boolean
Defined in: libs/scene/src/camera/camera.ts:706
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:709
Parameters
val
boolean
Returns
void
Inherited from
HiZNearest
Get Signature
get HiZNearest():
boolean
Defined in: libs/scene/src/camera/camera.ts:725
Whether the Hi-Z pyramid carries its nearest-depth channel.
The pyramid's own channel answers "what is the farthest thing in this screen region", which is what occlusion and ray marching want; this one answers "what is the nearest", which is what a proximity query wants. It doubles the pyramid's bandwidth, so it is off unless something asks for it.
Materials that query it - water's shoreline foam - turn it on by themselves, the way a transmissive material turns on the scene colour copy, so this only has to be set to force the channel on for something the renderer cannot see coming. Ignored on WebGL1, which has no pyramid at all.
Returns
boolean
Set Signature
set HiZNearest(
val):void
Defined in: libs/scene/src/camera/camera.ts:728
Parameters
val
boolean
Returns
void
Inherited from
screenSpaceShadowMask
Get Signature
get screenSpaceShadowMask():
boolean
Defined in: libs/scene/src/camera/camera.ts:739
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:742
Parameters
val
boolean
Returns
void
Inherited from
renderPath
Get Signature
get renderPath():
"forward"
Defined in: libs/scene/src/camera/camera.ts:748
Render path used by the scene renderer.
Returns
"forward"
Set Signature
set renderPath(
_val):void
Defined in: libs/scene/src/camera/camera.ts:751
Parameters
_val
"forward"
Returns
void
Inherited from
HDR
Get Signature
get HDR():
boolean
Defined in: libs/scene/src/camera/camera.ts:759
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:762
Parameters
val
boolean
Returns
void
Inherited from
toneMap
Get Signature
get toneMap():
boolean
Defined in: libs/scene/src/camera/camera.ts:768
Whether tonemapping is enabled via the post effect.
Returns
boolean
Set Signature
set toneMap(
val):void
Defined in: libs/scene/src/camera/camera.ts:771
Parameters
val
boolean
Returns
void
Inherited from
motionBlur
Get Signature
get motionBlur():
boolean
Defined in: libs/scene/src/camera/camera.ts:777
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:780
Parameters
val
boolean
Returns
void
Inherited from
motionBlurStrength
Get Signature
get motionBlurStrength():
number
Defined in: libs/scene/src/camera/camera.ts:784
Motion blur strength
Returns
number
Set Signature
set motionBlurStrength(
val):void
Defined in: libs/scene/src/camera/camera.ts:787
Parameters
val
number
Returns
void
Inherited from
motionBlurShutterBias
Get Signature
get motionBlurShutterBias():
number
Defined in: libs/scene/src/camera/camera.ts:798
How much of the motion blur streak lies ahead of where an object is now, as a fraction of its length. 0 trails the streak fully behind the object, 0.5 (the default) centres it. See MotionBlur.shutterBias.
Returns
number
Set Signature
set motionBlurShutterBias(
val):void
Defined in: libs/scene/src/camera/camera.ts:801
Parameters
val
number
Returns
void
Inherited from
motionBlurMaxLength
Get Signature
get motionBlurMaxLength():
number
Defined in: libs/scene/src/camera/camera.ts:815
Longest motion blur streak, in pixels at render resolution. This is the ceiling Camera.motionBlurStrength runs into; raising it costs samples in proportion. See MotionBlur.maxBlurLength.
Returns
number
Set Signature
set motionBlurMaxLength(
val):void
Defined in: libs/scene/src/camera/camera.ts:818
Parameters
val
number
Returns
void
Inherited from
bloom
Get Signature
get bloom():
boolean
Defined in: libs/scene/src/camera/camera.ts:830
Gets whether Bloom is enabled.
Returns
boolean
Set Signature
set bloom(
val):void
Defined in: libs/scene/src/camera/camera.ts:833
Parameters
val
boolean
Returns
void
Inherited from
bloomMaxDownsampleLevels
Get Signature
get bloomMaxDownsampleLevels():
number
Defined in: libs/scene/src/camera/camera.ts:839
Maximum bloom downsample levels
Returns
number
Set Signature
set bloomMaxDownsampleLevels(
val):void
Defined in: libs/scene/src/camera/camera.ts:842
Parameters
val
number
Returns
void
Inherited from
Camera.bloomMaxDownsampleLevels
bloomDownsampleLimit
Get Signature
get bloomDownsampleLimit():
number
Defined in: libs/scene/src/camera/camera.ts:851
Bloom downsample limit
Returns
number
Set Signature
set bloomDownsampleLimit(
val):void
Defined in: libs/scene/src/camera/camera.ts:854
Parameters
val
number
Returns
void
Inherited from
bloomThreshold
Get Signature
get bloomThreshold():
number
Defined in: libs/scene/src/camera/camera.ts:863
Bloom threshold
Returns
number
Set Signature
set bloomThreshold(
val):void
Defined in: libs/scene/src/camera/camera.ts:866
Parameters
val
number
Returns
void
Inherited from
bloomThresholdKnee
Get Signature
get bloomThresholdKnee():
number
Defined in: libs/scene/src/camera/camera.ts:875
Bloom threshold knee
Returns
number
Set Signature
set bloomThresholdKnee(
val):void
Defined in: libs/scene/src/camera/camera.ts:878
Parameters
val
number
Returns
void
Inherited from
bloomIntensity
Get Signature
get bloomIntensity():
number
Defined in: libs/scene/src/camera/camera.ts:887
Bloom intensity
Returns
number
Set Signature
set bloomIntensity(
val):void
Defined in: libs/scene/src/camera/camera.ts:890
Parameters
val
number
Returns
void
Inherited from
bloomFilterRadius
Get Signature
get bloomFilterRadius():
number
Defined in: libs/scene/src/camera/camera.ts:903
Radius of the tent filter used to upsample the bloom pyramid, in source texels.
Remarks
See Bloom.filterRadius. 1 is the natural width; raising it softens the halo but past ~2 the tent's taps stop overlapping and a grid pattern reappears.
Returns
number
Set Signature
set bloomFilterRadius(
val):void
Defined in: libs/scene/src/camera/camera.ts:906
Parameters
val
number
Returns
void
Inherited from
bloomKarisAverage
Get Signature
get bloomKarisAverage():
boolean
Defined in: libs/scene/src/camera/camera.ts:919
Whether the first bloom downsample uses the Karis average to suppress fireflies.
Remarks
See Bloom.karisAverage. On by default; costs a little halo reach in exchange for stability on high-frequency speculars.
Returns
boolean
Set Signature
set bloomKarisAverage(
val):void
Defined in: libs/scene/src/camera/camera.ts:922
Parameters
val
boolean
Returns
void
Inherited from
toneMapDither
Get Signature
get toneMapDither():
boolean
Defined in: libs/scene/src/camera/camera.ts:935
Whether tone mapping dithers its result before the 8-bit write.
Remarks
See Tonemap.dither. On by default; removes the banding shallow gradients such as bloom halos otherwise show once quantized. Turn it off for reproducible pixel captures.
Returns
boolean
Set Signature
set toneMapDither(
val):void
Defined in: libs/scene/src/camera/camera.ts:938
Parameters
val
boolean
Returns
void
Inherited from
colorAdjust
Get Signature
get colorAdjust():
boolean
Defined in: libs/scene/src/camera/camera.ts:942
Whether color adjustment is enabled.
Returns
boolean
Set Signature
set colorAdjust(
val):void
Defined in: libs/scene/src/camera/camera.ts:945
Parameters
val
boolean
Returns
void
Inherited from
colorAdjustSaturation
Get Signature
get colorAdjustSaturation():
number
Defined in: libs/scene/src/camera/camera.ts:949
Color adjustment saturation, 1 means unchanged.
Returns
number
Set Signature
set colorAdjustSaturation(
val):void
Defined in: libs/scene/src/camera/camera.ts:952
Parameters
val
number
Returns
void
Inherited from
colorAdjustContrast
Get Signature
get colorAdjustContrast():
number
Defined in: libs/scene/src/camera/camera.ts:959
Color adjustment contrast, 1 means unchanged.
Returns
number
Set Signature
set colorAdjustContrast(
val):void
Defined in: libs/scene/src/camera/camera.ts:962
Parameters
val
number
Returns
void
Inherited from
colorAdjustHue
Get Signature
get colorAdjustHue():
number
Defined in: libs/scene/src/camera/camera.ts:969
Color adjustment hue in degrees.
Returns
number
Set Signature
set colorAdjustHue(
val):void
Defined in: libs/scene/src/camera/camera.ts:972
Parameters
val
number
Returns
void
Inherited from
colorAdjustSharpen
Get Signature
get colorAdjustSharpen():
number
Defined in: libs/scene/src/camera/camera.ts:979
Color adjustment sharpen amount, 0 means disabled.
Returns
number
Set Signature
set colorAdjustSharpen(
val):void
Defined in: libs/scene/src/camera/camera.ts:982
Parameters
val
number
Returns
void
Inherited from
FXAA
Get Signature
get FXAA():
boolean
Defined in: libs/scene/src/camera/camera.ts:991
Gets whether FXAA is enabled.
Returns
boolean
Set Signature
set FXAA(
val):void
Defined in: libs/scene/src/camera/camera.ts:994
Parameters
val
boolean
Returns
void
Inherited from
toneMapExposure
Get Signature
get toneMapExposure():
number
Defined in: libs/scene/src/camera/camera.ts:1000
Tonemap exposure
Returns
number
Set Signature
set toneMapExposure(
val):void
Defined in: libs/scene/src/camera/camera.ts:1003
Parameters
val
number
Returns
void
Inherited from
aperture
Get Signature
get aperture():
number
Defined in: libs/scene/src/camera/camera.ts:1009
Lens aperture as an f-number.
Returns
number
Set Signature
set aperture(
val):void
Defined in: libs/scene/src/camera/camera.ts:1012
Parameters
val
number
Returns
void
Inherited from
shutterSpeed
Get Signature
get shutterSpeed():
number
Defined in: libs/scene/src/camera/camera.ts:1016
Shutter-open time in seconds.
Returns
number
Set Signature
set shutterSpeed(
val):void
Defined in: libs/scene/src/camera/camera.ts:1019
Parameters
val
number
Returns
void
Inherited from
ISO
Get Signature
get ISO():
number
Defined in: libs/scene/src/camera/camera.ts:1023
Sensor sensitivity in ISO units.
Returns
number
Set Signature
set ISO(
val):void
Defined in: libs/scene/src/camera/camera.ts:1026
Parameters
val
number
Returns
void
Inherited from
exposureCompensation
Get Signature
get exposureCompensation():
number
Defined in: libs/scene/src/camera/camera.ts:1030
Exposure compensation in stops (EV).
Returns
number
Set Signature
set exposureCompensation(
val):void
Defined in: libs/scene/src/camera/camera.ts:1033
Parameters
val
number
Returns
void
Inherited from
EV100
Get Signature
get EV100():
number
Defined in: libs/scene/src/camera/camera.ts:1037
Photographic EV100 calculated from aperture, shutter time and ISO.
Returns
number
Inherited from
exposure
Get Signature
get exposure():
number
Defined in: libs/scene/src/camera/camera.ts:1041
Scene-linear physical exposure multiplier, including exposure compensation.
Returns
number
Inherited from
TAA
Get Signature
get TAA():
boolean
Defined in: libs/scene/src/camera/camera.ts:1052
Gets whether TAA is enabled.
Returns
boolean
Set Signature
set TAA(
val):void
Defined in: libs/scene/src/camera/camera.ts:1055
Parameters
val
boolean
Returns
void
Inherited from
TAADebug
Get Signature
get TAADebug():
number
Defined in: libs/scene/src/camera/camera.ts:1061
Gets the debug flag for TAA
Returns
number
Set Signature
set TAADebug(
val):void
Defined in: libs/scene/src/camera/camera.ts:1064
Parameters
val
number
Returns
void
Inherited from
shadowDebugCascades
Get Signature
get shadowDebugCascades():
boolean
Defined in: libs/scene/src/camera/camera.ts:1070
Enables cascade debug visualization for directional shadows.
Returns
boolean
Set Signature
set shadowDebugCascades(
val):void
Defined in: libs/scene/src/camera/camera.ts:1073
Parameters
val
boolean
Returns
void
Inherited from
SSR
Get Signature
get SSR():
boolean
Defined in: libs/scene/src/camera/camera.ts:1079
Gets whether Screen Space Reflections (SSR) is enabled.
Returns
boolean
Set Signature
set SSR(
val):void
Defined in: libs/scene/src/camera/camera.ts:1082
Parameters
val
boolean
Returns
void
Inherited from
SSGI
Get Signature
get SSGI():
boolean
Defined in: libs/scene/src/camera/camera.ts:1086
Gets whether Screen Space Global Illumination is enabled for this camera.
Returns
boolean
Set Signature
set SSGI(
val):void
Defined in: libs/scene/src/camera/camera.ts:1089
Parameters
val
boolean
Returns
void
Inherited from
ssgiQualityPreset
Get Signature
get ssgiQualityPreset():
SSGIQualityPreset
Defined in: libs/scene/src/camera/camera.ts:1097
High-level SSGI trace and denoise quality preset.
Returns
Set Signature
set ssgiQualityPreset(
val):void
Defined in: libs/scene/src/camera/camera.ts:1100
Parameters
val
Returns
void
Inherited from
ssgiResolvedSettings
Get Signature
get ssgiResolvedSettings():
Readonly<SSGIResolvedSettings>
Defined in: libs/scene/src/camera/camera.ts:1111
Resolved trace and denoise settings for the current SSGI preset.
Returns
Readonly<SSGIResolvedSettings>
Inherited from
ssgiHalfResolution
Get Signature
get ssgiHalfResolution():
boolean
Defined in: libs/scene/src/camera/camera.ts:1115
Whether the custom SSGI trace runs at half resolution.
Returns
boolean
Set Signature
set ssgiHalfResolution(
val):void
Defined in: libs/scene/src/camera/camera.ts:1118
Parameters
val
boolean
Returns
void
Inherited from
ssgiRaysPerPixel
Get Signature
get ssgiRaysPerPixel():
number
Defined in: libs/scene/src/camera/camera.ts:1122
Number of diffuse rays traced per pixel by the custom SSGI preset.
Returns
number
Set Signature
set ssgiRaysPerPixel(
val):void
Defined in: libs/scene/src/camera/camera.ts:1125
Parameters
val
number
Returns
void
Inherited from
ssgiMaxSteps
Get Signature
get ssgiMaxSteps():
number
Defined in: libs/scene/src/camera/camera.ts:1131
Maximum screen-space ray-march iterations used by the custom SSGI preset.
Returns
number
Set Signature
set ssgiMaxSteps(
val):void
Defined in: libs/scene/src/camera/camera.ts:1134
Parameters
val
number
Returns
void
Inherited from
ssgiDenoisePasses
Get Signature
get ssgiDenoisePasses():
number
Defined in: libs/scene/src/camera/camera.ts:1140
Number of cross-bilateral a-trous passes used by the custom SSGI preset.
Returns
number
Set Signature
set ssgiDenoisePasses(
val):void
Defined in: libs/scene/src/camera/camera.ts:1143
Parameters
val
number
Returns
void
Inherited from
ssgiIntensity
Get Signature
get ssgiIntensity():
number
Defined in: libs/scene/src/camera/camera.ts:1149
SSGI diffuse irradiance multiplier.
Returns
number
Set Signature
set ssgiIntensity(
val):void
Defined in: libs/scene/src/camera/camera.ts:1152
Parameters
val
number
Returns
void
Inherited from
ssgiSkyOcclusion
Get Signature
get ssgiSkyOcclusion():
number
Defined in: libs/scene/src/camera/camera.ts:1171
How much environment irradiance an occluding hit removes, in [0, 1].
A screen-space ray that hits geometry blocks the sky for that direction. At 1 the environment contribution is removed in full, which is what produces sky occlusion in interiors and corners; lower values dim the sky less than the geometry implies, for art direction or to compensate for the hemisphere a screen-space trace cannot see. Only the removal is scaled — bounce light measured at the hit is always kept, so lowering this brightens without ever discarding indirect light. Camera.ssgiIntensity still bounds how dark the result can get, so full occlusion also needs an intensity of 1.
Returns
number
Set Signature
set ssgiSkyOcclusion(
val):void
Defined in: libs/scene/src/camera/camera.ts:1174
Parameters
val
number
Returns
void
Inherited from
ssgiAOIntensity
Get Signature
get ssgiAOIntensity():
number
Defined in: libs/scene/src/camera/camera.ts:1195
How strongly the ambient occlusion traced alongside SSGI darkens the scene, in [0, 1]. 0 disables the composite entirely.
The occlusion comes from the same rays that produce the irradiance, at no extra trace cost, and is multiplied into the final opaque color — the same semantics the standalone SAO post effect applies. Enabling both at once therefore darkens twice. Its range is the SSGI trace range (Camera.ssgiMaxDistance), so this is long-range occlusion rather than the small-radius contact darkening a dedicated AO pass produces.
Defaults to 0.8 rather than 1: SSGI irradiance already has sky occlusion subtracted, so diffuse is partly occluded before this multiply is applied.
Returns
number
Set Signature
set ssgiAOIntensity(
val):void
Defined in: libs/scene/src/camera/camera.ts:1198
Parameters
val
number
Returns
void
Inherited from
ssgiAOPower
Get Signature
get ssgiAOPower():
number
Defined in: libs/scene/src/camera/camera.ts:1207
Contrast curve applied to the SSGI ambient occlusion before it is composited.
Values above 1 deepen the occluded regions, below 1 lift them. Purely an art direction control on an already-traced quantity.
Returns
number
Set Signature
set ssgiAOPower(
val):void
Defined in: libs/scene/src/camera/camera.ts:1210
Parameters
val
number
Returns
void
Inherited from
ssgiMaxDistance
Get Signature
get ssgiMaxDistance():
number
Defined in: libs/scene/src/camera/camera.ts:1214
Maximum SSGI ray length in view-space units.
Returns
number
Set Signature
set ssgiMaxDistance(
val):void
Defined in: libs/scene/src/camera/camera.ts:1217
Parameters
val
number
Returns
void
Inherited from
ssgiThickness
Get Signature
get ssgiThickness():
number
Defined in: libs/scene/src/camera/camera.ts:1225
Depth thickness used by screen-space ray intersection tests.
Returns
number
Set Signature
set ssgiThickness(
val):void
Defined in: libs/scene/src/camera/camera.ts:1228
Parameters
val
number
Returns
void
Inherited from
ssgiStride
Get Signature
get ssgiStride():
number
Defined in: libs/scene/src/camera/camera.ts:1236
Pixel stride used by the WebGL linear ray marcher.
Returns
number
Set Signature
set ssgiStride(
val):void
Defined in: libs/scene/src/camera/camera.ts:1239
Parameters
val
number
Returns
void
Inherited from
ssgiMaxRayIntensity
Get Signature
get ssgiMaxRayIntensity():
number
Defined in: libs/scene/src/camera/camera.ts:1247
Maximum per-ray radiance before temporal accumulation (firefly clamp).
Returns
number
Set Signature
set ssgiMaxRayIntensity(
val):void
Defined in: libs/scene/src/camera/camera.ts:1250
Parameters
val
number
Returns
void
Inherited from
ssgiTemporal
Get Signature
get ssgiTemporal():
boolean
Defined in: libs/scene/src/camera/camera.ts:1258
Whether SSGI temporal accumulation is enabled. Has no effect on WebGL1, which has no motion vectors.
Returns
boolean
Set Signature
set ssgiTemporal(
val):void
Defined in: libs/scene/src/camera/camera.ts:1261
Parameters
val
boolean
Returns
void
Inherited from
ssgiTemporalWeight
Get Signature
get ssgiTemporalWeight():
number
Defined in: libs/scene/src/camera/camera.ts:1269
Weight assigned to valid reprojected SSGI history.
Returns
number
Set Signature
set ssgiTemporalWeight(
val):void
Defined in: libs/scene/src/camera/camera.ts:1272
Parameters
val
number
Returns
void
Inherited from
ssgiDepthReject
Get Signature
get ssgiDepthReject():
number
Defined in: libs/scene/src/camera/camera.ts:1276
Relative linear-depth rejection threshold for SSGI reprojection.
Returns
number
Set Signature
set ssgiDepthReject(
val):void
Defined in: libs/scene/src/camera/camera.ts:1279
Parameters
val
number
Returns
void
Inherited from
ssgiNormalReject
Get Signature
get ssgiNormalReject():
number
Defined in: libs/scene/src/camera/camera.ts:1283
Minimum world-normal dot product accepted by SSGI reprojection.
Returns
number
Set Signature
set ssgiNormalReject(
val):void
Defined in: libs/scene/src/camera/camera.ts:1286
Parameters
val
number
Returns
void
Inherited from
ssrMaxRoughness
Get Signature
get ssrMaxRoughness():
number
Defined in: libs/scene/src/camera/camera.ts:1293
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:1296
Parameters
val
number
Returns
void
Inherited from
ssrRoughnessFactor
Get Signature
get ssrRoughnessFactor():
number
Defined in: libs/scene/src/camera/camera.ts:1303
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:1306
Parameters
val
number
Returns
void
Inherited from
ssrStride
Get Signature
get ssrStride():
number
Defined in: libs/scene/src/camera/camera.ts:1313
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:1316
Parameters
val
number
Returns
void
Inherited from
ssrMaxDistance
Get Signature
get ssrMaxDistance():
number
Defined in: libs/scene/src/camera/camera.ts:1323
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:1326
Parameters
val
number
Returns
void
Inherited from
ssrIterations
Get Signature
get ssrIterations():
number
Defined in: libs/scene/src/camera/camera.ts:1333
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:1336
Parameters
val
number
Returns
void
Inherited from
ssrThickness
Get Signature
get ssrThickness():
number
Defined in: libs/scene/src/camera/camera.ts:1343
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:1346
Parameters
val
number
Returns
void
Inherited from
ssrCalcThickness
Get Signature
get ssrCalcThickness():
boolean
Defined in: libs/scene/src/camera/camera.ts:1353
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:1356
Parameters
val
boolean
Returns
void
Inherited from
ssrBlurScale
Get Signature
get ssrBlurScale():
number
Defined in: libs/scene/src/camera/camera.ts:1363
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:1366
Parameters
val
number
Returns
void
Inherited from
ssrBlurDepthCutoff
Get Signature
get ssrBlurDepthCutoff():
number
Defined in: libs/scene/src/camera/camera.ts:1373
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:1376
Parameters
val
number
Returns
void
Inherited from
ssrBlurKernelSize
Get Signature
get ssrBlurKernelSize():
number
Defined in: libs/scene/src/camera/camera.ts:1383
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:1386
Parameters
val
number
Returns
void
Inherited from
ssrBlurStdDev
Get Signature
get ssrBlurStdDev():
number
Defined in: libs/scene/src/camera/camera.ts:1393
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:1396
Parameters
val
number
Returns
void
Inherited from
ssrTemporal
Get Signature
get ssrTemporal():
boolean
Defined in: libs/scene/src/camera/camera.ts:1402
Gets whether SSR temporal accumulation is enabled.
Returns
boolean
Set Signature
set ssrTemporal(
val):void
Defined in: libs/scene/src/camera/camera.ts:1405
Parameters
val
boolean
Returns
void
Inherited from
ssrTemporalWeight
Get Signature
get ssrTemporalWeight():
number
Defined in: libs/scene/src/camera/camera.ts:1412
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:1415
Parameters
val
number
Returns
void
Inherited from
SSS
Get Signature
get SSS():
boolean
Defined in: libs/scene/src/camera/camera.ts:1421
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:1424
Parameters
val
boolean
Returns
void
Inherited from
sssBlurScale
Get Signature
get sssBlurScale():
number
Defined in: libs/scene/src/camera/camera.ts:1428
Global blur scale for screen-space SSS.
Returns
number
Set Signature
set sssBlurScale(
val):void
Defined in: libs/scene/src/camera/camera.ts:1431
Parameters
val
number
Returns
void
Inherited from
sssQualityPreset
Get Signature
get sssQualityPreset():
SSSQualityPreset
Defined in: libs/scene/src/camera/camera.ts:1440
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
Set Signature
set sssQualityPreset(
val):void
Defined in: libs/scene/src/camera/camera.ts:1443
Parameters
val
Returns
void
Inherited from
sssStrength
Get Signature
get sssStrength():
number
Defined in: libs/scene/src/camera/camera.ts:1451
Final SSS composite strength.
Returns
number
Set Signature
set sssStrength(
val):void
Defined in: libs/scene/src/camera/camera.ts:1454
Parameters
val
number
Returns
void
Inherited from
sssTransmissionStrength
Get Signature
get sssTransmissionStrength():
number
Defined in: libs/scene/src/camera/camera.ts:1458
Thin-shell transmission strength.
Returns
number
Set Signature
set sssTransmissionStrength(
val):void
Defined in: libs/scene/src/camera/camera.ts:1461
Parameters
val
number
Returns
void
Inherited from
Camera.sssTransmissionStrength
sssTransmissionPower
Get Signature
get sssTransmissionPower():
number
Defined in: libs/scene/src/camera/camera.ts:1465
Thin-shell transmission exponent.
Returns
number
Set Signature
set sssTransmissionPower(
val):void
Defined in: libs/scene/src/camera/camera.ts:1468
Parameters
val
number
Returns
void
Inherited from
sssMultiScatter
Get Signature
get sssMultiScatter():
number
Defined in: libs/scene/src/camera/camera.ts:1472
Multi-scatter energy compensation factor.
Returns
number
Set Signature
set sssMultiScatter(
val):void
Defined in: libs/scene/src/camera/camera.ts:1475
Parameters
val
number
Returns
void
Inherited from
sssResolvedSettings
Get Signature
get sssResolvedSettings():
Readonly<SSSResolvedSettings>
Defined in: libs/scene/src/camera/camera.ts:1479
Resolved SSS blur settings after applying the quality preset.
Returns
Readonly<SSSResolvedSettings>
Inherited from
sssDebugView
Get Signature
get sssDebugView():
SSSDebugView
Defined in: libs/scene/src/camera/camera.ts:1483
Debug visualization for screen-space SSS buffers.
Returns
Set Signature
set sssDebugView(
val):void
Defined in: libs/scene/src/camera/camera.ts:1486
Parameters
val
Returns
void
Inherited from
skinSSS
Get Signature
get skinSSS():
boolean
Defined in: libs/scene/src/camera/camera.ts:1490
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:1493
Parameters
val
boolean
Returns
void
Inherited from
skinSSSStrength
Get Signature
get skinSSSStrength():
number
Defined in: libs/scene/src/camera/camera.ts:1497
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:1500
Parameters
val
number
Returns
void
Inherited from
skinSSSOpacity
Get Signature
get skinSSSOpacity():
number
Defined in: libs/scene/src/camera/camera.ts:1507
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:1510
Parameters
val
number
Returns
void
Inherited from
skinSSSSampleStep
Get Signature
get skinSSSSampleStep():
number
Defined in: libs/scene/src/camera/camera.ts:1517
Maximum pixel spacing between blur taps. Caps the projected scatter radius for close-ups.
Returns
number
Set Signature
set skinSSSSampleStep(
val):void
Defined in: libs/scene/src/camera/camera.ts:1520
Parameters
val
number
Returns
void
Inherited from
skinSSSScatterRadius
Get Signature
get skinSSSScatterRadius():
number
Defined in: libs/scene/src/camera/camera.ts:1527
World-space scatter radius. The blur width shrinks with distance to keep this constant.
Returns
number
Set Signature
set skinSSSScatterRadius(
val):void
Defined in: libs/scene/src/camera/camera.ts:1530
Parameters
val
number
Returns
void
Inherited from
skinSSSSmoothness
Get Signature
get skinSSSSmoothness():
number
Defined in: libs/scene/src/camera/camera.ts:1537
Skin smoothing ("beauty filter") amount for the dedicated Skin SSS post effect.
Returns
number
Set Signature
set skinSSSSmoothness(
val):void
Defined in: libs/scene/src/camera/camera.ts:1540
Parameters
val
number
Returns
void
Inherited from
skinSSSDepthScale
Get Signature
get skinSSSDepthScale():
number
Defined in: libs/scene/src/camera/camera.ts:1547
Depth rejection scale. The reference shader uses 80.
Returns
number
Set Signature
set skinSSSDepthScale(
val):void
Defined in: libs/scene/src/camera/camera.ts:1550
Parameters
val
number
Returns
void
Inherited from
skinSSSColorBoost
Get Signature
get skinSSSColorBoost():
number
Defined in: libs/scene/src/camera/camera.ts:1557
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:1560
Parameters
val
number
Returns
void
Inherited from
skinSSSGlow
Get Signature
get skinSSSGlow():
number
Defined in: libs/scene/src/camera/camera.ts:1576
Additive, deliberately non-conserving bleed for the Skin SSS post effect.
Remarks
0 (the default) keeps the effect energy conserving: light added to the dark side of the terminator is light removed from the lit side. Raising it adds the diffused term again without subtracting anything, for skin that reads as lit from within; around 1 approximates the look the effect had before it conserved energy.
Returns
number
Set Signature
set skinSSSGlow(
val):void
Defined in: libs/scene/src/camera/camera.ts:1579
Parameters
val
number
Returns
void
Inherited from
skinSSSProfilePreset
Get Signature
get skinSSSProfilePreset():
SubsurfaceProfilePreset
Defined in: libs/scene/src/camera/camera.ts:1598
Subsurface profile preset driving the Skin SSS per-channel scatter radii.
Remarks
The ratio between the red, green and blue radii is what gives a scattering surface its character - red travels furthest in skin, which is the red-to-yellow gradient at the terminator. Switching presets changes that ratio, so wax and jade are the same code path rather than special cases; Camera.skinSSSScatterRadius still sets how far the light reaches.
Applies to the whole pass. Per-material profiles need the profile-slot path used by SSS instead.
Returns
Set Signature
set skinSSSProfilePreset(
val):void
Defined in: libs/scene/src/camera/camera.ts:1601
Parameters
val
Returns
void
Inherited from
skinSSSScatterTint
Get Signature
get skinSSSScatterTint():
Vector4
Defined in: libs/scene/src/camera/camera.ts:1631
Tint applied to the light the Skin SSS post effect redistributes.
Remarks
White (the default) leaves the effect energy conserving. Because it multiplies only the difference between the diffused and original diffuse, a warm tint colors the terminator without washing the whole surface.
Returns
Vector4
Set Signature
set skinSSSScatterTint(
val):void
Defined in: libs/scene/src/camera/camera.ts:1634
Parameters
val
Vector4
Returns
void
Inherited from
SSAO
Get Signature
get SSAO():
boolean
Defined in: libs/scene/src/camera/camera.ts:1647
Gets whether SSAO is enabled.
Returns
boolean
Set Signature
set SSAO(
val):void
Defined in: libs/scene/src/camera/camera.ts:1650
Parameters
val
boolean
Returns
void
Inherited from
SSAOOcclusionRadius
Get Signature
get SSAOOcclusionRadius():
number
Defined in: libs/scene/src/camera/camera.ts:1660
SSAO occlusion radius, in world units (metres).
Remarks
Replaces the old SSAOScale, which was a far-plane-relative multiplier and carried no physical meaning.
Returns
number
Set Signature
set SSAOOcclusionRadius(
val):void
Defined in: libs/scene/src/camera/camera.ts:1663
Parameters
val
number
Returns
void
Inherited from
SSAOBias
Get Signature
get SSAOBias():
number
Defined in: libs/scene/src/camera/camera.ts:1670
SSAO bias
Returns
number
Set Signature
set SSAOBias(
val):void
Defined in: libs/scene/src/camera/camera.ts:1673
Parameters
val
number
Returns
void
Inherited from
SSAOIntensity
Get Signature
get SSAOIntensity():
number
Defined in: libs/scene/src/camera/camera.ts:1680
SSAO intensity
Returns
number
Set Signature
set SSAOIntensity(
val):void
Defined in: libs/scene/src/camera/camera.ts:1683
Parameters
val
number
Returns
void
Inherited from
SSAOBlurDepthCutoff
Get Signature
get SSAOBlurDepthCutoff():
number
Defined in: libs/scene/src/camera/camera.ts:1690
SSAO depth cutoff
Returns
number
Set Signature
set SSAOBlurDepthCutoff(
val):void
Defined in: libs/scene/src/camera/camera.ts:1693
Parameters
val
number
Returns
void
Inherited from
depthPrePass
Get Signature
get depthPrePass():
boolean
Defined in: libs/scene/src/camera/camera.ts:1700
Whether to perform a depth pass
Returns
boolean
Set Signature
set depthPrePass(
val):void
Defined in: libs/scene/src/camera/camera.ts:1703
Parameters
val
boolean
Returns
void
Inherited from
commandBufferReuse
Get Signature
get commandBufferReuse():
boolean
Defined in: libs/scene/src/camera/camera.ts:1707
Whether to allow command buffer reuse optimization
Returns
boolean
Set Signature
set commandBufferReuse(
val):void
Defined in: libs/scene/src/camera/camera.ts:1710
Parameters
val
boolean
Returns
void
Inherited from
adapted
Get Signature
get adapted():
boolean
Defined in: libs/scene/src/camera/camera.ts:1714
Whether this camera is adapted to screen settins
Returns
boolean
Set Signature
set adapted(
val):void
Defined in: libs/scene/src/camera/camera.ts:1717
Parameters
val
boolean
Returns
void
Inherited from
oit
Get Signature
get oit():
OIT
Defined in: libs/scene/src/camera/camera.ts:1726
OIT
Returns
Set Signature
set oit(
val):void
Defined in: libs/scene/src/camera/camera.ts:1729
Parameters
val
Returns
void
Inherited from
oitMode
Get Signature
get oitMode():
CameraOITMode
Defined in: libs/scene/src/camera/camera.ts:1737
OIT mode
Returns
Set Signature
set oitMode(
val):void
Defined in: libs/scene/src/camera/camera.ts:1740
Parameters
val
Returns
void
Inherited from
oitABufferLayers
Get Signature
get oitABufferLayers():
number
Defined in: libs/scene/src/camera/camera.ts:1748
ABuffer OIT layer budget.
Returns
number
Set Signature
set oitABufferLayers(
val):void
Defined in: libs/scene/src/camera/camera.ts:1751
Parameters
val
number
Returns
void
Inherited from
oitDualDepthPeels
Get Signature
get oitDualDepthPeels():
number
Defined in: libs/scene/src/camera/camera.ts:1761
Dual depth peeling OIT peel iteration count.
Returns
number
Set Signature
set oitDualDepthPeels(
val):void
Defined in: libs/scene/src/camera/camera.ts:1764
Parameters
val
number
Returns
void
Inherited from
clipMask
Get Signature
get clipMask():
number
Defined in: libs/scene/src/camera/camera.ts:1777
Clip plane mask
Returns
number
Set Signature
set clipMask(
val):void
Defined in: libs/scene/src/camera/camera.ts:1780
Parameters
val
number
Returns
void
Inherited from
viewport
Get Signature
get viewport(): readonly
number[]
Defined in: libs/scene/src/camera/camera.ts:1784
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:1793
Parameters
rect
readonly number[]
Returns
void
Inherited from
scissor
Get Signature
get scissor(): readonly
number[]
Defined in: libs/scene/src/camera/camera.ts:1797
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:1800
Parameters
rect
readonly number[]
Returns
void
Inherited from
relativeViewport
Get Signature
get relativeViewport(): readonly
number[]
Defined in: libs/scene/src/camera/camera.ts:1803
Returns
readonly number[]
Inherited from
screenConfig
Get Signature
get screenConfig():
Immutable<ScreenConfig>
Defined in: libs/scene/src/camera/camera.ts:1815
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:1818
Parameters
config
Immutable<ScreenConfig>
Returns
void
Inherited from
screenViewport
Get Signature
get screenViewport(): readonly
number[]
Defined in: libs/scene/src/camera/camera.ts:1824
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:1827
Parameters
viewport
readonly number[]
Returns
void
Inherited from
viewMatrix
Get Signature
get viewMatrix():
Immutable<Matrix4x4>
Defined in: libs/scene/src/camera/camera.ts:1993
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
viewProjectionMatrix
Get Signature
get viewProjectionMatrix():
Immutable<Matrix4x4>
Defined in: libs/scene/src/camera/camera.ts:1999
Returns
Immutable<Matrix4x4>
Inherited from
invViewProjectionMatrix
Get Signature
get invViewProjectionMatrix():
Immutable<Matrix4x4>
Defined in: libs/scene/src/camera/camera.ts:2011
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:2018
Gets the frustum of the camera
Returns
Immutable<Frustum>
Inherited from
frustumViewSpace
Get Signature
get frustumViewSpace():
Immutable<Frustum>
Defined in: libs/scene/src/camera/camera.ts:2024
Returns
Immutable<Frustum>
Inherited from
controller
Get Signature
get controller():
BaseCameraController
Defined in: libs/scene/src/camera/camera.ts:2034
The camera controller
Returns
Set Signature
set controller(
controller):void
Defined in: libs/scene/src/camera/camera.ts:2037
Parameters
controller
Returns
void
Inherited from
renderPipeline
Get Signature
get renderPipeline():
RenderPipeline<FrameGraphContext>
Defined in: libs/scene/src/camera/camera.ts:2461
The render pipeline that assembles this camera's frame graph. When null (the default), the shared default Forward+ pipeline is used. Assign a customized pipeline to override rendering for this camera only, e.g. camera.renderPipeline = createForwardPlusPipeline().insertAfter('SkyPass', myModule).
Returns
RenderPipeline<FrameGraphContext>
Set Signature
set renderPipeline(
pipeline):void
Defined in: libs/scene/src/camera/camera.ts:2464
Parameters
pipeline
RenderPipeline<FrameGraphContext>
Returns
void
Inherited from
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:313
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:316
Parameters
val
boolean
Returns
void
Inherited from
runtimeId
Get Signature
get runtimeId():
number
Defined in: libs/scene/src/scene/scene_node.ts:327
Node's runtime unique identifier
Returns
number
Inherited from
persistentId
Get Signature
get persistentId():
string
Defined in: libs/scene/src/scene/scene_node.ts:336
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:339
Parameters
id
string
Returns
void
Inherited from
prefabId
Get Signature
get prefabId():
string
Defined in: libs/scene/src/scene/scene_node.ts:348
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:351
Parameters
id
string
Returns
void
Inherited from
jointTypeT
Get Signature
get jointTypeT():
"none"|"animated"|"static"
Defined in: libs/scene/src/scene/scene_node.ts:367
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:370
Parameters
val
"none" | "animated" | "static"
Returns
void
Inherited from
jointTypeS
Get Signature
get jointTypeS():
"none"|"animated"|"static"
Defined in: libs/scene/src/scene/scene_node.ts:379
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:382
Parameters
val
"none" | "animated" | "static"
Returns
void
Inherited from
jointTypeR
Get Signature
get jointTypeR():
"none"|"animated"|"static"
Defined in: libs/scene/src/scene/scene_node.ts:391
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:394
Parameters
val
"none" | "animated" | "static"
Returns
void
Inherited from
metaData
Get Signature
get metaData():
Metadata
Defined in: libs/scene/src/scene/scene_node.ts:403
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:406
Parameters
val
Metadata
Returns
void
Inherited from
script
Get Signature
get script():
string
Defined in: libs/scene/src/scene/scene_node.ts:415
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:418
Parameters
fileName
string
Returns
void
Inherited from
scriptConfig
Get Signature
get scriptConfig():
object|unknown[]
Defined in: libs/scene/src/scene/scene_node.ts:431
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:434
Parameters
value
object | unknown[]
Returns
void
Inherited from
scripts
Get Signature
get scripts():
ScriptAttachment[]
Defined in: libs/scene/src/scene/scene_node.ts:448
All script attachments on this node.
Returns
Set Signature
set scripts(
value):void
Defined in: libs/scene/src/scene/scene_node.ts:451
Parameters
value
Returns
void
Inherited from
scriptConfigs
Get Signature
get scriptConfigs():
unknown[]
Defined in: libs/scene/src/scene/scene_node.ts:457
Script configs for all script attachments.
Returns
unknown[]
Set Signature
set scriptConfigs(
value):void
Defined in: libs/scene/src/scene/scene_node.ts:460
Parameters
value
unknown[]
Returns
void
Inherited from
name
Get Signature
get name():
string
Defined in: libs/scene/src/scene/scene_node.ts:475
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:478
Parameters
val
string
Returns
void
Inherited from
scene
Get Signature
get scene():
Scene
Defined in: libs/scene/src/scene/scene_node.ts:482
The owning scene.
Returns
Inherited from
attached
Get Signature
get attached():
boolean
Defined in: libs/scene/src/scene/scene_node.ts:488
Whether this node is currently attached under the scene's root.
Returns
boolean
Inherited from
sealed
Get Signature
get sealed():
boolean
Defined in: libs/scene/src/scene/scene_node.ts:502
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:505
Parameters
val
boolean
Returns
void
Inherited from
animationSet
Get Signature
get animationSet():
AnimationSet
Defined in: libs/scene/src/scene/scene_node.ts:514
Lazily created animation set for this node.
Remarks
Accessing this schedules the node for update in the scene.
Returns
Inherited from
sharedModel
Get Signature
get sharedModel():
SharedModel
Defined in: libs/scene/src/scene/scene_node.ts:524
Shared model reference for instancing/streaming systems.
Returns
Set Signature
set sharedModel(
model):void
Defined in: libs/scene/src/scene/scene_node.ts:527
Parameters
model
Returns
void
Inherited from
morphTargetGroups
Get Signature
get morphTargetGroups():
SceneMorphTargetGroup[]
Defined in: libs/scene/src/scene/scene_node.ts:531
Runtime morph target groups bound to this model instance.
Returns
Set Signature
set morphTargetGroups(
groups):void
Defined in: libs/scene/src/scene/scene_node.ts:534
Parameters
groups
Returns
void
Inherited from
clipTestEnabled
Get Signature
get clipTestEnabled():
boolean
Defined in: libs/scene/src/scene/scene_node.ts:779
Clip mode
Returns
boolean
Set Signature
set clipTestEnabled(
val):void
Defined in: libs/scene/src/scene/scene_node.ts:782
Parameters
val
boolean
Returns
void
Inherited from
hidden
Get Signature
get hidden():
boolean
Defined in: libs/scene/src/scene/scene_node.ts:786
Computed value of show state
Returns
boolean
Inherited from
showState
Get Signature
get showState():
SceneNodeVisible
Defined in: libs/scene/src/scene/scene_node.ts:794
Show state
Returns
Set Signature
set showState(
val):void
Defined in: libs/scene/src/scene/scene_node.ts:797
Parameters
val
Returns
void
Inherited from
pickable
Get Signature
get pickable():
boolean
Defined in: libs/scene/src/scene/scene_node.ts:815
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:818
Parameters
val
boolean
Returns
void
Inherited from
gpuPickable
Get Signature
get gpuPickable():
boolean
Defined in: libs/scene/src/scene/scene_node.ts:822
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:825
Parameters
val
boolean
Returns
void
Inherited from
computedBoundingBoxDrawMode
Get Signature
get computedBoundingBoxDrawMode():
number
Defined in: libs/scene/src/scene/scene_node.ts:907
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:918
Bounding box draw mode
Returns
number
Set Signature
set boundingBoxDrawMode(
mode):void
Defined in: libs/scene/src/scene/scene_node.ts:921
Parameters
mode
number
Returns
void
Inherited from
parent
Get Signature
get parent():
SceneNode
Defined in: libs/scene/src/scene/scene_node.ts:1211
Parent of the xform
Returns
Set Signature
set parent(
p):void
Defined in: libs/scene/src/scene/scene_node.ts:1214
Parameters
p
Returns
void
Inherited from
children
Get Signature
get children():
SceneNode[]
Defined in: libs/scene/src/scene/scene_node.ts:1220
Children of this xform
Returns
Inherited from
position
Get Signature
get position():
Vector3
Defined in: libs/scene/src/scene/scene_node.ts:1226
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:1229
Parameters
val
Vector3
Returns
void
Inherited from
scale
Get Signature
get scale():
Vector3
Defined in: libs/scene/src/scene/scene_node.ts:1235
Scaling of the xform
Returns
Vector3
Set Signature
set scale(
val):void
Defined in: libs/scene/src/scene/scene_node.ts:1238
Parameters
val
Vector3
Returns
void
Inherited from
rotation
Get Signature
get rotation():
Quaternion
Defined in: libs/scene/src/scene/scene_node.ts:1244
Rotation of the xform
Returns
Quaternion
Set Signature
set rotation(
val):void
Defined in: libs/scene/src/scene/scene_node.ts:1247
Parameters
val
Quaternion
Returns
void
Inherited from
localMatrix
Get Signature
get localMatrix():
Immutable<Matrix4x4>
Defined in: libs/scene/src/scene/scene_node.ts:1353
Local transformation matrix of the xform
Returns
Immutable<Matrix4x4>
Set Signature
set localMatrix(
matrix):void
Defined in: libs/scene/src/scene/scene_node.ts:1360
Parameters
matrix
Immutable<Matrix4x4>
Returns
void
Inherited from
worldMatrix
Get Signature
get worldMatrix():
Immutable<Matrix4x4>
Defined in: libs/scene/src/scene/scene_node.ts:1364
World transformation matrix of the xform
Returns
Immutable<Matrix4x4>
Inherited from
worldMatrixDet
Get Signature
get worldMatrixDet():
number
Defined in: libs/scene/src/scene/scene_node.ts:1369
The determinant of world matrix
Returns
number
Inherited from
invWorldMatrix
Get Signature
get invWorldMatrix():
Immutable<Matrix4x4>
Defined in: libs/scene/src/scene/scene_node.ts:1374
Inverse of the world transformation matrix of the xform
Returns
Immutable<Matrix4x4>
Inherited from
Methods
on()
Call Signature
on<
K>(type,listener,context?):void
Defined in: libs/base/dist/index.d.ts:671
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
Call Signature
on<
K>(type,listener,context?):void
Defined in: libs/base/dist/index.d.ts:630
IEventTarget.on
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener
EventListener<{ dispose: []; }, K>
context?
unknown
Returns
void
Inherited from
once()
Call Signature
once<
K>(type,listener,context?):void
Defined in: libs/base/dist/index.d.ts:675
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
Call Signature
once<
K>(type,listener,context?):void
Defined in: libs/base/dist/index.d.ts:634
IEventTarget.once
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener
EventListener<{ dispose: []; }, K>
context?
unknown
Returns
void
Inherited from
off()
Call Signature
off<
K>(type,listener,context?):void
Defined in: libs/base/dist/index.d.ts:679
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
Call Signature
off<
K>(type,listener?,context?):void
Defined in: libs/base/dist/index.d.ts:638
IEventTarget.off
Type Parameters
K
K extends "dispose"
Parameters
type
K
listener?
EventListener<{ dispose: []; }>
context?
unknown
Returns
void
Inherited from
dispatchEvent()
Call Signature
dispatchEvent<
K>(type, ...args):void
Defined in: libs/base/dist/index.d.ts:683
IEventTarget.dispatchEvent
Type Parameters
K
K extends "dispose" | "nodeattached" | "noderemoved" | "visiblechanged" | "transformchanged" | "bvchanged"
Parameters
type
K
args
...object & object[K]
Returns
void
Inherited from
Call Signature
dispatchEvent<
K>(type, ...args):void
Defined in: libs/base/dist/index.d.ts:642
IEventTarget.dispatchEvent
Type Parameters
K
K extends "dispose"
Parameters
type
K
args
...object[K]
Returns
void
Inherited from
dispose()
dispose():
void
Defined in: libs/base/dist/index.d.ts:6108
Returns
void
Inherited from
handleEvent()
handleEvent<
T>(ev,type?):boolean
Defined in: libs/scene/src/camera/camera.ts:1836
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
constructRay()
constructRay(
x,y):Ray
Defined in: libs/scene/src/camera/camera.ts:1879
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
lookAt()
lookAt(
eye,target,up):OrthoCamera
Defined in: libs/scene/src/camera/camera.ts:1903
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
lookAtCubeFace()
lookAtCubeFace(
face,position?):OrthoCamera
Defined in: libs/scene/src/camera/camera.ts:1912
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
getProjectionMatrix()
getProjectionMatrix():
Immutable<Matrix4x4>
Defined in: libs/scene/src/camera/camera.ts:1960
Gets the projection matrix of the camera
Returns
Immutable<Matrix4x4>
The projection matrix
Inherited from
getInvProjectionMatrix()
getInvProjectionMatrix():
Immutable<Matrix4x4>
Defined in: libs/scene/src/camera/camera.ts:1970
Gets the inverse projection matrix of the camera
Returns
Immutable<Matrix4x4>
The projection matrix
Inherited from
getRotationMatrix()
getRotationMatrix():
Matrix4x4
Defined in: libs/scene/src/camera/camera.ts:1976
Returns
Matrix4x4
Inherited from
isCamera()
isCamera():
this is Camera
Defined in: libs/scene/src/camera/camera.ts:2041
true if this is a camera node, false otherwise
Returns
this is Camera
Inherited from
getNearPlane()
getNearPlane():
number
Defined in: libs/scene/src/camera/camera.ts:2045
Gets the near clip plane of the camera
Returns
number
Inherited from
getFarPlane()
getFarPlane():
number
Defined in: libs/scene/src/camera/camera.ts:2049
Gets the far clip plane of the camera
Returns
number
Inherited from
getFOV()
getFOV():
number
Defined in: libs/scene/src/camera/camera.ts:2053
Gets the vertical field of view of the camera
Returns
number
Inherited from
getTanHalfFovy()
getTanHalfFovy():
number
Defined in: libs/scene/src/camera/camera.ts:2057
Gets the tangent of half of the vertical field of view
Returns
number
Inherited from
getAspect()
getAspect():
number
Defined in: libs/scene/src/camera/camera.ts:2061
Gets the aspect ratio
Returns
number
Inherited from
isPerspective()
isPerspective():
boolean
Defined in: libs/scene/src/camera/camera.ts:2065
Returns true if the camera is perspective
Returns
boolean
Inherited from
isOrtho()
isOrtho():
boolean
Defined in: libs/scene/src/camera/camera.ts:2069
Returns true if the camera is orthographic
Returns
boolean
Inherited from
getHistoryData()
getHistoryData():
CameraHistoryData
Defined in: libs/scene/src/camera/camera.ts:2076
Gets the camera history data which is used in temporal reprojection
Returns
Camera history data
Inherited from
clearHistoryData()
clearHistoryData():
void
Defined in: libs/scene/src/camera/camera.ts:2092
Clears the camera history data which is used in temporal reprojection
Returns
void
Inherited from
render()
render(
scene):void
Defined in: libs/scene/src/camera/camera.ts:2318
Renders a scene
Parameters
scene
The scene to be rendered
Returns
void
Inherited from
pickAsync()
pickAsync(
posX,posY):Promise<PickResult>
Defined in: libs/scene/src/camera/camera.ts:2369
Parameters
posX
number
posY
number
Returns
Promise<PickResult>
Inherited from
updateController()
updateController():
void
Defined in: libs/scene/src/camera/camera.ts:2398
Updates the controller state
Returns
void
Inherited from
resetController()
resetController():
void
Defined in: libs/scene/src/camera/camera.ts:2404
Reset the controller
Returns
void
Inherited from
getHistoryResourceManager()
getHistoryResourceManager():
HistoryResourceManager<Texture2D<unknown>>
Defined in: libs/scene/src/camera/camera.ts:2438
Gets the camera history resource manager for temporal effects.
Returns
HistoryResourceManager<Texture2D<unknown>>
Inherited from
Camera.getHistoryResourceManager
onDispose()
protectedonDispose():void
Defined in: libs/scene/src/camera/camera.ts:2508
Returns
void
Inherited from
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
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
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
getPrefabNode()
getPrefabNode():
SceneNode
Defined in: libs/scene/src/scene/scene_node.ts:358
Get prefab node this node belongs to, or null if this node does not belongs to any prefab
Returns
prefab node this node belongs to
Inherited from
clone()
clone():
Promise<OrthoCamera>
Defined in: libs/scene/src/scene/scene_node.ts:548
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
hasChild()
hasChild(
child):boolean
Defined in: libs/scene/src/scene/scene_node.ts:578
Whether the given node is a direct child of this node.
Parameters
child
The node to be checked
Returns
boolean
true if the given node is a direct child of this node, false otherwise
Inherited from
removeChildren()
removeChildren():
void
Defined in: libs/scene/src/scene/scene_node.ts:584
Remove all children from this node.
Returns
void
Inherited from
isParentOf()
isParentOf(
child):boolean
Defined in: libs/scene/src/scene/scene_node.ts:592
Whether this node is an ancestor (direct or indirect) of the given node.
Parameters
child
Returns
boolean
Inherited from
remove()
remove():
OrthoCamera
Defined in: libs/scene/src/scene/scene_node.ts:603
Detach this node from its parent.
Returns
OrthoCamera
this
Inherited from
traverse()
traverse(
v):void
Defined in: libs/scene/src/scene/scene_node.ts:612
Depth-first traversal of this node's subtree (pre-order).
Parameters
v
Visitor invoked on each node.
Returns
void
Inherited from
iterate()
iterate(
callback):boolean
Defined in: libs/scene/src/scene/scene_node.ts:626
Iterate self and descendants in pre-order.
Warning: Do not remove children during this iteration. To allow removal, use iterateBottomToTop.
Parameters
callback
Called for each node; if returns true, iteration stops.
Returns
boolean
If returns true, the iteration will immediately stop.
Inherited from
iterateBottomToTop()
iterateBottomToTop(
callback):boolean
Defined in: libs/scene/src/scene/scene_node.ts:645
Iterate self and descendants in reverse post-order (bottom-to-top).
Child nodes can be safely removed during this iteration.
Parameters
callback
Called for each node; if returns true, iteration stops.
Returns
boolean
If returns true, the iteration will immediately stop.
Inherited from
isGraphNode()
isGraphNode():
this is GraphNode
Defined in: libs/scene/src/scene/scene_node.ts:658
Type guard: true if this node is a graph node.
Returns
this is GraphNode
Inherited from
isLight()
isLight():
this is BaseLight
Defined in: libs/scene/src/scene/scene_node.ts:662
Type guard: true if this node is a light.
Returns
this is BaseLight
Inherited from
isMesh()
isMesh():
this is Mesh
Defined in: libs/scene/src/scene/scene_node.ts:666
Type guard: true if this node is a mesh.
Returns
this is Mesh
Inherited from
isSprite()
isSprite():
this is Sprite
Defined in: libs/scene/src/scene/scene_node.ts:670
Type guard: true if this node is a sprite
Returns
this is Sprite
Inherited from
isMSDFTextSprite()
isMSDFTextSprite():
this is MSDFTextSprite
Defined in: libs/scene/src/scene/scene_node.ts:674
Type guard: true if this node is a MSDF text sprite
Returns
this is MSDFTextSprite
Inherited from
isMSDFText()
isMSDFText():
this is MSDFText
Defined in: libs/scene/src/scene/scene_node.ts:678
Type guard: true if this node is a MSDF text sprite
Returns
this is MSDFText
Inherited from
isWater()
isWater():
this is Water
Defined in: libs/scene/src/scene/scene_node.ts:682
Type guard: true if this node is a water node.
Returns
this is Water
Inherited from
isHair()
isHair():
this is HairNode
Defined in: libs/scene/src/scene/scene_node.ts:686
Type guard: true if this node is a hair node.
Returns
this is HairNode
Inherited from
isParticleSystem()
isParticleSystem():
this is ParticleSystem
Defined in: libs/scene/src/scene/scene_node.ts:690
Type guard: true if this node is a particle system.
Returns
this is ParticleSystem
Inherited from
isBatchGroup()
isBatchGroup():
this is BatchGroup
Defined in: libs/scene/src/scene/scene_node.ts:694
Type guard: true if this node is a batch group.
Returns
this is BatchGroup
Inherited from
isClipmapTerrain()
isClipmapTerrain():
this is ClipmapTerrain
Defined in: libs/scene/src/scene/scene_node.ts:698
Type guard: true if this node is a clipmap terrain.
Returns
this is ClipmapTerrain
Inherited from
isPunctualLight()
isPunctualLight():
this is PunctualLight
Defined in: libs/scene/src/scene/scene_node.ts:706
true if this is a punctual light node, false otherwise
Returns
this is PunctualLight
Inherited from
computeBoundingVolume()
computeBoundingVolume():
BoundingVolume
Defined in: libs/scene/src/scene/scene_node.ts:713
Computes the bounding volume of the node
Returns
The output bounding volume
Inherited from
getBoundingVolume()
getBoundingVolume():
BoundingVolume
Defined in: libs/scene/src/scene/scene_node.ts:720
Gets the bounding volume of the node
Returns
The bounding volume of the node
Inherited from
setBoundingVolume()
setBoundingVolume(
bv):void
Defined in: libs/scene/src/scene/scene_node.ts:731
Sets the bounding volume of the node
Parameters
bv
The bounding volume to set
Returns
void
Inherited from
getWorldBoundingVolume()
getWorldBoundingVolume():
BoundingVolume
Defined in: libs/scene/src/scene/scene_node.ts:742
Gets the world space bounding volume of the node
Returns
The world space bounding volume of the node
Inherited from
computeWorldBoundingVolume()
computeWorldBoundingVolume(
localBV):BoundingVolume
Defined in: libs/scene/src/scene/scene_node.ts:752
Computes the world space bounding volume of the node
Parameters
localBV
Returns
The output bounding volume
Inherited from
Camera.computeWorldBoundingVolume
invalidateBoundingVolume()
invalidateBoundingVolume():
void
Defined in: libs/scene/src/scene/scene_node.ts:758
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:763
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:835
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
findSkeletonById()
findSkeletonById(
id):SkinBinding
Defined in: libs/scene/src/scene/scene_node.ts:850
Finds a skeleton object by its persistent ID.
Parameters
id
string
Persistent identifier to match against Skeleton.persistentId.
Returns
The first matchign node, or null if not found.
Inherited from
findSkinBindingById()
findSkinBindingById(
id):SkinBinding
Defined in: libs/scene/src/scene/scene_node.ts:858
Finds a skin binding by its persistent ID.
Parameters
id
string
Persistent identifier to match against SkinBinding.persistentId.
Returns
The first matching binding, or null if not found.
Inherited from
findSkeletonRigById()
findSkeletonRigById(
id):SkeletonRig
Defined in: libs/scene/src/scene/scene_node.ts:873
Finds a shared skeleton rig by its persistent ID.
Parameters
id
string
Persistent identifier to match against SkeletonRig.persistentId.
Returns
The first matching rig, or null if not found.
Inherited from
findNodeByName()
findNodeByName<
T>(name):T
Defined in: libs/scene/src/scene/scene_node.ts:895
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
getSerializedMorphTargetGroups()
getSerializedMorphTargetGroups():
SerializedMorphTargetGroup[]
Defined in: libs/scene/src/scene/scene_node.ts:978
Returns serialized morph target groups for this node.
Returns
Inherited from
Camera.getSerializedMorphTargetGroups
setSerializedMorphTargetGroups()
setSerializedMorphTargetGroups(
groups):void
Defined in: libs/scene/src/scene/scene_node.ts:996
Restores serialized morph target groups for this node.
Parameters
groups
Returns
void
Inherited from
Camera.setSerializedMorphTargetGroups
invalidateTransform()
invalidateTransform(
invalidateLocal?):void
Defined in: libs/scene/src/scene/scene_node.ts:1032
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
setMorphTargetWeight()
setMorphTargetWeight(
name,weight):void
Defined in: libs/scene/src/scene/scene_node.ts:1040
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
setMorphTargetGroupWeight()
setMorphTargetGroupWeight(
name,weight):void
Defined in: libs/scene/src/scene/scene_node.ts:1056
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:1078
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:1086
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:1102
Collect all model-level morph target group names.
Returns
string[]
Array of morph target group names
Inherited from
Camera.collectMorphTargetGroupNames
onPostClone()
protectedonPostClone():void|Promise<void>
Defined in: libs/scene/src/scene/scene_node.ts:1111
Get called when the node was just created by cloning from other node
Returns
void | Promise<void>
Inherited from
_onAttached()
protected_onAttached():void
Defined in: libs/scene/src/scene/scene_node.ts:1181
Get called when this node is attached to scene
Returns
void
Inherited from
_onDetached()
protected_onDetached():void
Defined in: libs/scene/src/scene/scene_node.ts:1185
Get called when this node is detached from scene
Returns
void
Inherited from
worldToThis()
Call Signature
worldToThis(
v,result?):Vector3
Defined in: libs/scene/src/scene/scene_node.ts:1256
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
Call Signature
worldToThis(
v,result?):Vector4
Defined in: libs/scene/src/scene/scene_node.ts:1257
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
otherToThis()
Call Signature
otherToThis(
other,v,result?):Vector3
Defined in: libs/scene/src/scene/scene_node.ts:1276
Transform coordinate in other coordinate space to local space
Parameters
other
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
Call Signature
otherToThis(
other,v,result?):Vector4
Defined in: libs/scene/src/scene/scene_node.ts:1277
Transform coordinate in other coordinate space to local space
Parameters
other
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
thisToWorld()
Call Signature
thisToWorld(
v,result?):Vector3
Defined in: libs/scene/src/scene/scene_node.ts:1287
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
Call Signature
thisToWorld(
v,result?):Vector4
Defined in: libs/scene/src/scene/scene_node.ts:1288
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
thisToOther()
Call Signature
thisToOther(
other,v,result?):Vector3
Defined in: libs/scene/src/scene/scene_node.ts:1307
Transform local space coordinate to other coordinate space
Parameters
other
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
Call Signature
thisToOther(
other,v,result?):Vector4
Defined in: libs/scene/src/scene/scene_node.ts:1308
Transform local space coordinate to other coordinate space
Parameters
other
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
getWorldPosition()
getWorldPosition(
outPos?):Vector3
Defined in: libs/scene/src/scene/scene_node.ts:1316
Gets the position of the xform in world space
Parameters
outPos?
Vector3
Returns
Vector3
position of the xform in world space
Inherited from
moveBy()
moveBy(
delta):OrthoCamera
Defined in: libs/scene/src/scene/scene_node.ts:1327
Moves the xform by an offset vector
Parameters
delta
Vector3
The offset vector
Returns
OrthoCamera
self
Inherited from
scaleBy()
scaleBy(
factor):OrthoCamera
Defined in: libs/scene/src/scene/scene_node.ts:1336
Scales the xform by a given scale factor
Parameters
factor
Vector3
The scale factor
Returns
OrthoCamera
self
Inherited from
setLocalTransform()
setLocalTransform(
matrix):OrthoCamera
Defined in: libs/scene/src/scene/scene_node.ts:1345
Sets the local transform matrix of the xform
Parameters
matrix
Matrix4x4
The transform matrix to set
Returns
OrthoCamera
self
Inherited from
calculateLocalTransform()
calculateLocalTransform(
outMatrix):void
Defined in: libs/scene/src/scene/scene_node.ts:1382
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:1389
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:1413
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
updatePerCamera()
updatePerCamera(
_camera,_elapsedInSeconds,_deltaInSeconds):void
Defined in: libs/scene/src/scene/scene_node.ts:1433
Update node state once per-camera
Parameters
_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
reparent()
reparent(
p?):OrthoCamera
Defined in: libs/scene/src/scene/scene_node.ts:1439
Removes this node from it's parent and add this node to another parent node if required
Parameters
p?
The new parent node that this node should be added to or null
Returns
OrthoCamera
self