API / geotoolkit3d / shapes / GridIntersection2DModel / GridIntersection2DModel
shapes.GridIntersection2DModel.GridIntersection2DModel
Define grid and panels intersection model
↳
GridIntersection2DModel
Constructors
Methods
Constructors
• new GridIntersection2DModel(options?)
| Name | Type |
|---|---|
Optional options | Options |
PanelsIntersection2DModel.constructor
Methods
▸ Protected buildIntersectionModel(): Promise<IntersectionPanel2D[]>
Promise<IntersectionPanel2D[]>
PanelsIntersection2DModel.buildIntersectionModel
▸ dispose(): void
Dispose.
void
PanelsIntersection2DModel.dispose
▸ getClassName(): string
string
PanelsIntersection2DModel.getClassName
▸ getGrid(): ReservoirGrid
Returns grid
grid reservoir grid
▸ getModelLimits(): Rect
Return model limits
model limits
PanelsIntersection2DModel.getModelLimits
▸ Protected getOnDisposedHandler(): (event: string, sender: Object3D) => void
Gets onDispose event handler
fn
method to handle dispose event
▸ (event, sender): void
Gets onDispose event handler
| Name | Type |
|---|---|
event | string |
sender | Object3D |
void
method to handle dispose event
PanelsIntersection2DModel.getOnDisposedHandler
▸ Protected getOnPropertyChangedHandler(): (event: string, sender: Object3D, eventArgs: any) => void
Gets onPropertyChanged event handler
fn
method to handle property changed event
▸ (event, sender, eventArgs): void
Gets onPropertyChanged event handler
| Name | Type |
|---|---|
event | string |
sender | Object3D |
eventArgs | any |
void
method to handle property changed event
PanelsIntersection2DModel.getOnPropertyChangedHandler
▸ getPanels(): Iterator<AbstractPanel>
Return iterator with panels intersected with Grid
iterator with panels
PanelsIntersection2DModel.getPanels
▸ getProjection(index): IntersectionPanel2D
Return 2D panel projection by specified index
| Name | Type | Description |
|---|---|---|
index | number | projection index |
2D projection
PanelsIntersection2DModel.getProjection
▸ getProjections(): Iterator<IntersectionPanel2D>
Return iterator by projections
iterator by projections
PanelsIntersection2DModel.getProjections
▸ getProjectionsCount(): number
Return 2D projections count
number
projections count
PanelsIntersection2DModel.getProjectionsCount
▸ Protected handleIntersectionConversion(result3D, plane, offset): IntersectionPanel2D
| Name | Type |
|---|---|
result3D | Result |
plane | IOverlayableObject |
offset | number |
PanelsIntersection2DModel.handleIntersectionConversion
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
PanelsIntersection2DModel.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
PanelsIntersection2DModel.isDisposed
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
PanelsIntersection2DModel.isSilent
▸ notify(type, source, args?): GridIntersection2DModel
Notify listeners
| Name | Type | Description |
|---|---|---|
type | string | event types |
source | any | of the event |
Optional args | any | arguments of the event |
this
PanelsIntersection2DModel.notify
▸ off<E>(type?, callback?): GridIntersection2DModel
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 |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: GridIntersection2DModel, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): GridIntersection2DModel
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: GridIntersection2DModel, args: EventMap[E]) => void | to be called |
this
▸ Protected onObjectDisposed(object): void
This method is called when one of the referenced object was disposed. Send event Events.Disposed
| Name | Type | Description |
|---|---|---|
object | Object3D | disposed object |
void
PanelsIntersection2DModel.onObjectDisposed
▸ Protected onObjectPropertyChanged(object, properties?): void
This method is called when one of the referenced object changed it properties. Send event Events.PropertyChanged
| Name | Type | Description |
|---|---|---|
object | Object3D | changed object |
Optional properties | string | { name: string ; value: any } | object properties |
void
PanelsIntersection2DModel.onObjectPropertyChanged
▸ rebuild(): GridIntersection2DModel
Rebuild model
this
PanelsIntersection2DModel.rebuild
▸ setGrid(grid): GridIntersection2DModel
Set grid to intersect with panel
| Name | Type | Description |
|---|---|---|
grid | ReservoirGrid | reservoir grid to intersect with panel |
this
▸ setPanels(panels): GridIntersection2DModel
Set of panels to intersect with grid
| Name | Type | Description |
|---|---|---|
panels | AbstractPanel | Iterator<AbstractPanel> | AbstractPanel[] | set of panels to intersect with grid |
this
PanelsIntersection2DModel.setPanels
▸ setSilent(bool): GridIntersection2DModel
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
PanelsIntersection2DModel.setSilent
▸ Protected updateTimeStamp(): GridIntersection2DModel
Update time stamp to indicate that Node or Children has been changed.
this
PanelsIntersection2DModel.updateTimeStamp
▸ Static getClassName(): string
string