API / geotoolkit3d / util / ObjectProcessor / ObjectProcessor
util.ObjectProcessor.ObjectProcessor
This utility class provides a way to bind objects with a callback function.
For example, if an object is selected, it will be processed through callback function if its namespace is in processor.
Deprecated
since 5.0, to allow custom object highlighting, please instead implement the interface geotoolkit3d/scene/ICustomHighlight.
Constructors
Methods
Constructors
• new ObjectProcessor(name?, options?)
| Name | Type |
|---|---|
Optional name | string |
Optional options | WarningOptions |
Methods
▸ getClassName(): string
string
▸ getName(): string
Return name of provider
string
▸ getProperties(): Options
Return the properties of this processor
properties
▸ processObject(object): Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
Return and process the object if it has been registered in the processor
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | the object to be processed |
Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]
object
▸ registerObject(name, callback): ObjectProcessor
Register object with its class name, by binding it to a custom process callback.
| Name | Type | Description |
|---|---|---|
name | string | the class name of object |
callback | Callback | the callback that binds with |
this
▸ resetProcessor(): ObjectProcessor
Reset the processor to default state
this
▸ setName(name): ObjectProcessor
Set name
| Name | Type | Description |
|---|---|---|
name | string | name of the header provider |
this
▸ Static getClassName(): string
string
▸ Static getDefaultInstance(options?): ObjectProcessor
Return default instance of the ObjectProcessor
| Name | Type |
|---|---|
Optional options | WarningOptions |
this