Class MeshOptSimplifyModifierPlugin

Simplify modifier using meshoptimizer library. Loads the library at runtime from a customisable cdn url.

Hierarchy (View Summary)

SimplifyModifierPlugin
- MeshOptSimplifyModifierPlugin

Constructors

constructor

new MeshOptSimplifyModifierPlugin(
initialize?: boolean,
rootNode?: HTMLHeadElement,
): MeshOptSimplifyModifierPlugin
Parameters
- initialize: boolean = true
- rootNode: HTMLHeadElement = document.head
Returns MeshOptSimplifyModifierPlugin
Overrides SimplifyModifierPlugin.constructor
- Defined in src/plugins/extras/MeshOptSimplifyModifierPlugin.ts:16

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_initializing

_initializing?: Promise<void> = undefined

`Protected` `Optional`_script

_script?: HTMLScriptElement

enabled

enabled: boolean = true

errorThreshold

errorThreshold: number = 0.5

lockBorder

lockBorder: boolean = false

`Readonly`rootNode

rootNode: HTMLHeadElement = document.head

simplifyFactor

simplifyFactor: number = 0.5

Factor of vertices to remove. eg 0.5 will remove half of the vertices. Default is 0.5 This is used when no factor or count is provided in the options to simplifyGeometry or simplifyGeometries.

toJSON

toJSON: any = undefined

`Optional`uiConfig

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

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "MeshOptSimplifyModifierPlugin" = 'MeshOptSimplifyModifierPlugin'

`Static`SIMPLIFIER_URL

SIMPLIFIER_URL: string = 'https://unpkg.com/[email protected]/meshopt_simplifier.module.js'

Path to the meshopt simplifier library, default uses unpkg cdn

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from SimplifyModifierPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:112
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from SimplifyModifierPlugin.dirty
- Defined in src/viewer/AViewerPlugin.ts:116

initialized

get initialized(): boolean
Returns boolean
Overrides SimplifyModifierPlugin.initialized
- Defined in src/plugins/extras/MeshOptSimplifyModifierPlugin.ts:22

Methods

`Protected`_onViewerEvent

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

`Protected`_simplify

_simplify(geometry: BufferGeometry, count: number): IGeometry
Sample for three.js addons SimplifyModifier: import {SimplifyModifier} from 'three/examples/jsm/modifiers/SimplifyModifier' protected _simplify(geometry: IGeometry, count: number): IGeometry { const modifier = new SimplifyModifier() return modifier.modify(geometry, count) as IGeometry }
Parameters
- geometry: BufferGeometry
- count: number
Returns IGeometry
Overrides SimplifyModifierPlugin._simplify
- Defined in src/plugins/extras/MeshOptSimplifyModifierPlugin.ts:73

`Protected`_storeKey

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

disable

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

dispose

dispose(): void
Returns void
Overrides SimplifyModifierPlugin.dispose
- Defined in src/plugins/extras/MeshOptSimplifyModifierPlugin.ts:60

enable

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

exportState

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

fromJSON

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

importState

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

initialize

initialize(): Promise<void>
Returns Promise<void>
Overrides SimplifyModifierPlugin.initialize
- Defined in src/plugins/extras/MeshOptSimplifyModifierPlugin.ts:39

isDisabled

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

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides SimplifyModifierPlugin.onAdded
- Defined in src/plugins/extras/MeshOptSimplifyModifierPlugin.ts:32

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Inherited from SimplifyModifierPlugin.onRemove
- Defined in src/viewer/AViewerPlugin.ts:150

`Optional`setDirty

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

simplifyAll

simplifyAll(
    root?: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >,
    options?: SimplifyOptions,
): Promise<
    undefined
    | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>[],
>
Parameters
- Optionalroot: IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >
- Optionaloptions: SimplifyOptions
Returns Promise<undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>[]>
Inherited from SimplifyModifierPlugin.simplifyAll
- Defined in src/plugins/extras/SimplifyModifierPlugin.ts:154

simplifyGeometries

simplifyGeometries(
    geometry?: ValOrArr<
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    >,
    options?: SimplifyOptions,
): undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>[]
Parameters
- Optionalgeometry: ValOrArr<IGeometry<NormalBufferAttributes, BufferGeometryEventMap>>
- Optionaloptions: SimplifyOptions
Returns undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>[]
Inherited from SimplifyModifierPlugin.simplifyGeometries
- Defined in src/plugins/extras/SimplifyModifierPlugin.ts:62

simplifyGeometry

simplifyGeometry(
geometry?: IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
__namedParameters?: SimplifyOptions,
): undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
Parameters
- Optionalgeometry: IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
- __namedParameters: SimplifyOptions = {}
Returns undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
Inherited from SimplifyModifierPlugin.simplifyGeometry
- Defined in src/plugins/extras/SimplifyModifierPlugin.ts:81

simplifySelected

simplifySelected(): Promise<void>
Returns Promise<void>
Inherited from SimplifyModifierPlugin.simplifySelected
- Defined in src/plugins/extras/SimplifyModifierPlugin.ts:179

Class MeshOptSimplifyModifierPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MeshOptSimplifyModifierPlugin

Properties

Protected_dirty

Protected Optional_initializing

Protected Optional_script

Protected Optional_viewer

Protected_viewerListeners

constructor

enabled

errorThreshold

lockBorder

ReadonlyrootNode

simplifyFactor

toJSON

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

StaticSIMPLIFIER_URL

Accessors

dirty

Returns boolean

Parameters

Returns void

initialized

Returns boolean

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_simplify

Parameters

Returns IGeometry

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns | null | MeshOptSimplifyModifierPlugin | Promise<null | MeshOptSimplifyModifierPlugin>

importState

Parameters

Returns Promise<void>

initialize

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

simplifyAll

Parameters

Returns Promise<undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>[]>

simplifyGeometries

Parameters

Returns undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>[]

`Protected`_dirty

`Protected` `Optional`_initializing

`Protected` `Optional`_script

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`rootNode

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Static`SIMPLIFIER_URL

`Protected`_onViewerEvent

`Protected`_simplify

`Protected`_storeKey

Returns
| null
| MeshOptSimplifyModifierPlugin
| Promise<null | MeshOptSimplifyModifierPlugin>

`Optional`setDirty