Class SceneViewportRedrawRequest

Structure holding the data for a viewport redraw request event.

Index

Constructors

Properties

Accessors

Methods

assign clone isEqual isEqual

Constructors

constructor

new SceneViewportRedrawRequest(
scene?: SceneInstance,
reason?: EnumValue<RedrawRequestReasonFlag>,
): SceneViewportRedrawRequest
Parameters
- Optionalscene: SceneInstance
- Optionalreason: EnumValue<RedrawRequestReasonFlag>
Returns SceneViewportRedrawRequest

Properties

`Protected`_reason

_reason: EnumValue<RedrawRequestReasonFlag>

`Protected`_scene

_scene: SceneInstance

Accessors

reason

get reason(): EnumValue<RedrawRequestReasonFlag>

Reason for the redraw request.

Returns EnumValue<RedrawRequestReasonFlag>
set reason(value: EnumValue<RedrawRequestReasonFlag>): void
Parameters
- value: EnumValue<RedrawRequestReasonFlag>
Returns void

scene

get scene(): SceneInstance

The scene for which the redraw was requested for.

Returns SceneInstance

Note
If no Scene is specified, all scene viewport are requested to redraw.
set scene(value: SceneInstance): void
Parameters
- value: SceneInstance
Returns void

Methods

assign

assign(other: Immutable<SceneViewportRedrawRequest>): SceneViewportRedrawRequest
Copies all properties defined by the prototype of SceneViewportRedrawRequest from other to this instance.
Parameters
- other: Immutable<SceneViewportRedrawRequest>
Returns SceneViewportRedrawRequest

clone

clone(): SceneViewportRedrawRequest

Clones this instance and returns a new SceneViewportRedrawRequest with identical values.

Returns SceneViewportRedrawRequest

isEqual

isEqual(
this: Immutable<SceneViewportRedrawRequest>,
other: Immutable<SceneViewportRedrawRequest>,
): boolean
Determines if this SceneViewportRedrawRequest instance is equal to the other instance.
Parameters
- this: Immutable<SceneViewportRedrawRequest>
- other: Immutable<SceneViewportRedrawRequest>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<SceneViewportRedrawRequest>,
rhs: Immutable<SceneViewportRedrawRequest>,
): boolean
Determines if both SceneViewportRedrawRequest instances are equal.
Parameters
- lhs: Immutable<SceneViewportRedrawRequest>
- rhs: Immutable<SceneViewportRedrawRequest>
Returns boolean