API / geotoolkit3d / scene / AnnotationBase / AnnotationBase
scene.AnnotationBase.AnnotationBase
Parent class of schematic objects
↳
AnnotationBase
Constructors
- [new AnnotationBase(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.scene-3.annotationbase.annotationbase.md#new annotationbase(options))
Methods
Constructors
• new AnnotationBase(options?)
AnnotationBase constructor
| Name | Type | Description |
|---|---|---|
Optional options | Options | The options |
Object3D.constructor
Methods
▸ add(object): AnnotationBase
Adds object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ afterRender(scene, camera, plot, renderer): AnnotationBase
This function is called after rendering and can update this object's content.<br> <br> It should not trigger any invalidateObject though.<br> Note that it is not necessary nor recommended to explicitly call afterRender on this object's children as beforeRender will be called on all nodes present in the scene.<br> <br> This will be executed after the transformations simplification.<br> <br>
See
Plot for more details on the render steps
| Name | Type | Description |
|---|---|---|
scene | Scene | The scene |
camera | Camera | The camera used for this render phase. |
plot | Plot | The 3D plot |
renderer | WebGLRenderer | The renderer |
▸ beforeRender(scene, camera, plot, renderer): AnnotationBase
This function is called prior to rendering and can update this object's content.<br> <br> It should not trigger any invalidateObject though.<br> Note that it is not necessary nor recommended to explicitly call beforeRender on this object's children as beforeRender will be called on all nodes present in the scene.<br> <br> This will be executed after the transformations simplification.<br> <br>
See
Plot for more details on the render steps
| Name | Type | Description |
|---|---|---|
scene | Scene | The scene |
camera | PerspectiveCamera | OrthographicCamera | The camera used for this render phase. |
plot | Plot | The 3D plot |
renderer | WebGLRenderer | The renderer |
▸ dispose(): void
Dispose object
void
▸ getAnchorPoint(): Vector3
Gets the point to anchor the annotation to
Vector3
anchor point
▸ getClassName(): string
string
▸ getLineStyle(): LineStyle
Return this AnnotationBase line options as a line style.
line style
▸ getMode(): Mode
Gets the display strategy for the segment origin
mode
▸ getOptions(): OptionsOut
Gets options
The options
▸ getTitle(): string
Gets the text to display
string
title
▸ getTitleDistanceFactor(): number
Gets a factor applied when computing the title position. A value greater than 1 means the title will be farther from the symbol
number
title distance factor
▸ getTitleStyle(): TextStyle
Gets text attributes
title style
▸ getVisible(): boolean
Get visible
boolean
true, if object is visible
▸ getWorldBoundingBox(target?): Box3
| Name | Type |
|---|---|
Optional target | Box3 |
Box3
▸ invalidateObject<T>(event?): AnnotationBase
Notifies this object and its parent that this object has been invalidated.<br> If this object is in a Plot, it will be marked as dirty and will trigger a rendering cycle.<br>
| Name |
|---|
T |
| Name | Type | Description |
|---|---|---|
Optional event | Event<T> | The event to fire |
▸ isBoundingBoxVisible(): boolean
boolean
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSelectable(): boolean
Return if this object can be picked/selected (see RendererPicking).<br>
boolean
▸ notify(type, source, args?): AnnotationBase
- Notify listeners. Parent nodes will also be notified if they are instances of geotoolkit3d.scene.Object3D
| Name | Type | Description |
|---|---|---|
type | string | event types |
source | any | of the event |
Optional args | any | arguments of the event |
this
▸ off(type?, callback?): AnnotationBase
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type | Description |
|---|---|---|
Optional type | string | type of the event |
Optional callback | EventListener | function to be called |
this
▸ off<E>(type, callback): AnnotationBase
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: AnnotationBase, args: EventMap[E]) => void |
▸ on(type, callback, options?): AnnotationBase
Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target. </p>
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
callback | EventListener | to be called |
Optional options | Options | options of subscription |
this
▸ on<E>(type, callback, options?): AnnotationBase
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: AnnotationBase, args: EventMap[E]) => void |
Optional options | Options |
▸ onStatsUpdated(metrics): AnnotationBase
This function is called when the plot has updated performance metric.<br> It will be called every set number of frames.<br> The number of frame is customizable in the plot options advancedrendering.performancemetrics.updateframeperiod and is 100 by default.
| Name | Type | Description |
|---|---|---|
metrics | PerformanceMetrics | The performance metrics. |
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
▸ remove(object): AnnotationBase
Removes object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[] | object |
this
▸ setAnchorPoint(anchorPoint): AnnotationBase
Sets the anchor-point of the annotation, this is needed in case of a single annotation not contained by a schematic for example.
| Name | Type | Description |
|---|---|---|
anchorPoint | Vector3 | the point to anchor the annotation to |
this
▸ setCircle(diameter, angle): AnnotationBase
Sets circle on depth of the annotation.
| Name | Type | Description |
|---|---|---|
diameter | number | Vector2 | Vector3 | diameter of circle |
angle | Euler | angle of circle |
this
▸ setLineStyle(lineStyle): AnnotationBase
Sets the segment connector attributes
| Name | Type | Description |
|---|---|---|
lineStyle | Type | line style |
this
▸ setMode(mode): AnnotationBase
Sets the display strategy for the segment origin
| Name | Type | Description |
|---|---|---|
mode | Mode | mode |
this
▸ setOptions(options?): AnnotationBase
Sets options
| Name | Type | Description |
|---|---|---|
Optional options | Options | The options |
this
▸ setOutline(outline): AnnotationBase
Set outline for title
| Name | Type | Description |
|---|---|---|
outline | OutlineOptions | the options for outline |
this
▸ setPosition(position): AnnotationBase
Set Object's local position.
| Name | Type | Description |
|---|---|---|
position | Object | local position |
Optional position.x | number | |
Optional position.y | number | |
Optional position.z | number |
this
▸ setRotation(x, y, z, order?): AnnotationBase
Set Object's local rotation (Euler angles), in radians.
| Name | Type | Description |
|---|---|---|
x | number | x angle |
y | number | y angle |
z | number | z angle |
Optional order | EulerOrder | euler order |
this
▸ setSelectable(selectable): void
Set if this object can be picked/selected (see RendererPicking).<br>
| Name | Type | Description |
|---|---|---|
selectable | boolean | if can be selected |
void
▸ setTitle(title): AnnotationBase
Sets the text to display
| Name | Type | Description |
|---|---|---|
title | string | title |
this
▸ setTitleDistanceFactor(titleDistanceFactor): AnnotationBase
Sets a factor applied when computing the title position. A value greater than 1 means the title will be farther from the symbol
| Name | Type | Description |
|---|---|---|
titleDistanceFactor | number | title distance factor |
this
▸ setTitleStyle(titleStyle, merge?): AnnotationBase
Sets text attributes
| Name | Type | Description |
|---|---|---|
titleStyle | Type | title style |
Optional merge | boolean | true if you want to merge textStyle with existing attribute, false by default |
this
▸ setVisible(visible, silent?): AnnotationBase
Set visible
| Name | Type | Description |
|---|---|---|
visible | boolean | true, if object is visible |
Optional silent | boolean | true, if object shouldn't be invalidated |
this
▸ updateObject(scene, camera): AnnotationBase
This function is called prior to rendering and can update this object's content.<br> <br> It should not trigger any invalidateObject though.<br> Note that it is not necessary nor recommended to explicitly call updateObject on this object's children as updateObject will be called on all nodes present in the scene.<br> <br> This will be executed before the transformations simplification.<br> <br>
See
Plot for more details on the render steps
| Name | Type | Description |
|---|---|---|
scene | Scene | The scene |
camera | Camera | The camera |
▸ useOwnHighlight(): boolean
Returns true if this object make its own highlight effect (like geotoolkit3d.scene.reservoir.hexahedral.ReservoirGrid) This is to prevent unnecessary executions of the costly highlight passes.
boolean
▸ Static getClassName(): string
string
▸ Static register(): void
Register object for special processing through a callback function<br>
Example
geotoolkit3d.util.ObjectProcessor.getDefaultInstance().registerObject(this.getClassName(), callback);Deprecated
since 5.0, to allow custom object highlighting, please instead make your Object implement the interface geotoolkit3d/scene/ICustomHighlight.
void