Class EntityComponentPlugin

Entity Component Framework plugin for threepipe. Allows attaching reusable components to IObject3D instances. Components can have their own serializable/runtime state, lifecycle methods, and update logic. Components are defined as classes extending Object3DComponent.

This system is not documented at the moment.

Hierarchy (View Summary)

AViewerPluginSync<EntityComponentPluginEventMap>
- EntityComponentPlugin

Constructors

constructor

new EntityComponentPlugin(running?: boolean): EntityComponentPlugin
Parameters
- running: boolean = true
Returns EntityComponentPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/extras/EntityComponentPlugin.ts:115

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected`_running

_running: boolean

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

`Readonly`componentTypes

componentTypes: Map<string, typeof Object3DComponent> = ...

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static`AddObjectUiConfig

AddObjectUiConfig: boolean = true

`Static` `Readonly`ObjectToComponents

ObjectToComponents: WeakMap<
    IObject3D<
        IObject3DEventMap,
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
        | undefined,
        IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
    >,
    Object3DComponent[],
> = ...

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "EntityComponentPlugin" = 'EntityComponentPlugin'

`Static`UserDataKey

UserDataKey: string = EntityComponentPlugin.PluginType

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

running

get running(): boolean
Returns boolean
- Defined in src/plugins/extras/EntityComponentPlugin.ts:39

Methods

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:69

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:55

addComponent

addComponent<T extends typeof Object3DComponent = typeof Object3DComponent>(
    obj: IObject3D,
    stateOrType: string | ComponentJSON | T,
    id?: string,
): { component: InstanceType<T>; redo: () => void; undo: () => void }
Add a component to an object
Type Parameters
- T extends typeof Object3DComponent = typeof Object3DComponent
Parameters
- obj: IObject3D
  Target object
- stateOrType: string | ComponentJSON | T
  Component state json or type string or component class
- Optionalid: string
  Optional component id, if not provided a random uuid will be generated
Returns { component: InstanceType<T>; redo: () => void; undo: () => void }
Undo/redo action, added component is in action.component
- Defined in src/plugins/extras/EntityComponentPlugin.ts:219

addComponentType

addComponentType(type: typeof Object3DComponent): boolean
Parameters
- type: typeof Object3DComponent
Returns boolean
- Defined in src/plugins/extras/EntityComponentPlugin.ts:121

componentsDispatch

componentsDispatch<T extends FunctionPropertyNames<Object3DComponent>>(
type: T,
...args: Parameters<NonNullable<Object3DComponent[T]>>,
): any[][]
Type Parameters
- T extends FunctionPropertyNames<Object3DComponent>
Parameters
- type: T
- ...args: Parameters<NonNullable<Object3DComponent[T]>>
Returns any[][]
- Defined in src/plugins/extras/EntityComponentPlugin.ts:70

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:35

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:60

fromJSON

fromJSON(
data: ISerializedConfig,
meta?: SerializationMetaType,
): EntityComponentPlugin | Promise<EntityComponentPlugin | null> | null
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns EntityComponentPlugin | Promise<EntityComponentPlugin | null> | null
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:47

getComponentOfType

getComponentOfType<
T extends typeof Object3DComponent = typeof Object3DComponent,
>(
type: string | T,
): InstanceType<T> | null
Get the first component of a specific type from the plugin instance
Type Parameters
- T extends typeof Object3DComponent = typeof Object3DComponent
Parameters
- type: string | T
  The component type (string or class)
Returns InstanceType<T> | null
The first component matching the specified type, or null if not found
- Defined in src/plugins/extras/EntityComponentPlugin.ts:371

getComponentsOfType

getComponentsOfType<
T extends typeof Object3DComponent = typeof Object3DComponent,
>(
type: string | T,
): InstanceType<T>[]
Get all components of a specific type from the plugin instance
Type Parameters
- T extends typeof Object3DComponent = typeof Object3DComponent
Parameters
- type: string | T
  The component type (string or class)
Returns InstanceType<T>[]
Array of components matching the specified type
- Defined in src/plugins/extras/EntityComponentPlugin.ts:359

hasComponentType

hasComponentType(type: string | typeof Object3DComponent): boolean
Parameters
- type: string | typeof Object3DComponent
Returns boolean
- Defined in src/plugins/extras/EntityComponentPlugin.ts:157

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:63

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:86

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/extras/EntityComponentPlugin.ts:163

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/extras/EntityComponentPlugin.ts:191

registerComponent

registerComponent(
    obj: IObject3D,
    state: ComponentJSON,
    id?: string,
): Object3DComponent | null
Parameters
- obj: IObject3D
- state: ComponentJSON
- Optionalid: string
Returns Object3DComponent | null
- Defined in src/plugins/extras/EntityComponentPlugin.ts:378

removeComponent

removeComponent(
    obj: IObject3D,
    id: string,
):
    | {
        redo: () => void;
        state: Record<string, any> | null | undefined;
        undo: () => void;
    }
    | undefined
Remove a component from an object
Parameters
- obj: IObject3D
- id: string
Returns
    | {
        redo: () => void;
        state: Record<string, any> | null | undefined;
        undo: () => void;
    }
    | undefined
- Defined in src/plugins/extras/EntityComponentPlugin.ts:267

removeComponentType

removeComponentType(type: typeof Object3DComponent): boolean
Parameters
- type: typeof Object3DComponent
Returns boolean
- Defined in src/plugins/extras/EntityComponentPlugin.ts:139

`Optional`setDirty

