@kognifai/cogsengine
    Preparing search index...

    Class TensionRingComponent

    Component in Extension Drilling

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    endDepth extensionRadius innerRadius isTyped outerRadius splitAngle splitDistance startAngle startDepth

    Accessors

    entity name type

    Methods

    create wrap

    Constructors

    Properties

    endDepth: number

    End depth along trajectory. See TrajectoryComponent Field indexes, Measured Depth (MD)

    extensionRadius: number

    Outermost extended radius of the ring.

    innerRadius: number

    Inner radius of the tension ring.

    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    outerRadius: number

    Outer radius of the tension ring.

    splitAngle: number

    Specify at which angle in radians the ring should be split in two.

    splitDistance: number

    The distance between the two halves of the ring if it is split in two.

    startAngle: number
    startDepth: number

    Start depth along trajectory. See TrajectoryComponent Field indexes, Measured Depth (MD)

    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