Class SSAAPlugin

SSAA Plugin

Jitters the render camera and optionally other cameras in the scene to create a super-sampled anti-aliasing effect. This is done across multiple frames by integrating with the ProgressivePlugin

Hierarchy (View Summary)

AViewerPluginSync
- SSAAPlugin

Constructors

constructor

new SSAAPlugin(rendersPerFrame?: number): SSAAPlugin
Parameters
- rendersPerFrame: number = 1
Returns SSAAPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/pipeline/SSAAPlugin.ts:45

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

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

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof ProgressivePlugin[] = ...

enabled

enabled: boolean = true

jitterLightCameras

jitterLightCameras: boolean = true

jitterOffsets

jitterOffsets: { x: number; y: number }[] = ...

jitterRenderCamera

jitterRenderCamera: boolean = true

rendersPerFrame

rendersPerFrame: number = 1

trackedJitterCameras

trackedJitterCameras: Set<[TCamera, { height: number; width: number }]> = ...

`Optional`uiConfig

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

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "SSAAPlugin" = 'SSAAPlugin'

Accessors

dirty

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

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._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 AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:75

dispose

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

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:80

exportState

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

fromJSON

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

importState

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

isDisabled

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

Class SSAAPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SSAAPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

dependencies

enabled

jitterLightCameras

jitterOffsets

jitterRenderCamera

rendersPerFrame

trackedJitterCameras

OptionaluiConfig

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

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

Returns void

toJSON

Parameters

Returns ISerializedConfig

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey