Class: FragmentClippingExtensionPlugin
Plugins.FragmentClippingExtensionPlugin
Hierarchy
AViewerPlugin
<""
>↳
FragmentClippingExtensionPlugin
Implements
Properties
PluginType
▪ Static
Readonly
PluginType: "FragmentClippingExtensionPlugin1"
Defined in
webgi/src/plugins/FragmentClippingExtensionPlugin.ts:21
FRAGMENT_CLIPPING_EXTENSION_GLTF_EXTENSION
▪ Static
Readonly
FRAGMENT_CLIPPING_EXTENSION_GLTF_EXTENSION: "WEBGI_materials_fragment_clipping_extension"
Defined in
webgi/src/plugins/FragmentClippingExtensionPlugin.ts:314
enabled
• enabled: boolean
= true
Overrides
Defined in
webgi/src/plugins/FragmentClippingExtensionPlugin.ts:24
dependencies
• dependencies: (typeof AssetManagerPlugin
| typeof GBufferPlugin
)[]
Implementation of
Defined in
webgi/src/plugins/FragmentClippingExtensionPlugin.ts:26
materialExtension
• Readonly
materialExtension: MaterialExtension
Defined in
webgi/src/plugins/FragmentClippingExtensionPlugin.ts:58
_dirty
• Protected
_dirty: boolean
= false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:25
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:29
Methods
AddFragmentClipping
▸ Static
AddFragmentClipping(material
, position?
, params?
, mode?
, invert?
): boolean
Parameters
Name | Type |
---|---|
material | IMaterial <any > |
position? | Vector4 |
params? | Vector4 |
mode? | FragmentClippingMode |
invert? | boolean |
Returns
boolean
Defined in
webgi/src/plugins/FragmentClippingExtensionPlugin.ts:41
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:38
toJSON
▸ toJSON(meta?
): any
Parameters
Name | Type |
---|---|
meta? | any |
Returns
any
Implementation of
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:47
fromJSON
▸ fromJSON(data
, meta?
): null
| FragmentClippingExtensionPlugin
| Promise
<null
| FragmentClippingExtensionPlugin
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| FragmentClippingExtensionPlugin
| Promise
<null
| FragmentClippingExtensionPlugin
>
Implementation of
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:54
exportState
▸ exportState(): any
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:67
importState
▸ importState(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:70
storeState
▸ storeState(prefix?
, storage?
, data?
): void
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Implementation of
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:77
loadState
▸ loadState(prefix?
, storage?
): Promise
<void
>
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
Returns
Promise
<void
>
Implementation of
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:87
addEventListener
▸ addEventListener(type
, listener
): void
Adds a listener to an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
void
Implementation of
IViewerPlugin.addEventListener
Inherited from
AViewerPlugin.addEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:48
hasEventListener
▸ hasEventListener(type
, listener
): boolean
Checks if listener is added to an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
boolean
Implementation of
IViewerPlugin.hasEventListener
Inherited from
AViewerPlugin.hasEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:56
removeEventListener
▸ removeEventListener(type
, listener
): void
Removes a listener from an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
void
Implementation of
IViewerPlugin.removeEventListener
Inherited from
AViewerPlugin.removeEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:63
dispatchEvent
▸ dispatchEvent(event
): void
Fire an event type.
Parameters
Name | Type |
---|---|
event | IEvent <"" | "serialize" | "deserialize" > |
Returns
void
Implementation of
Inherited from
Defined in
webgi/src/helpers/EventDispatcher.ts:74
setDirty
▸ setDirty(): void
Returns
void
Defined in
webgi/src/plugins/FragmentClippingExtensionPlugin.ts:275
onAdded
▸ onAdded(v
): Promise
<void
>
Parameters
Name | Type |
---|---|
v | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/FragmentClippingExtensionPlugin.ts:289
onRemove
▸ onRemove(v
): Promise
<void
>
Parameters
Name | Type |
---|---|
v | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/FragmentClippingExtensionPlugin.ts:301
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:62
Accessors
dirty
• get
dirty(): boolean
Returns
boolean
Implementation of
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:18
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Implementation of
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:22
Constructors
constructor
• new FragmentClippingExtensionPlugin()