@kognifai/cogsengine
    Preparing search index...

    Class TrajectoryComponent

    Data component defining a 3D trajectory, for example a Well trajectory. The owning entity (typically Trajectory entity) is referred to by other components for actual drawing, like ExtrusionComponent, TrajectoryAlignedComponent, VariableExtrusionComponentTrajectoryCrossSectionsComponent, DepthAxisComponent

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    anchorStickyness indexes isTyped positions startRadialAnchor stopRadialAnchor

    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 TrajectoryComponent

    Properties

    anchorStickyness: number

    Number in [0,1) that indicates how hard the frame should try to align to the anchors.

    indexes: Float32Array

    Positive distances along trajectory. For wells Measured Depth (MD). Set same length of indexes and positions.

    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    positions: Float32Array

    (Contents: vec3[]) Trajectory positions. For wells the Z component is a measurement of True Vertical Depth (TVD). Set same length of indexes and positions.

    startRadialAnchor: vec3

    Frames should have its local Y axis in the plane spanned between the trajectory tangent and the interpolated anchor.

    stopRadialAnchor: vec3

    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