API / geotoolkit3d / postprocessing / AbstractHighlightPass / AbstractHighlightPass
postprocessing.AbstractHighlightPass.AbstractHighlightPass
Base class for highlight passes
Deprecated
since 4.1, this class is not meant to be public.
↳
AbstractHighlightPass↳↳
OutlinePass
Constructors
- [new AbstractHighlightPass()](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.postprocessing.abstracthighlightpass.abstracthighlightpass.md#new abstracthighlightpass())
Methods
Constructors
• Protected new AbstractHighlightPass()
AbstractPass.constructor
Methods
▸ addSelectedObjects(object): void
Add new objects to highlight
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | objects to highlight |
void
▸ clearSelectedObjects(): void
Clears highlighted objects
void
▸ dispose(): void
Dispose resources in this pass
void
▸ getClassName(): string
string
▸ Protected getObjectToHighlight(object): Object3D<Object3DEventMap>[]
Get the objects to be highlighted, including objects that have custom highlighting behaviors
| Name | Type |
|---|---|
object | Object3D<Object3DEventMap> |
Object3D<Object3DEventMap>[]
▸ Protected getSelectedObjects(): Object3D<Object3DEventMap>[]
Object3D<Object3DEventMap>[]
▸ getType(): string
Get the type of the class
Deprecated
since 4.1. Use getClassName() instead.
string
▸ isDisposed(): boolean
Return whether this pass has been disposed or not.
boolean
▸ isEnabled(): boolean
Return true if this pass is enabled.
boolean
▸ Protected removeSelectedObject(object): void
| Name | Type |
|---|---|
object | Object3D<Object3DEventMap> |
void
▸ Abstract render(renderer, writeBuffer?, readBuffer?, deltaTime?, maskActive?): void
This render function will be called every time in animation loop
| Name | Type | Description |
|---|---|---|
renderer | WebGLRenderer | the webGLrender |
Optional writeBuffer | WebGLRenderTarget<Texture> | the WebGL render target to write |
Optional readBuffer | WebGLRenderTarget<Texture> | the WebGL render target to read |
Optional deltaTime | number | delta time |
Optional maskActive | boolean | the flag for stencil buffer in renderer |
void
▸ setOptions(options?): AbstractHighlightPass
| Name | Type |
|---|---|
Optional options | AnyRecord |
▸ Abstract setSize(width, height): AbstractHighlightPass
Set size for render target
| Name | Type | Description |
|---|---|---|
width | number | the width of render target |
height | number | the height of render target |
▸ Static getClassName(): string
string