API / geotoolkit3d / postprocessing / OutlinePass / OutlinePass
postprocessing.OutlinePass.OutlinePass
A outline pass that can be used in postprocessing.
This pass implements a general purpose outline effect, by rendering the shape to highlight a second time and drawing its outline using shaders.
Deprecated
since 4.1, this class is not meant to be public.
↳
OutlinePass
Constructors
Methods
Methods
▸ addSelectedObjects(object): void
Add new objects to highlight
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | objects to highlight |
void
AbstractHighlightPass.addSelectedObjects
▸ clearSelectedObjects(): void
Clears highlighted objects
void
AbstractHighlightPass.clearSelectedObjects
▸ dispose(): void
Dispose resources in this pass
void
▸ getClassName(): string
string
AbstractHighlightPass.getClassName
▸ 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>[]
AbstractHighlightPass.getObjectToHighlight
▸ Protected getSelectedObjects(): Object3D<Object3DEventMap>[]
Object3D<Object3DEventMap>[]
AbstractHighlightPass.getSelectedObjects
▸ 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
AbstractHighlightPass.isDisposed
▸ isEnabled(): boolean
Return true if this pass is enabled.
boolean
AbstractHighlightPass.isEnabled
▸ Protected removeSelectedObject(object): void
| Name | Type |
|---|---|
object | Object3D<Object3DEventMap> |
void
AbstractHighlightPass.removeSelectedObject
▸ 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): OutlinePass
| Name | Type |
|---|---|
options | OptionsBase |
AbstractHighlightPass.setOptions
▸ setSize(width, height): OutlinePass
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