@kognifai/cogsengine
    Preparing search index...

    Class ZipComponent

    Component displaying a 3D log on a trajectory. Typical usage a Well Log on Well Trajectory.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    active axis colorMap dataSet enableFill enableOutline extrusion highlightEnd highlightStart highlightTarget isTyped rotateAxisToCamera scale useTrajectoryOrientedAxis

    Accessors

    entity name type

    Methods

    create wrap

    Constructors

    • Internal: Component constructor

      Parameters

      • type: string

        type of the component. Ex. "TransformComponent"

      • entity: Entity

        Owning entity. Entity only passed when wrapping existing entity.

      Returns ZipComponent

    Properties

    active: boolean

    Enable/disable display of log.

    axis: vec3

    Axis determining direction of 3D log (=1,0,0).

    colorMap: Entity

    Colormap entity to map Dataset values to colors.

    dataSet: Entity

    Dataset entity with log depths and values.

    enableFill: boolean

    Fill area between log curve and extrusion.

    enableOutline: boolean

    Mark outline of curve.

    extrusion: Entity

    Wellbore entity owning.

    highlightEnd: number

    End position (depth) of highlighting.

    highlightStart: number

    Start position (depth) of highlighting.

    highlightTarget: Entity

    Optional Highlighting entity.

    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    rotateAxisToCamera: boolean

    Rotate axis of 3D log when camera moves (=true). Axis = (0,1,0) is facing camera. For a horizontal well disable rotateAxisToCamera. A good axis is perpendicular to direction of horizontal part of well.

    scale: number

    Scaling of value axis (=1).

    useTrajectoryOrientedAxis: boolean

    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.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods