@kognifai/cogsengine
    Preparing search index...

    Class ReservoirSectionComponent

    Graphics for Reservoir data display. Draws full volume or a I/J/K section of the reservoir. The reservoir must be imported using SIMReservoir converter. Import settings must be Single-Directory output and No Compression.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    colormap: TextureResource

    Optional texture to override default properties colormap. 2D texture (n**2,1).

    dataRange: vec2

    A read-only property containing overall range of data for the selected property. Returns x = min, y = max.Returns invalid range min > max if data not available.

    Which section of the reservoir to show. Volume = Show all cells. ConstantI = Show all cells [index, *, ], E.g. I-Cross-section ConstantJ = Show all cells [, index, ], E.g. J-Cross-section ConstantK = Show all cells [, *, index], E.g. Layer

    Which edges of a regular cell to draw.

    index: number

    Index for Constant? direction. Range: 0..Dims[I/J/K]-1

    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    legendRange: vec2

    Range of data mapping to legend colors for the selected property. Default is invalid range, e.g.use dataRange.If user sets valid range, range must be updated if changing property

    level: number

    Rendering level. 0=Coarsest level, 1=More details, 99=Render all.

    path: string

    Directory storing the converted reservoir.

    property: string

    Reservoir property to show, "SOIL","SWAT", etc.

    timestamp: string

    Time stamp selection for dynamic properties. "YYYYMMDD" or "YYYYMMDDHHMMSS"

    Accessors

    • get entity(): Entity

      Gets the optional owning entity

      Returns Entity

    • set entity(entity: Entity): void

      Internal: set owning entity.

      Parameters

      Returns void

    • get name(): string

      Component name == type. For compatibility

      Returns string

    • get type(): string

      Gets the type of the component. Ex. "TransformComponent", "SceneComponent" etc.

      Returns string

    Methods

    • Internal: Creates a new component of the given type (name). Component is wrapped when adding to an entity.

      Parameters

      • type: string

        Type of the component. Ex. "TransformComponent"

      Returns Component

      Created Cogs.js component.

    • Internal: Creates a new component being wrapped as an existing member of the entity

      Parameters

      • type: string

        Type of the component. Ex. "TransformComponent"

      • entity: Entity

        The owning entity

      Returns Component

      Created Cogs.js component.