Class View3D

Hierarchy (View Summary)

ViewTransform
- View3D
  - View2D

Constructors

constructor

new View3D(
    redGPUContext: RedGPUContext,
    scene: Scene,
    camera: Camera2D | AController,
    name?: string,
): View3D
Creates a new instance of the Constructor class.
Parameters
- redGPUContext: RedGPUContext
  The RedGPUContext.
- scene: Scene
  The scene to render the constructor in.
- camera: Camera2D | AController
  The camera used for rendering.
- Optionalname: string
  The name of the constructor.
Returns View3D
Overrides ViewTransform.constructor
- Defined in src/display/view/View3D.ts:79

Properties

onResize

onResize: (width: number, height: number) => void = null

Accessors

aspect

get aspect(): number
Returns number
Inherited from ViewTransform.aspect
- Defined in src/display/view/ViewTransform.ts:99

axis

get axis(): DrawDebuggerAxis
Returns DrawDebuggerAxis
- Defined in src/display/view/View3D.ts:159
set axis(value: boolean | DrawDebuggerAxis): void
Parameters
- value: boolean | DrawDebuggerAxis
Returns void
- Defined in src/display/view/View3D.ts:163

camera

get camera(): Camera2D | PerspectiveCamera | OrthographicCamera | AController
Returns Camera2D | PerspectiveCamera | OrthographicCamera | AController
Inherited from ViewTransform.camera
- Defined in src/display/view/ViewTransform.ts:33
set camera(
value: Camera2D | PerspectiveCamera | OrthographicCamera | AController,
): void
Parameters
- value: Camera2D | PerspectiveCamera | OrthographicCamera | AController
Returns void
Inherited from ViewTransform.camera
- Defined in src/display/view/ViewTransform.ts:37

debugViewRenderState

get debugViewRenderState(): RenderViewStateData
Returns RenderViewStateData
- Defined in src/display/view/View3D.ts:136

distanceCulling

get distanceCulling(): number
Returns number
- Defined in src/display/view/View3D.ts:207
set distanceCulling(value: number): void
Parameters
- value: number
Returns void
- Defined in src/display/view/View3D.ts:211

frustumPlanes

get frustumPlanes(): number[][]
Returns number[][]
Inherited from ViewTransform.frustumPlanes
- Defined in src/display/view/ViewTransform.ts:103

grid

get grid(): DrawDebuggerGrid
Returns DrawDebuggerGrid
- Defined in src/display/view/View3D.ts:141
set grid(value: boolean | DrawDebuggerGrid): void
Parameters
- value: boolean | DrawDebuggerGrid
Returns void
- Defined in src/display/view/View3D.ts:145

height

