@kognifai/cogsengine
    Preparing search index...

    Class RiserTelescopicJointComponent

    Component in Extension Drilling

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    armColor armInnerRadius armLength armOuterRadius connectorLength connectorRadius cylinderLength cylinderOuterRadius endDepth innerCylinderLength isTyped pistonLength pistonRadius reverse startDepth topLength

    Accessors

    entity name type

    Methods

    create wrap

    Constructors

    Properties

    armColor: vec4

    Arm color.

    armInnerRadius: number

    Inner radius of the arm.

    armLength: number

    Length of the stroke arm.

    armOuterRadius: number

    Outer radius of the arm.

    connectorLength: number

    Radius of the connectors.

    connectorRadius: number

    Length of the connectors.

    cylinderLength: number

    Length of the cylinder.

    cylinderOuterRadius: number

    Outer radius of the cylinder part.

    endDepth: number

    End depth of the component. See TrajectoryComponent Field indexes, Measured Depth (MD)

    innerCylinderLength: number

    Length of the inner cylinder (inner stroke length).

    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    pistonLength: number

    Piston length.

    pistonRadius: number

    Piston radius.

    reverse: boolean

    If the joint profile should be reversed, i.e the arm after the cylinder.

    startDepth: number

    Starting depth of the component. See TrajectoryComponent Field indexes, Measured Depth (MD)

    topLength: number

    Length of the arm tip.

    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