Class Object3DComponent

constructor

• new Object3DComponent(): Object3DComponent

  Returns Object3DComponent

constructor

ctx

enabled

ReadonlyisObject3DComponent

state

stateChangeHandlers

OptionaluiConfig

uuid

StaticComponentType

StaticStateProperties

object

• get object(): IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >

  Returns IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >

• set object(_: IObject3D): void

  Parameters

  • _: IObject3D

  Returns void

stateRef

• get stateRef(): Record<string, any>

  Returns Record<string, any>

destroy

• destroy(): Record<string, any>

  Returns Record<string, any>

init

• init(object: IObject3D, state: Record<string, any>): void

  Parameters

  • object: IObject3D
  • state: Record<string, any>

  Returns void

onStateChange

• onStateChange<
      K extends
          | "object"
          | "uuid"
          | "uiConfig"
          | "update"
          | "constructor"
          | "start"
          | "stop"
          | "destroy"
          | "state"
          | "enabled"
          | "isObject3DComponent"
          | "stateRef"
          | "setState"
          | "ctx"
          | "init"
          | "stateChangeHandlers"
          | "onStateChange",
  >(
      key: K,
      fn: (
          value: Object3DComponent[K],
          oldValue: Object3DComponent[K],
          key?: K,
      ) => void,
  ): void

  Type Parameters

  • K extends
        | "object"
        | "uuid"
        | "uiConfig"
        | "update"
        | "constructor"
        | "start"
        | "stop"
        | "destroy"
        | "state"
        | "enabled"
        | "isObject3DComponent"
        | "stateRef"
        | "setState"
        | "ctx"
        | "init"
        | "stateChangeHandlers"
        | "onStateChange"

  Parameters

  • key: K
  • fn: (value: Object3DComponent[K], oldValue: Object3DComponent[K], key?: K) => void

  Returns void

setState

• setState(state: Record<string, any>): undefined | Object3DComponent

  Parameters

  • state: Record<string, any>

  Returns undefined | Object3DComponent

start

• start(): void

  Returns void

stop

• stop(): void

  Returns void

update

• update(_e: IAnimationLoopEvent): boolean | void

  Parameters

  • _e: IAnimationLoopEvent

  Returns boolean | void