@univerjs/engine-render v0.4.2 • Docs

Class: `abstract` ThinScene

Extends

Disposable

Extended by

Scene

Constructors

new ThinScene()

new ThinScene(sceneKey): ThinScene

Parameters

Parameter	Type
`sceneKey`	`string`

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
`debounceParentTimeout`	`public`	`number`	`-1`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:68 (opens in a new tab)
`onDblclick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:58 (opens in a new tab)
`onDragEnter$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:50 (opens in a new tab)
`onDragLeave$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:54 (opens in a new tab)
`onDragOver$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:52 (opens in a new tab)
`onDrop$`	`public`	`EventSubject`<`IDragEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:56 (opens in a new tab)
`onFileLoaded$`	`public`	`EventSubject`<`string`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:34 (opens in a new tab)
`onKeyDown$`	`public`	`EventSubject`<`IKeyboardEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:64 (opens in a new tab)
`onKeyUp$`	`public`	`EventSubject`<`IKeyboardEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:66 (opens in a new tab)
`onMouseWheel$`	`public`	`EventSubject`<`IWheelEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:62 (opens in a new tab)
`onPointerCancel$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:46 (opens in a new tab)
`onPointerDown$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:36 (opens in a new tab)
`onPointerEnter$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:42 (opens in a new tab)
`onPointerLeave$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:48 (opens in a new tab)
`onPointerMove$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:38 (opens in a new tab)
`onPointerOut$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:44 (opens in a new tab)
`onPointerUp$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:40 (opens in a new tab)
`onTransformChange$`	`public`	`EventSubject`<`ITransformChangeState`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:32 (opens in a new tab)
`onTripleClick$`	`public`	`EventSubject`<`IMouseEvent` \| `IPointerEvent`>	`undefined`	-	submodules/univer/packages/engine-render/src/thin-scene.ts:60 (opens in a new tab)

Accessors

classType

get classType(): RENDER_CLASS_TYPE

Returns

RENDER_CLASS_TYPE

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:89 (opens in a new tab)

height

get height(): number

set height(num): void

Parameters

Parameter	Type
`num`	`number`

Returns

number

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:101 (opens in a new tab)

objectsEvented

get objectsEvented(): boolean

Returns

boolean

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:117 (opens in a new tab)

scaleX

get scaleX(): number

set scaleX(scaleX): void

Parameters

Parameter	Type
`scaleX`	`number`

Returns

number

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:105 (opens in a new tab)

scaleY

get scaleY(): number

set scaleY(scaleY): void

Parameters

Parameter	Type
`scaleY`	`number`

Returns

number

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:109 (opens in a new tab)

sceneKey

get sceneKey(): string

Returns

string

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:113 (opens in a new tab)

transform

get transform(): Transform

set transform(trans): void

Parameters

Parameter	Type
`trans`	`Transform`

Returns

Transform

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:93 (opens in a new tab)

width

get width(): number

set width(num): void

Parameters

Parameter	Type
`num`	`number`

Returns

number

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:97 (opens in a new tab)

Methods

addObject()

abstract addObject(o, zIndex?): void

Parameters

Parameter	Type
`o`	`BaseObject`
`zIndex`?	`number`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:225 (opens in a new tab)

addObjects()

abstract addObjects(objects, zIndex?): void

Parameters

Parameter	Type
`objects`	`BaseObject`[]
`zIndex`?	`number`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:227 (opens in a new tab)

addViewport()

abstract addViewport(...viewport): void

Parameters

Parameter	Type
...`viewport`	`any`[]

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:251 (opens in a new tab)

attachTransformerTo()

attachTransformerTo(o): void

Parameters

Parameter	Type
`o`	`BaseObject`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:233 (opens in a new tab)

detachTransformerFrom()

detachTransformerFrom(o): void

Parameters

Parameter	Type
`o`	`BaseObject`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:235 (opens in a new tab)

disableObjectsEvent()

disableObjectsEvent(): void

If scene.event is disabled, scene.pick(curosrPos) return null. Then only scene itself can response to pointer event, all objects under the scene would not. see sceneInputManager@_onPointerMove

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:150 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Overrides

Disposable.dispose

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:200 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)

enableObjectsEvent()

enableObjectsEvent(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:141 (opens in a new tab)

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)

getAncestorScale()

getAncestorScale(): {
  scaleX: 1;
  scaleY: 1;
}

Returns

{
  scaleX: 1;
  scaleY: 1;
}

Name	Type	Default value	Defined in
`scaleX`	`number`	1	submodules/univer/packages/engine-render/src/thin-scene.ts:257 (opens in a new tab)
`scaleY`	`number`	1	submodules/univer/packages/engine-render/src/thin-scene.ts:258 (opens in a new tab)

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:255 (opens in a new tab)

getEngine()

abstract getEngine(): Nullable<ThinEngine<Scene>>

Returns

Nullable<ThinEngine<Scene>>

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:229 (opens in a new tab)

getObject()

abstract getObject(oKey): Nullable<BaseObject>

Parameters

Parameter	Type
`oKey`	`string`

Returns

Nullable<BaseObject>

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:223 (opens in a new tab)

getParent()

abstract getParent(): any

Returns

any

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:198 (opens in a new tab)

getPrecisionScale()

getPrecisionScale(): {
  scaleX: 1;
  scaleY: 1;
}

Returns

{
  scaleX: 1;
  scaleY: 1;
}

Name	Type	Default value	Defined in
`scaleX`	`number`	1	submodules/univer/packages/engine-render/src/thin-scene.ts:264 (opens in a new tab)
`scaleY`	`number`	1	submodules/univer/packages/engine-render/src/thin-scene.ts:265 (opens in a new tab)

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:262 (opens in a new tab)

getViewports()

getViewports(): any[]

Returns

any[]

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:247 (opens in a new tab)

makeDirty()

makeDirty(state): ThinScene

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

ThinScene

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:241 (opens in a new tab)

makeDirtyNoParent()

makeDirtyNoParent(state): ThinScene

Parameters

Parameter	Type	Default value
`state`	`boolean`	`true`

Returns

ThinScene

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:237 (opens in a new tab)

pick()

abstract pick(coord): Nullable<BaseObject | ThinScene>

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Nullable<BaseObject | ThinScene>

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:245 (opens in a new tab)

removeViewport()

abstract removeViewport(key): void

Parameters

Parameter	Type
`key`	`string`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:253 (opens in a new tab)

render()

abstract render(parentCtx?): void

Parameters

Parameter	Type
`parentCtx`?	`UniverRenderingContext`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:196 (opens in a new tab)

resetCursor()

abstract resetCursor(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:271 (opens in a new tab)

setCursor()

abstract setCursor(val): void

Parameters

Parameter	Type
`val`	`CURSOR_TYPE`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:269 (opens in a new tab)

setObjectBehavior()

abstract setObjectBehavior(o): void

Parameters

Parameter	Type
`o`	`BaseObject`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:231 (opens in a new tab)

triggerDblclick()

abstract triggerDblclick(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:174 (opens in a new tab)

triggerDragEnter()

abstract triggerDragEnter(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:188 (opens in a new tab)

triggerDragLeave()

abstract triggerDragLeave(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:192 (opens in a new tab)

triggerDragOver()

abstract triggerDragOver(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:190 (opens in a new tab)

triggerDrop()

abstract triggerDrop(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IDragEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:194 (opens in a new tab)

triggerKeyDown()

triggerKeyDown(evt): void

Parameters

Parameter	Type
`evt`	`IKeyboardEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:154 (opens in a new tab)

