@kognifai/cogsengine
    Preparing search index...

    Class HeightMapComponent

    Holds a regular 2D grid of sampled scalar values.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    colorMap dataSet gridLineOffset gridLines height isoLine isoLineDistance isoLineOrigin isTyped maxValue minValue textureDomain xIncrement yIncrement

    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 HeightMapComponent

    Properties

    colorMap: Entity

    Color map used to colorize values from the dataset.

    dataSet: Entity

    Underlying 2D scalar dataset.

    gridLineOffset: vec3

    Offset of grid lines relative to surface.

    gridLines: boolean

    Enable rendering of grid lines.

    height: number

    Height of maximum value.

    isoLine: IsoLine

    Enable iso-line rendering.

    isoLineDistance: number

    Distance between consecutive iso-lines, set to NaN to use default value.

    isoLineOrigin: number

    Value of zero'th iso-line, set to NaN to use current minimum value.

    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    maxValue: number

    Explicitly set maximum value, set to NaN to use dataset's maximum value.

    minValue: number

    Explicitly set minimum value, set to NaN to use dataset's minimum value.

    textureDomain: TextureDomain

    Specify how the texture coordinates of the points in the mesh are computed.

    xIncrement: number

    Grid line separation along x axis.

    yIncrement: number

    Grid line separation along y axis.

    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