Class: CSSView

A CSSView within a CSSRenderer

Hierarchy

• View

  ↳ CSSView

Table of contents

Constructors

• constructor

Properties

• _scissor
• _scissorParams
• _viewport
• _viewportParams
• _zIndex
• camera
• css3DRenderer
• domElement
• id
• renderer
• resizeObserver
• scene
• scissorElement
• scissorSize
• viewportElement
• viewportSizePx
• worldViewport

Accessors

• rendererDomElement
• scissor
• viewport

Methods

• _init
• _onResize
• calculateViewRectangle
• destroy
• getWorldViewport
• setCamera

Constructors

constructor

• new CSSView(renderer, params)

Constructor for a CSSView

Parameters

Overrides

View.constructor

Defined in

packages/three/src/renderer/css/css-view.ts:174

Properties

_scissor

• Private _scissor: ViewRectangle

The scissor for the css view rectangle

Defined in

packages/three/src/renderer/css/css-view.ts:137

_scissorParams

• Private _scissorParams: ViewRectangleParams

Parameters for the scissor that are used to recalculate the scissor on resize

Defined in

packages/three/src/renderer/css/css-view.ts:147

_viewport

• Private _viewport: ViewRectangle

The viewport for the css view rectangle

Defined in

packages/three/src/renderer/css/css-view.ts:131

_viewportParams

• Private _viewportParams: ViewRectangleParams

Parameters for the viewport that are used to recalculate the viewport on resize

Defined in

packages/three/src/renderer/css/css-view.ts:142

_zIndex

• Private _zIndex: number = 0

The zIndex for the view

Overrides

View._zIndex

Defined in

packages/three/src/renderer/css/css-view.ts:125

camera

• camera: PerspectiveCamera | OrthographicCamera

The camera for the view

Overrides

View.camera

Defined in

packages/three/src/renderer/css/css-view.ts:52

css3DRenderer

• css3DRenderer: CSS3DRenderer

The css renderer for the view

Defined in

packages/three/src/renderer/css/css-view.ts:77

domElement

• domElement: HTMLElement

The dom element for the view

Overrides

View.domElement

Defined in

packages/three/src/renderer/css/css-view.ts:119

id

• id: string

The id for the view

Overrides

View.id

Defined in

packages/three/src/renderer/css/css-view.ts:47

renderer

• Private renderer: CSSRenderer

The renderer the view is part of

Defined in

packages/three/src/renderer/css/css-view.ts:167

resizeObserver

• Private resizeObserver: ResizeObserver

The resize observer for the renderer dom element

Defined in

packages/three/src/renderer/css/css-view.ts:162

scene

• scene: Scene

The scene for the view

Overrides

View.scene

Defined in

packages/three/src/renderer/css/css-view.ts:57

scissorElement

• Private scissorElement: HTMLElement

The dom element for the css view scissor

Defined in

packages/three/src/renderer/css/css-view.ts:157

scissorSize

• scissorSize: ViewSize

The current size of the scissor in pixels

Defined in

packages/three/src/renderer/css/css-view.ts:72

viewportElement

• Private viewportElement: HTMLElement

The dom element for the css view viewport

Defined in

packages/three/src/renderer/css/css-view.ts:152

viewportSizePx

• viewportSizePx: ViewSize

The current size of the viewport in pixels

Overrides

View.viewportSizePx

Defined in

packages/three/src/renderer/css/css-view.ts:67

worldViewport

• worldViewport: Object

Bounds of the viewport in 3d units + factor (size/viewport)

Type declaration

Defined in

packages/three/src/renderer/css/css-view.ts:62

Accessors

rendererDomElement

• get rendererDomElement(): HTMLElement

Gets the dom element used by the renderer

Returns

HTMLElement

Overrides

View.rendererDomElement

Defined in

packages/three/src/renderer/css/css-view.ts:112

scissor

• get scissor(): ViewRectangleParams

Getter for the scissor params

Returns

ViewRectangleParams

Defined in

packages/three/src/renderer/css/css-view.ts:97

• set scissor(v): void

Setter for the scissor params. Resizes the view on setting.

Parameters

Returns

void

Defined in

packages/three/src/renderer/css/css-view.ts:104

viewport

• get viewport(): ViewRectangleParams

Getter for the viewport params

Returns

ViewRectangleParams

Defined in

packages/three/src/renderer/css/css-view.ts:82

• set viewport(v): void

Setter for the viewport params. Resizes the view on setting.

Parameters

Returns

void

Defined in

packages/three/src/renderer/css/css-view.ts:89

Methods

_init

▸ Private _init(): void

Initialises the view

Returns

void

Defined in

packages/three/src/renderer/css/css-view.ts:245

_onResize

▸ Private _onResize(): void

Handles resizing

Returns

void

Defined in

packages/three/src/renderer/css/css-view.ts:253

calculateViewRectangle

▸ Protected calculateViewRectangle(params): ViewRectangle

Calculates a view rectangle from given view rectangle params

Parameters

Returns

ViewRectangle

a view rectangle of decimal percentages

Inherited from

View.calculateViewRectangle

Defined in

packages/three/src/renderer/view.ts:100

destroy

▸ destroy(): void

Destroys the view and removes it from the renderer

Returns

void

Defined in

packages/three/src/renderer/css/css-view.ts:237

getWorldViewport

▸ getWorldViewport(target): Object

Gets the world viewport for a given target

Parameters

Returns

Object

the world viewport for a given target

Inherited from

View.getWorldViewport

Defined in

packages/three/src/renderer/view.ts:59

setCamera

▸ setCamera(c): void

Sets the camera for the view

Parameters

Returns

void

Defined in

packages/three/src/renderer/css/css-view.ts:229