triggerKeyUp()

triggerKeyUp(evt): void

Parameters

Parameter	Type
`evt`	`IKeyboardEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:161 (opens in a new tab)

triggerMouseWheel()

abstract triggerMouseWheel(evt): void

Parameters

Parameter	Type
`evt`	`IWheelEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:170 (opens in a new tab)

triggerPointerDown()

abstract triggerPointerDown(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:178 (opens in a new tab)

triggerPointerEnter()

abstract triggerPointerEnter(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:186 (opens in a new tab)

triggerPointerLeave()

abstract triggerPointerLeave(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:182 (opens in a new tab)

triggerPointerMove()

abstract triggerPointerMove(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:172 (opens in a new tab)

triggerPointerOut()

abstract triggerPointerOut(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:180 (opens in a new tab)

triggerPointerOver()

abstract triggerPointerOver(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:184 (opens in a new tab)

triggerPointerUp()

abstract triggerPointerUp(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:168 (opens in a new tab)

triggerTripleClick()

abstract triggerTripleClick(evt): void

Parameters

Parameter	Type
`evt`	`IMouseEvent` \| `IPointerEvent`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/thin-scene.ts:176 (opens in a new tab)

Thinengine Transform

Class: abstract ThinScene

Extends

Extended by

Constructors

new ThinScene()

Parameters

Returns

Overrides

Defined in

Properties

Accessors

classType

Returns

Defined in

height

Parameters

Returns

Defined in

objectsEvented

Returns

Defined in

scaleX

Parameters

Returns

Defined in

scaleY

Parameters

Returns

Defined in

sceneKey

Returns

Defined in

transform

Parameters

Returns

Defined in

width

Parameters

Returns

Defined in

Methods

addObject()

Parameters

Returns

Defined in

addObjects()

Parameters

Returns

Defined in

addViewport()

Parameters

Returns

Defined in

attachTransformerTo()

Parameters

Returns

Defined in

detachTransformerFrom()

Parameters

Returns

Defined in

disableObjectsEvent()

Returns

Defined in

dispose()

Returns

Overrides

Defined in

disposeWithMe()

Parameters

Returns

Inherited from

Defined in

enableObjectsEvent()

Returns

Defined in

ensureNotDisposed()

Returns

Inherited from

Defined in

Class: `abstract` ThinScene