Class RendererAbstract

Renderer component base class

Export

Renderer

Date

2024.1.1

Author

yisky

Hierarchy (view full)

Constructors

constructor

Properties

_awoken _bounds _boundsUpdateFlag _enabled _object3D _onAfterRender _onBeforeRender _renderOrder entity isRenderer queryMask userData

Accessors

enabled object3D position quaternion renderOrder rotation scale scene visible worldBounds

Methods

_attachToScene _destroy _detachFromScene _onAwake _onDestroy _onDisable _onEnable _updateRenderOrder _updateWorldBounds _updateWorldMatrix afterCameraRender beforeCameraRender desrtoy dispose emit getWorldDirection getWorldPosition getWorldQuaternion getWorldScale localToWorld lookAt off on once raycast setTransformation update updateWorldMatrix worldToLocal

Constructors

constructor

Properties

Protected_awoken

_awoken: boolean = false

Protected_bounds

_bounds: Box3 = ...

Protected_boundsUpdateFlag

_boundsUpdateFlag: BoolUpdateFlag

Protected_enabled

_enabled: boolean = false

Protected_object3D

_object3D: Object3D<Object3DEventMap>

Protected_onAfterRender

_onAfterRender: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

Protected_onBeforeRender

_onBeforeRender: ((renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: BufferGeometry<NormalBufferAttributes>, material: Material, group: Group<Object3DEventMap>) => void)

Protected_renderOrder

_renderOrder: RenderOrder

Readonlyentity

entity: Entity

ReadonlyisRenderer

isRenderer: boolean = true

Renderer flag

Memberof

Renderer

queryMask

queryMask: QueryMask

Query mask

Memberof

Renderer

userData

userData: {
    [key: string]: any;
}

Component user data

Memberof

Component

Accessors

enabled

  • get enabled(): boolean

  • Indicates whether the component is enabled.

    Returns boolean

    Memberof

    Component

  • set enabled(value): void

  • Set whether the component is enabled.

    Parameters

    • value: boolean

    Returns void

    Memberof

    Component

object3D

  • get object3D(): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

  • Get three.js native object3D

    Returns Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]

    Memberof

    Renderer

position

  • get position(): Vector3

  • Get local position

    Returns Vector3

    Memberof

    Renderer

  • set position(position): void

  • Set local position

    Parameters

    • position: Vector3

    Returns void

    Memberof

    Renderer

quaternion

  • get quaternion(): Quaternion

  • Get local quaternion

    Returns Quaternion

    Memberof

    Renderer

  • set quaternion(quaternion): void

  • Set local quaternion

    Parameters

    • quaternion: Quaternion

    Returns void

    Memberof

    Renderer

renderOrder

  • get renderOrder(): RenderOrder

  • Get render order

    Returns RenderOrder

    Memberof

    Renderer

  • set renderOrder(value): void

  • Set render order

    Parameters

    Returns void

    Memberof

    Renderer

rotation

  • get rotation(): Euler

  • Get local rotation

    Returns Euler

    Memberof

    Renderer

  • set rotation(rotation): void

  • Set local rotation

    Parameters

    • rotation: Euler

    Returns void

    Memberof

    Renderer

scale

  • get scale(): Vector3

  • Get local scale

    Returns Vector3

    Memberof

    Renderer

  • set scale(scale): void

  • Set local scale

    Parameters

    • scale: Vector3

    Returns void

    Memberof

    Renderer

scene

  • get scene(): Scene

  • Scene own the component

    Returns Scene

    Memberof

    Component

visible

  • set visible(value): void

  • Set whether visible

    Parameters

    • value: boolean

    Returns void

    Memberof

    Renderer

worldBounds

  • get worldBounds(): Readonly<Box3>

  • Get renderer world bounds

    Returns Readonly<Box3>

    Memberof

    Renderer

Methods

Protected_attachToScene

  • _attachToScene(): void
  • Protected

    Attach renderer to scene

    Returns void

    Memberof

    Renderer

Protected Abstract_destroy

  • _destroy(): void
  • Protected

    Destroy renderer component

    Returns void

    Memberof

    Renderer

Protected_detachFromScene

  • _detachFromScene(): void
  • Protected

    Detach renderer from scene

    Returns void

    Memberof

    Renderer

Protected_onAwake

  • _onAwake(): void
  • Protected

    Awake component callback

    Returns void

    Memberof

    Component

Protected_onDestroy

  • _onDestroy(): void
  • Protected

    Destroy callback

    Returns void

    Memberof

    Renderer

Protected_onDisable

  • _onDisable(): void
  • Protected

    Disable callback

    Returns void

    Memberof

    Renderer

