Class: OutlinePlugin
Plugins.OutlinePlugin
Hierarchy
GenericExtensionPlugin<OutlineExtension>↳
OutlinePlugin
Properties
PluginType
▪ Static Readonly PluginType: "Outline"
Defined in
webgi/src/plugins/threejs/OutlinePlugin.ts:132
enabled
• enabled: boolean = true
Inherited from
GenericExtensionPlugin.enabled
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:14
dependencies
• dependencies: typeof CombinedPostPlugin[]
Inherited from
GenericExtensionPlugin.dependencies
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:16
_animationCallBack
• _animationCallBack: any
Defined in
webgi/src/plugins/threejs/OutlinePlugin.ts:136
_dirty
• Protected _dirty: boolean = false
Inherited from
GenericExtensionPlugin._dirty
Defined in
webgi/src/core/AViewerPlugin.ts:25
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
GenericExtensionPlugin._viewer
Defined in
webgi/src/core/AViewerPlugin.ts:29
_extension
• Protected Optional _extension: OutlineExtension
Inherited from
GenericExtensionPlugin._extension
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:10
Accessors
dirty
• get dirty(): boolean
Returns
boolean
Inherited from
GenericExtensionPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:18
• set dirty(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
GenericExtensionPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:22
uiConfig
• get uiConfig(): undefined | UiObjectConfig<any, string>
Returns
undefined | UiObjectConfig<any, string>
Inherited from
GenericExtensionPlugin.uiConfig
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:18
config
• get config(): undefined | T
Returns
undefined | T
Inherited from
GenericExtensionPlugin.config
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:22
Methods
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
GenericExtensionPlugin.onDispose
Defined in
webgi/src/core/AViewerPlugin.ts:38
toJSON
▸ toJSON(meta?): any
Parameters
| Name | Type |
|---|---|
meta? | any |
Returns
any
Inherited from
GenericExtensionPlugin.toJSON
Defined in
webgi/src/core/AViewerPlugin.ts:47
fromJSON
▸ fromJSON(data, meta?): null | OutlinePlugin | Promise<null | OutlinePlugin>
Parameters
| Name | Type |
|---|---|
data | any |
meta? | any |
Returns
null | OutlinePlugin | Promise<null | OutlinePlugin>
Inherited from
GenericExtensionPlugin.fromJSON
Defined in
webgi/src/core/AViewerPlugin.ts:54
addEventListener
▸ addEventListener(type, listener): void
Parameters
| Name | Type |
|---|---|
type | "" | "serialize" | "deserialize" |
listener | (event: IEvent<"" | "serialize" | "deserialize">) => void |
Returns
void
Inherited from
GenericExtensionPlugin.addEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:48
hasEventListener
▸ hasEventListener(type, listener): boolean
Parameters
| Name | Type |
|---|---|
type | "" | "serialize" | "deserialize" |
listener | (event: IEvent<"" | "serialize" | "deserialize">) => void |
Returns
boolean
Inherited from
GenericExtensionPlugin.hasEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:56
removeEventListener
▸ removeEventListener(type, listener): void
Parameters
| Name | Type |
|---|---|
type | "" | "serialize" | "deserialize" |
listener | (event: IEvent<"" | "serialize" | "deserialize">) => void |
Returns
void
Inherited from
GenericExtensionPlugin.removeEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:63
dispatchEvent
▸ dispatchEvent(event): void
Parameters
| Name | Type |
|---|---|
event | IEvent<"" | "serialize" | "deserialize"> |
Returns
void
Inherited from
GenericExtensionPlugin.dispatchEvent
Defined in
webgi/src/helpers/EventDispatcher.ts:74
disposeExtension
▸ disposeExtension(): void
Returns
void
Inherited from
GenericExtensionPlugin.disposeExtension
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:28
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
GenericExtensionPlugin.onRemove
Defined in
webgi/src/plugins/GenericExtensionPlugin.ts:38
generateExtension
▸ generateExtension(viewer): OutlineExtension
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
OutlineExtension
Overrides
GenericExtensionPlugin.generateExtension
Defined in
webgi/src/plugins/threejs/OutlinePlugin.ts:143
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Overrides
GenericExtensionPlugin.onAdded
Defined in
webgi/src/plugins/threejs/OutlinePlugin.ts:147
Constructors
constructor
• new OutlinePlugin()
Overrides
GenericExtensionPlugin<OutlineExtension\>.constructor