Class FragmentClippingExtensionPlugin

FragmentClipping Materials Extension Adds a material extension to PhysicalMaterial to add support for fragment clipping. Fragment clipping allows to clip fragments of the material in screen space or world space based on a circle, rectangle, plane, sphere, etc. It uses fixed SDFs with params defined by the user for clipping. It also adds a UI to the material to edit the settings. It uses WEBGI_materials_fragment_clipping_extension glTF extension to save the settings in glTF files.

Hierarchy (View Summary)

AViewerPluginSync<"">
- FragmentClippingExtensionPlugin

Index

Constructors

constructor

new FragmentClippingExtensionPlugin(): FragmentClippingExtensionPlugin
Returns FragmentClippingExtensionPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/material/FragmentClippingExtensionPlugin.ts:189

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<
    | "dispose"
    | "*"
    | "update"
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => void,
> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

`Readonly`materialExtension

materialExtension: MaterialExtension = ...

`Optional`uiConfig

uiConfig?: UiObjectConfig = undefined

`Static` `Readonly`FRAGMENT_CLIPPING_EXTENSION_GLTF_EXTENSION

FRAGMENT_CLIPPING_EXTENSION_GLTF_EXTENSION: "WEBGI_materials_fragment_clipping_extension" = 'WEBGI_materials_fragment_clipping_extension'

Deprecated

use - use fragmentClippingGLTFExtension

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "FragmentClippingExtensionPlugin1" = 'FragmentClippingExtensionPlugin1'

Accessors

dirty

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

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

disable

disable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

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

enable

enable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

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

fromJSON

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

importState

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

isDisabled

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

`Static`AddFragmentClipping

AddFragmentClipping(
    material: IMaterial,
    params?: {
        clipEnabled?: boolean;
        clipInvert?: boolean;
        clipMode?: FragmentClippingMode;
        clipParams?: Vector4 | Vector4Tuple;
        clipPosition?: Vector4 | Vector4Tuple;
    },
): boolean
Parameters
- material: IMaterial
- Optionalparams: {
      clipEnabled?: boolean;
      clipInvert?: boolean;
      clipMode?: FragmentClippingMode;
      clipParams?: Vector4 | Vector4Tuple;
      clipPosition?: Vector4 | Vector4Tuple;
  }
Returns boolean
- Defined in src/plugins/material/FragmentClippingExtensionPlugin.ts:38

Class FragmentClippingExtensionPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns FragmentClippingExtensionPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

enabled

ReadonlymaterialExtension

OptionaluiConfig

Static ReadonlyFRAGMENT_CLIPPING_EXTENSION_GLTF_EXTENSION

Deprecated

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

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 | FragmentClippingExtensionPlugin | Promise<null | FragmentClippingExtensionPlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

Returns void

toJSON

Parameters

Returns ISerializedConfig

StaticAddFragmentClipping

Parameters

Returns boolean

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`materialExtension

`Optional`uiConfig

`Static` `Readonly`FRAGMENT_CLIPPING_EXTENSION_GLTF_EXTENSION

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

Returns
| null
| FragmentClippingExtensionPlugin
| Promise<null | FragmentClippingExtensionPlugin>

`Static`AddFragmentClipping