Last updated

API / geotoolkit3d / shapes / GridIntersection2DModel / GridIntersection2DModel

Class: GridIntersection2DModel

shapes.GridIntersection2DModel.GridIntersection2DModel

Define grid and panels intersection model

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new GridIntersection2DModel(options)

new GridIntersection2DModel(options?)

Parameters

Name Type
Optional optionsOptions

Overrides

PanelsIntersection2DModel.constructor

Methods

buildIntersectionModel

Protected buildIntersectionModel(): Promise<IntersectionPanel2D[]>

Returns

Promise<IntersectionPanel2D[]>

Inherited from

PanelsIntersection2DModel.buildIntersectionModel


dispose

dispose(): void

Dispose.

Returns

void

Inherited from

PanelsIntersection2DModel.dispose


getClassName

getClassName(): string

Returns

string

Inherited from

PanelsIntersection2DModel.getClassName


getGrid

getGrid(): ReservoirGrid

Returns grid

Returns

ReservoirGrid

grid reservoir grid


getModelLimits

getModelLimits(): Rect

Return model limits

Returns

Rect

model limits

Inherited from

PanelsIntersection2DModel.getModelLimits


getOnDisposedHandler

Protected getOnDisposedHandler(): (event: string, sender: Object3D) => void

Gets onDispose event handler

Returns

fn

method to handle dispose event

▸ (event, sender): void

Gets onDispose event handler

Parameters
Name Type
eventstring
senderObject3D
Returns

void

method to handle dispose event

Inherited from

PanelsIntersection2DModel.getOnDisposedHandler


getOnPropertyChangedHandler

Protected getOnPropertyChangedHandler(): (event: string, sender: Object3D, eventArgs: any) => void

Gets onPropertyChanged event handler

Returns

fn

method to handle property changed event

▸ (event, sender, eventArgs): void

Gets onPropertyChanged event handler

Parameters
Name Type
eventstring
senderObject3D
eventArgsany
Returns

void

method to handle property changed event

Inherited from

PanelsIntersection2DModel.getOnPropertyChangedHandler


getPanels

getPanels(): Iterator<AbstractPanel>

Return iterator with panels intersected with Grid

Returns

Iterator<AbstractPanel>

iterator with panels

Inherited from

PanelsIntersection2DModel.getPanels


getProjection

getProjection(index): IntersectionPanel2D

Return 2D panel projection by specified index

Parameters

Name Type Description
indexnumberprojection index

Returns

IntersectionPanel2D

2D projection

Inherited from

PanelsIntersection2DModel.getProjection


getProjections

getProjections(): Iterator<IntersectionPanel2D>

Return iterator by projections

Returns

Iterator<IntersectionPanel2D>

iterator by projections

Inherited from

PanelsIntersection2DModel.getProjections


getProjectionsCount

getProjectionsCount(): number

Return 2D projections count

Returns

number

projections count

Inherited from

PanelsIntersection2DModel.getProjectionsCount


handleIntersectionConversion

Protected handleIntersectionConversion(result3D, plane, offset): IntersectionPanel2D

Parameters

Name Type
result3DResult
planeIOverlayableObject
offsetnumber

Returns

IntersectionPanel2D

Inherited from

PanelsIntersection2DModel.handleIntersectionConversion


hasEventListener

hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

PanelsIntersection2DModel.hasEventListener


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

PanelsIntersection2DModel.isDisposed


isSilent

isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

Returns

boolean

Inherited from

PanelsIntersection2DModel.isSilent


notify

notify(type, source, args?): GridIntersection2DModel

Notify listeners

Parameters

Name Type Description
typestringevent types
sourceanyof the event
Optional argsanyarguments of the event

Returns

GridIntersection2DModel

this

Inherited from

PanelsIntersection2DModel.notify


off

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: GridIntersection2DModel, args: EventMap[E]) => voidfunction to be called

Returns

GridIntersection2DModel

this

Inherited from

PanelsIntersection2DModel.off


on

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: GridIntersection2DModel, args: EventMap[E]) => voidto be called

Returns

GridIntersection2DModel

this

Inherited from

PanelsIntersection2DModel.on


onObjectDisposed

Protected onObjectDisposed(object): void

This method is called when one of the referenced object was disposed. Send event Events.Disposed

Parameters

Name Type Description
objectObject3Ddisposed object

Returns

void

Inherited from

PanelsIntersection2DModel.onObjectDisposed


onObjectPropertyChanged

Protected onObjectPropertyChanged(object, properties?): void

This method is called when one of the referenced object changed it properties. Send event Events.PropertyChanged

Parameters

Name Type Description
objectObject3Dchanged object
Optional propertiesstring | { name: string ; value: any }object properties

Returns

void

Inherited from

PanelsIntersection2DModel.onObjectPropertyChanged


rebuild

rebuild(): GridIntersection2DModel

Rebuild model

Returns

GridIntersection2DModel

this

Inherited from

PanelsIntersection2DModel.rebuild


setGrid

setGrid(grid): GridIntersection2DModel

Set grid to intersect with panel

Parameters

Name Type Description
gridReservoirGridreservoir grid to intersect with panel

Returns

GridIntersection2DModel

this


setPanels

setPanels(panels): GridIntersection2DModel

Set of panels to intersect with grid

Parameters

Name Type Description
panelsAbstractPanel | Iterator<AbstractPanel> | AbstractPanel[]set of panels to intersect with grid

Returns

GridIntersection2DModel

this

Inherited from

PanelsIntersection2DModel.setPanels


setSilent

setSilent(bool): GridIntersection2DModel

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

GridIntersection2DModel

this

Inherited from

PanelsIntersection2DModel.setSilent


updateTimeStamp

Protected updateTimeStamp(): GridIntersection2DModel

Update time stamp to indicate that Node or Children has been changed.

Returns

GridIntersection2DModel

this

Inherited from

PanelsIntersection2DModel.updateTimeStamp


getClassName

Static getClassName(): string

Returns

string

Inherited from

PanelsIntersection2DModel.getClassName