get height(): string | number
Returns string | number
Inherited from ViewTransform.height
- Defined in src/display/view/ViewTransform.ts:66
set height(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from ViewTransform.height
- Defined in src/display/view/ViewTransform.ts:70

ibl

get ibl(): IBL
Returns IBL
- Defined in src/display/view/View3D.ts:111
set ibl(value: IBL): void
Parameters
- value: IBL
Returns void
- Defined in src/display/view/View3D.ts:115

inverseProjectionMatrix

get inverseProjectionMatrix(): mat4
Returns mat4
Inherited from ViewTransform.inverseProjectionMatrix
- Defined in src/display/view/ViewTransform.ts:157

name

get name(): string
Returns string
- Defined in src/display/view/View3D.ts:127
set name(value: string): void
Parameters
- value: string
Returns void
- Defined in src/display/view/View3D.ts:132

passLightClustersBound

get passLightClustersBound(): PassClusterLightBound
Returns PassClusterLightBound
- Defined in src/display/view/View3D.ts:107

pickingManager

get pickingManager(): PickingManager
Returns PickingManager
- Defined in src/display/view/View3D.ts:119

pixelRectArray

get pixelRectArray(): [number, number, number, number]
Returns [number, number, number, number]
Inherited from ViewTransform.pixelRectArray
- Defined in src/display/view/ViewTransform.ts:74

pixelRectObject

get pixelRectObject(): { height: number; width: number; x: number; y: number }
Returns { height: number; width: number; x: number; y: number }
Inherited from ViewTransform.pixelRectObject
- Defined in src/display/view/ViewTransform.ts:78

postEffectManager

get postEffectManager(): PostEffectManager
Returns PostEffectManager
- Defined in src/display/view/View3D.ts:123

projectionMatrix

get projectionMatrix(): mat4
Returns mat4
Inherited from ViewTransform.projectionMatrix
- Defined in src/display/view/ViewTransform.ts:115

rawCamera

get rawCamera(): Camera2D | PerspectiveCamera
Returns Camera2D | PerspectiveCamera
Inherited from ViewTransform.rawCamera
- Defined in src/display/view/ViewTransform.ts:111

redGPUContext

get redGPUContext(): RedGPUContext
Returns RedGPUContext
Inherited from ViewTransform.redGPUContext
- Defined in src/display/view/ViewTransform.ts:29

scene

get scene(): Scene
Returns Scene
- Defined in src/display/view/View3D.ts:215
set scene(value: Scene): void
Parameters
- value: Scene
Returns void
- Defined in src/display/view/View3D.ts:219

screenRectObject

get screenRectObject(): { height: number; width: number; x: number; y: number }
Returns { height: number; width: number; x: number; y: number }
Inherited from ViewTransform.screenRectObject
- Defined in src/display/view/ViewTransform.ts:90

skybox

get skybox(): SkyBox
Returns SkyBox
- Defined in src/display/view/View3D.ts:177
set skybox(value: SkyBox): void
Parameters
- value: SkyBox
Returns void
- Defined in src/display/view/View3D.ts:181

systemUniform_Vertex_StructInfo

get systemUniform_Vertex_StructInfo(): any
Returns any
- Defined in src/display/view/View3D.ts:95

systemUniform_Vertex_UniformBindGroup

get systemUniform_Vertex_UniformBindGroup(): GPUBindGroup
Returns GPUBindGroup
- Defined in src/display/view/View3D.ts:99

systemUniform_Vertex_UniformBuffer

get systemUniform_Vertex_UniformBuffer(): UniformBuffer
Returns UniformBuffer
- Defined in src/display/view/View3D.ts:103

useDistanceCulling

get useDistanceCulling(): boolean
Returns boolean
- Defined in src/display/view/View3D.ts:199
set useDistanceCulling(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/display/view/View3D.ts:203

useFrustumCulling

get useFrustumCulling(): boolean
Returns boolean
- Defined in src/display/view/View3D.ts:191
set useFrustumCulling(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/display/view/View3D.ts:195

viewRenderTextureManager

get viewRenderTextureManager(): ViewRenderTextureManager
Returns ViewRenderTextureManager
- Defined in src/display/view/View3D.ts:91

width

get width(): string | number
Returns string | number
Inherited from ViewTransform.width
- Defined in src/display/view/ViewTransform.ts:58
set width(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from ViewTransform.width
- Defined in src/display/view/ViewTransform.ts:62

x

get x(): string | number
Returns string | number
Inherited from ViewTransform.x
- Defined in src/display/view/ViewTransform.ts:42
set x(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from ViewTransform.x
- Defined in src/display/view/ViewTransform.ts:46

y

get y(): string | number
Returns string | number
Inherited from ViewTransform.y
- Defined in src/display/view/ViewTransform.ts:50
set y(value: string | number): void
Parameters
- value: string | number
Returns void
Inherited from ViewTransform.y
- Defined in src/display/view/ViewTransform.ts:54

Methods

checkMouseInViewBounds

checkMouseInViewBounds(): boolean
Returns boolean
- Defined in src/display/view/View3D.ts:280

screenToWorld

screenToWorld(screenX: number, screenY: number): number[]
Parameters
- screenX: number
- screenY: number
Returns number[]
- Defined in src/display/view/View3D.ts:224

setPosition

setPosition(x?: string | number, y?: string | number): void
Parameters
- x: string | number = ...
- y: string | number = ...
Returns void
Inherited from ViewTransform.setPosition
- Defined in src/display/view/ViewTransform.ts:161

setSize

setSize(w?: string | number, h?: string | number): void
Parameters
- w: string | number = ...
- h: string | number = ...
Returns void
Inherited from ViewTransform.setSize
- Defined in src/display/view/ViewTransform.ts:175

update

update(
    view: View3D,
    shadowRender?: boolean,
    calcPointLightCluster?: boolean,
    renderPath1ResultTextureView?: GPUTextureView,
): void
Parameters
- view: View3D
- shadowRender: boolean = false
- calcPointLightCluster: boolean = false
- OptionalrenderPath1ResultTextureView: GPUTextureView
Returns void
- Defined in src/display/view/View3D.ts:231

Class View3D

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns View3D

Properties

onResize

Accessors

aspect

Returns number

axis

Returns DrawDebuggerAxis

Parameters

Returns void

camera

Returns Camera2D | PerspectiveCamera | OrthographicCamera | AController

Parameters

Returns void

debugViewRenderState

Returns RenderViewStateData

distanceCulling

Returns number

Parameters

Returns void

frustumPlanes

Returns number[][]

grid

Returns DrawDebuggerGrid

Parameters

Returns void

height

Returns string | number

Parameters

Returns void

ibl

Returns IBL

Parameters

Returns void

inverseProjectionMatrix

Returns mat4

name

Returns string

Parameters

Returns void

passLightClustersBound

Returns PassClusterLightBound

pickingManager

Returns PickingManager

pixelRectArray

Returns [number, number, number, number]

pixelRectObject

Returns { height: number; width: number; x: number; y: number }

postEffectManager

Returns PostEffectManager

projectionMatrix

Returns mat4

rawCamera

Returns Camera2D | PerspectiveCamera

redGPUContext

Returns RedGPUContext

scene

Returns Scene

Parameters

Returns void

screenRectObject

Returns { height: number; width: number; x: number; y: number }

skybox

Returns SkyBox

Parameters

Returns void

systemUniform_Vertex_StructInfo

Returns any

systemUniform_Vertex_UniformBindGroup

Returns GPUBindGroup