setDirty?(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:90

unregisterComponent

unregisterComponent(
comp: Object3DComponent,
): Record<string, any> | null | undefined
Parameters
- comp: Object3DComponent
Returns Record<string, any> | null | undefined
- Defined in src/plugins/extras/EntityComponentPlugin.ts:463

`Static`ComponentsDispatch

ComponentsDispatch<T extends FunctionPropertyNames<Object3DComponent>>(
    comps: Object3DComponent[],
    type: T,
    args: Parameters<NonNullable<Object3DComponent[T]>>,
): any[][]
Type Parameters
- T extends FunctionPropertyNames<Object3DComponent>
Parameters
- comps: Object3DComponent[]
- type: T
- args: Parameters<NonNullable<Object3DComponent[T]>>
Returns any[][]
- Defined in src/plugins/extras/EntityComponentPlugin.ts:94

`Static`GetComponent

GetComponent<T extends typeof Object3DComponent = typeof Object3DComponent>(
obj: IObject3D,
type: string | T,
): InstanceType<T> | null
Type Parameters
- T extends typeof Object3DComponent = typeof Object3DComponent
Parameters
- obj: IObject3D
- type: string | T
Returns InstanceType<T> | null
- Defined in src/plugins/extras/EntityComponentPlugin.ts:319

`Static`GetComponentData

GetComponentData<T extends typeof Object3DComponent = typeof Object3DComponent>(
obj: IObject3D,
type: string | T,
): { id: string } & ComponentJSON | null
Type Parameters
- T extends typeof Object3DComponent = typeof Object3DComponent
Parameters
- obj: IObject3D
- type: string | T
Returns { id: string } & ComponentJSON | null
- Defined in src/plugins/extras/EntityComponentPlugin.ts:293

`Static`GetComponentInParent

GetComponentInParent<
    T extends typeof Object3DComponent = typeof Object3DComponent,
>(
    object: IObject3D,
    type: string | T,
): InstanceType<T> | null
Type Parameters
- T extends typeof Object3DComponent = typeof Object3DComponent
Parameters
- object: IObject3D
- type: string | T
Returns InstanceType<T> | null
- Defined in src/plugins/extras/EntityComponentPlugin.ts:332

`Static`GetComponents

GetComponents<T extends typeof Object3DComponent = typeof Object3DComponent>(
obj: IObject3D,
type?: string | T,
): InstanceType<T>[]
Type Parameters
- T extends typeof Object3DComponent = typeof Object3DComponent
Parameters
- obj: IObject3D
- Optionaltype: string | T
Returns InstanceType<T>[]
- Defined in src/plugins/extras/EntityComponentPlugin.ts:308

`Static`GetComponentsInParent

GetComponentsInParent<
    T extends typeof Object3DComponent = typeof Object3DComponent,
>(
    object: IObject3D,
    type: string | T,
): InstanceType<T>[]
Type Parameters
- T extends typeof Object3DComponent = typeof Object3DComponent
Parameters
- object: IObject3D
- type: string | T
Returns InstanceType<T>[]
- Defined in src/plugins/extras/EntityComponentPlugin.ts:343

`Static`GetObjectData

GetObjectData(obj: IObject3D): Record<string, ComponentJSON> | null
Parameters
- obj: IObject3D
Returns Record<string, ComponentJSON> | null
- Defined in src/plugins/extras/EntityComponentPlugin.ts:200

`Static`ObjectDispatch

ObjectDispatch<T extends FunctionPropertyNames<Object3DComponent>>(
    object: IObject3D,
    type: T,
    ...args: Parameters<NonNullable<Object3DComponent[T]>>,
): any[][]
Type Parameters
- T extends FunctionPropertyNames<Object3DComponent>
Parameters
- object: IObject3D
- type: T
- ...args: Parameters<NonNullable<Object3DComponent[T]>>
Returns any[][]
- Defined in src/plugins/extras/EntityComponentPlugin.ts:82

Class EntityComponentPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EntityComponentPlugin

Properties

Protected_dirty

Protected_running

Protected Optional_viewer

Protected_viewerListeners

ReadonlycomponentTypes

constructor

enabled

isViewerPluginSync

OptionaluiConfig

StaticAddObjectUiConfig

Static ReadonlyObjectToComponents

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

StaticUserDataKey

Accessors

dirty

Returns boolean

Parameters

Returns void

running

Returns boolean

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

addComponent

Type Parameters

Parameters

Returns { component: InstanceType<T>; redo: () => void; undo: () => void }

addComponentType

Parameters

Returns boolean

componentsDispatch

Type Parameters

Parameters

Returns any[][]

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns EntityComponentPlugin | Promise<EntityComponentPlugin | null> | null

getComponentOfType

Type Parameters

Parameters

Returns InstanceType<T> | null

getComponentsOfType

Type Parameters

Parameters

Returns InstanceType<T>[]

hasComponentType

Parameters

Returns boolean

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

`Protected`_dirty

`Protected`_running

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`componentTypes

`Optional`uiConfig

`Static`AddObjectUiConfig

`Static` `Readonly`ObjectToComponents

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Static`UserDataKey

`Protected`_onViewerEvent

`Protected`_storeKey

Returns
| {
redo: () => void;
state: Record<string, any> | null | undefined;
undo: () => void;
}
| undefined

`Optional`setDirty

`Static`ComponentsDispatch

`Static`GetComponent

`Static`GetComponentData

`Static`GetComponentInParent

`Static`GetComponents

`Static`GetComponentsInParent

`Static`GetObjectData

`Static`ObjectDispatch