Skip to content

API / geotoolkit3d / gigagrid / filter / IJKFilter / IJKFilter

Class: IJKFilter

filter.IJKFilter.IJKFilter

Child class for Filter, providing the ability to filter I/J/K range of gigagrid.

Hierarchy

Table of contents

Constructors
  • [new IJKFilter(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit3d.gigagrid.filter.ijkfilter.ijkfilter.md#new ijkfilter(options))
Methods

Contents

Constructors

new IJKFilter(options)

• new IJKFilter(options)

Constructor

Parameters

Name Type Description
optionsGigaGridResult | Optionscan be either a GigaGridResult, or a JSON option object holding the IJK ranges.

Overrides

Filter.constructor

Methods

clone

▸ clone(): IJKFilter

Get a new instance of this ijkfilter

Returns

IJKFilter

this

Overrides

Filter.clone


getChangingFlag

▸ getChangingFlag(): boolean

Get changing flag for ijkfilter

Returns

boolean

this


getClassName

▸ getClassName(): string

Returns

string

Inherited from

Filter.getClassName


getMaxI

▸ getMaxI(): number

Get the max I value of this filter.

Returns

number


getMaxJ

▸ getMaxJ(): number

Get the max J value of this filter.

Returns

number


getMaxK

▸ getMaxK(): number

Get the max K value of this filter.

Returns

number


getMinI

▸ getMinI(): number

Get the min I value of this filter.

Returns

number


getMinJ

▸ getMinJ(): number

Get the min J value of this filter.

Returns

number


getMinK

▸ getMinK(): number

Get the min K value of this filter.

Returns

number


isInside

▸ isInside(filter): boolean

Test if the input filter is inside of this filter

Parameters

Name Type Description
filterIJKFilterIJKFilter compared

Returns

boolean

true if the filter bounding box is inside


mergeIJKRangeI

▸ mergeIJKRangeI(filterIJK): void

Merge the IJK filter only on I

Parameters

Name Type Description
filterIJKObjectobject range to merge
filterIJK.maxInumber
filterIJK.minInumber

Returns

void


mergeIJKRangeJ

▸ mergeIJKRangeJ(filterIJK): void

Merge the IJK filter only on J

Parameters

Name Type Description
filterIJKObjectobject range to merge
filterIJK.maxJnumber
filterIJK.minJnumber

Returns

void


mergeIJKRangeK

▸ mergeIJKRangeK(filterIJK): void

Merge the IJK filter only on K

Parameters

Name Type Description
filterIJKObjectobject range to merge
filterIJK.maxKnumber
filterIJK.minKnumber

Returns

void


setChangingFlag

▸ setChangingFlag(flag): void

Set changing flag for ijkfilter

Parameters

Name Type Description
flagbooleanIndicate if i/j/k values have changed in current rendering

Returns

void


setMaxI

▸ setMaxI(maxI): void

Set max I for IJKFilter

Parameters

Name Type Description
maxInumberthe maximal I to set

Returns

void


setMaxJ

▸ setMaxJ(maxJ): void

Set max J for IJKFilter

Parameters

Name Type Description
maxJnumberthe maximal J to set

Returns

void


setMaxK

▸ setMaxK(maxK): void

Set max K for IJKFilter

Parameters

Name Type Description
maxKnumberthe maximal K to set

Returns

void


setMinI

▸ setMinI(minI): void

Set min I for IJKFilter

Parameters

Name Type Description
minInumberthe minimal I to set

Returns

void


setMinJ

▸ setMinJ(minJ): void

Set min J for IJKFilter

Parameters

Name Type Description
minJnumberthe minimal J to set

Returns

void


setMinK

▸ setMinK(minK): void

Set min K for IJKFilter

Parameters

Name Type Description
minKnumberthe minimal K to set

Returns

void


toBox

▸ toBox(): Box3

Return the min and max IJK as a THREE.Box3

Returns

Box3

this


toJson

▸ toJson(): Object

The filter as JSON for the exchange with the backend Should not be changed.

Returns

Object

the filter as JSON

NameType
maxInumber
maxJnumber
maxKnumber
minInumber
minJnumber
minKnumber
typeFilterstring

Overrides

Filter.toJson


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

Filter.getClassName