Protected_onEnable

  • _onEnable(): void
  • Protected

    Enable callback

    Returns void

    Memberof

    Renderer

Protected_updateRenderOrder

  • _updateRenderOrder(): void
  • Protected

    Update renderer component render order

    Returns void

    Memberof

    Renderer

Protected_updateWorldBounds

  • _updateWorldBounds(): void
  • Protected

    Update renderer component world bounds

    Returns void

    Memberof

    Renderer

Protected_updateWorldMatrix

  • _updateWorldMatrix(): void
  • Protected

    Update renderer component world matrix

    Returns void

    Memberof

    Renderer

afterCameraRender

  • afterCameraRender(camera): void

  • After camera render

    Parameters

    Returns void

    Memberof

    Renderer

beforeCameraRender

  • beforeCameraRender(camera): void

  • Before camera render

    Parameters

    • camera: Camera

      the camera use to render

    Returns void

    Memberof

    Renderer

desrtoy

  • desrtoy(): void

  • Destroy component

    Returns void

    Memberof

    Component

dispose

  • dispose(): void

  • Clear subscribers

    Returns void

    Memberof

    EventDispatcher

emit

  • emit(event): void

  • Emit event

    Parameters

    • event: {
          type: string;
          [key: string]: any;
      }
      • [key: string]: any
      • type: string

    Returns void

    Memberof

    EventDispatcher

getWorldDirection

  • getWorldDirection(target): Vector3

  • Returns a vector representing the direction of transform's positive z-axis in world space.

    Parameters

    • target: Vector3

      The result will be copied into this Vector3.

    Returns Vector3

    Memberof

    Renderer

getWorldPosition

  • getWorldPosition(target): Vector3

  • Returns a vector representing the position of the transforms in world space.

    Parameters

    • target: Vector3

      The result will be copied into this Vector3

    Returns Vector3

    Memberof

    Renderer

getWorldQuaternion

  • getWorldQuaternion(target): Quaternion

  • Returns a quaternion representing the rotation of the transform in world space.

    Parameters

    • target: Quaternion

      The result will be copied into this Quaternion.

    Returns Quaternion

    Memberof

    Renderer

getWorldScale

  • getWorldScale(target): Vector3

  • Returns a vector of the scaling factors applied to the transform for each axis in world space.

    Parameters

    • target: Vector3

      The result will be copied into this Vector3

    Returns Vector3

    Memberof

    Renderer

localToWorld

  • localToWorld(vector): Vector3

  • Converts the vector from this object's local space to world space.

    Parameters

    • vector: Vector3

      A vector representing a position in this object's local space.

    Returns Vector3

    Memberof

    Renderer

lookAt

  • lookAt(target): void

  • Rotates the object to face a point in world space.

    Parameters

    • target: Vector3

      A vector representing a position in world space to look at.

    Returns void

    Memberof

    Renderer

off

  • off(type, callback?): void

  • Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.

    Parameters

    Returns void

    Memberof

    EventDispatcher

on

  • on(type, callback, options?): void

  • Subscribe a event

    Parameters

    • type: string

      event type

    • callback: SubscriberCallbackFn

      callback functions

    • Optionaloptions: {
          priority?: Priority;
          target?: any;
      } = {}

      options

      • Optionalpriority?: Priority
      • Optionaltarget?: any

    Returns void

    Memberof

    EventDispatcher

once

  • once(type, callback, options?): void

  • Subscribe a event, just emit once

    Parameters

    Returns void

    Memberof

    EventDispatcher

Abstractraycast

  • raycast(raycaster): Intersection<Object3D<Object3DEventMap>>

  • Raycast

    Parameters

    • raycaster: Raycaster

    Returns Intersection<Object3D<Object3DEventMap>>

    Memberof

    Renderer

setTransformation

  • setTransformation(transformation): void

  • Set renderer's transformation

    Parameters

    Returns void

    Memberof

    Renderer

update

  • update(timeSinceLastFrame, totalTime): void

  • Renderer component frame update

    Parameters

    • timeSinceLastFrame: number

      time since last frame in seconds

    • totalTime: number

      total time in seconds

    Returns void

    Memberof

    Renderer

updateWorldMatrix

  • updateWorldMatrix(): void

  • Update world matrix

    Returns void

    Memberof

    Renderer

worldToLocal

  • worldToLocal(vector): Vector3

  • Converts the vector from world space to this object's local space.

    Parameters

    • vector: Vector3

      A vector representing a position in world space.

    Returns Vector3

    Memberof

    Renderer

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods