Class SchematicLayer<T>

Type Parameters

Hierarchy

Constructors

constructor

Properties

_options cementPlugTextureCache cementSqueezeTextureCache cementTextureCache holeTextureCache internalLayerVisibility perforationRopeAndTextureReferences scalingFactors screenTextureCache textureSymbolCacheArray tubingTextureCache

Accessors

data element id interactive isLoading isVisible opacity options order referenceSystem

Methods

addChild clearData clearLayer createCasingRenderObject createCasingTexture createCementSqueezeShape createPerforationShape drawBigPolygon drawCasing drawCasingWindowOutline drawCementPlug drawCompletionRope drawComplexRope drawHoleRope drawHoleSize drawOutline drawRope drawSVGRope drawScreen drawShoe drawSymbolComponent drawTubing generateShoe getCementPlugTexture getCementSqueezeTexture getCementTexture getData getHoleTexture getInternalLayerIds getScreenTexture getSymbolTexture getTubingTexture getZFactorScaledPathForPoints onInteractivityChanged onMount onOpacityChanged onOrderChanged onRescale onResize onUnmount onUpdate optionsRescale preRender prepareSymbolRenderObject render renderType setContainerPosition setContainerScale setData setVisibility sortCementAndCasingRenderObjects updateStyle updateSymbolCache yRatio getOutlineClosureType

Constructors

constructor

Properties

Protected _options

_options: LayerOptions<T>

Private cementPlugTextureCache

cementPlugTextureCache: Texture<Resource>

Private cementSqueezeTextureCache

cementSqueezeTextureCache: Texture<Resource>

Private cementTextureCache

cementTextureCache: Texture<Resource>

Private holeTextureCache

holeTextureCache: Texture<Resource>

Private internalLayerVisibility

internalLayerVisibility: InternalLayerVisibility = ...

Private perforationRopeAndTextureReferences

perforationRopeAndTextureReferences: {
    rope: ComplexRope;
    texture: Texture<Resource>;
}[] = []

Protected scalingFactors

scalingFactors: ScalingFactors = ...

Private screenTextureCache

screenTextureCache: Texture<Resource>

Private textureSymbolCacheArray

textureSymbolCacheArray: {
    [key: string]: Texture;
}

Type declaration

  • [key: string]: Texture

Private tubingTextureCache

tubingTextureCache: Texture<Resource>

Accessors

data

element

  • get element(): HTMLElement

  • Returns HTMLElement

id

interactive

  • get interactive(): boolean

  • Returns boolean

  • set interactive(shouldBeInteractive: boolean): void

  • Parameters

    • shouldBeInteractive: boolean

    Returns void

isLoading

  • get isLoading(): boolean

  • Returns boolean

  • set isLoading(loading: boolean): void

  • Parameters

    • loading: boolean

    Returns void

isVisible

opacity

  • get opacity(): number

  • Returns number

  • set opacity(opacity: number): void

  • Parameters

    • opacity: number

    Returns void

options

order

  • get order(): number

  • Returns number

  • set order(order: number): void

  • Parameters

    • order: number

    Returns void

referenceSystem

Methods

addChild

clearData

  • Clears data and (optionally) the reference system

    Parameters

    • includeReferenceSystem: boolean = true

      (optional) if true also removes reference system, default is true

    Returns void

clearLayer

Private createCasingRenderObject

Private createCasingTexture

  • Parameters

    • diameter: number

    Returns Texture<Resource>

Private createCementSqueezeShape

Private createPerforationShape

Protected drawBigPolygon

  • Parameters

    • coords: IPoint[]
    • color: number = 0x000000

    Returns void

Private drawCasing

  • Parameters

    • casingRenderObject: CasingRenderObject

    Returns void

Protected drawCasingWindowOutline

  • Uses a dashed outline on one side to represent casing window The casing window should be visualized at the upper side of the wellbore path

    Parameters

    • leftPath: Point[]

      Points for line on left side

    • rightPath: Point[]
    • __namedParameters: CasingOptions
    • lineWidth: number = 1

      Width of line

    Returns void

Private drawCementPlug

Private drawCompletionRope

  • Parameters

    • path: Point[]
    • texture: Texture<Resource>
    • diameter: number

    Returns void

Private drawComplexRope

  • Returns

    Parameters

    • intervals: ComplexRopeSegment[]
    • texture: Texture<Resource>

      optionally fetch the exaggerationFactor from a different options prop options.perforationOptions for example

    Returns ComplexRope

Private drawHoleRope

  • Parameters

    • path: Point[]
    • texture: Texture<Resource>
    • maxHoleDiameter: number

    Returns void

Private drawHoleSize

Protected drawOutline

  • Parameters

    • leftPath: Point[]

      Points for line on left side

    • rightPath: Point[]

      Points for line on right side

    • lineColor: number

      Color of line

    • lineWidth: number = 1

      Width of line

    • outlineClosure: OutlineClosure = 'None'

      If line should be drawn at top and/or bottom of the paths

    • lineAlignment: number = 1

      alignment of the line to draw, (0 = inner, 0.5 = middle, 1 = outer).

    Returns void

Protected drawRope

  • Parameters

    • path: Point[]
    • texture: Texture<Resource>
    • Optional tint: number

    Returns void

Private drawSVGRope

  • Parameters

    • path: Point[]
    • texture: Texture<Resource>

    Returns void

Private drawScreen

Private drawShoe

  • Parameters

    • casingEnd: number
    • casingRadius: number

    Returns void

Private drawSymbolComponent

  • Parameters

    • __namedParameters: SymbolRenderObject

    Returns void

Private drawTubing

Private generateShoe

  • Parameters

    • casingEnd: number
    • casingRadius: number
    • length: number
    • width: number

    Returns Point[]

Private getCementPlugTexture

Private getCementSqueezeTexture

Private getCementTexture

getData

Private getHoleTexture

getInternalLayerIds

  • Some layers might be built up of several internal layers that should individually be visibility-togglable. Reasons for having multiple internal layers might be tightly related data between layers or need for sharing render context

    Returns

    list of internal layer ids

    Returns string[]

Private getScreenTexture

Private getSymbolTexture

  • Parameters

    • symbolKey: string
    • diameter: number

    Returns Texture<Resource>

Private getTubingTexture

Protected getZFactorScaledPathForPoints

  • Parameters

    • start: number
    • end: number

    Returns Point[]

onInteractivityChanged

onMount

onOpacityChanged

onOrderChanged

onRescale

onResize

onUnmount

onUpdate

optionsRescale

preRender

Private prepareSymbolRenderObject

render

renderType

Protected setContainerPosition

Protected setContainerScale

setData

setVisibility

Private sortCementAndCasingRenderObjects

  • The rendering order of these components needs to be aligned

    Returns

    ordered rendering list

    Parameters

    • casingRenderObjects: CasingRenderObject[]
    • cementRenderObject: CementRenderObject[]
    • cementSqueezes: CementSqueezeRenderObject[]

    Returns InterlacedRenderObjects[]

updateStyle

Private updateSymbolCache

  • Parameters

    • symbols: {
          [key: string]: string;
      }
      • [key: string]: string

    Returns void

Protected yRatio

  • Calculate yRatio without zFactor TODO consider to move this into ZoomPanHandler

    Returns number

Static Private getOutlineClosureType

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc