@kognifai/cogsengine
    Preparing search index...

    Class HighlightRegionComponent

    Component for highlighting regions.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    alpha color debugForceVisible depthConstantBias depthSlopedFactor drawOrder id isTyped layer objectId position renderFlags rotation scale

    Accessors

    entity name type

    Methods

    create wrap

    Constructors

    Properties

    alpha: number

    Overall alpha multiplied with the per instance alpha to give effective alpha.

    color: Float32Array

    (Contents: vec4[]) Instance colors, alpha gives effect intenisty.

    debugForceVisible: boolean

    Debug option to force region to be visible regardles contents in the region, to help tracking down misplaced regions.

    depthConstantBias: number

    Pull highlight frontface slightly towards the camera with a constant.

    depthSlopedFactor: number

    Pull highlight frontface slightly towards the camera based on surface slope.

    drawOrder: number

    Draw order within a render bucke. Useful to control transparency overdraw. This value will be overriden by the material's draworder if that is nonzero.

    id: Uint32Array

    Instance ids.

    isTyped: boolean = false

    Internal flag set if component is a Cogs Core component.

    layer: RenderLayers

    Layer mask used to determine visibility for a given camera viewport. The layer mask is combined with that of the camera. The resulting value can then be combined with the result of isVisible() to form a final visibility value.

    objectId: number

    Object identifier passed to rendering commands.

    position: Float32Array

    (Contents: vec3[]) Instance positions.

    renderFlags: RenderFlags

    Render flags used to control rendering behavior.

    rotation: Float32Array

    Instance rotations.

    scale: Float32Array

    (Contents: vec3[]) Instance scale factors.

    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