@kognifai/cogsengine
    Preparing search index...

    Class OGC3DTilesComponent

    Component in Extension OGC3DTiles

    Hierarchy (View Summary)

    Index

    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 OGC3DTilesComponent

    Properties

    accessToken: string

    Optional: Some servers requires an access-token to perform the authentication to fetch assets-info.

    additionalURLParameters: string

    Optional: Additional URL parameters which will be added to all tileset.json requests (not content or subtree requests). Each parameter must be separated by an '&'. Do not add the '?' prefix.

    assetId: number

    Optional: Some servers require an asset-id to select the correct dataset. The entire assets-mechanism will be bypassed if assetId is -1.

    baseURL: string

    The base URL for the OGC 3DTiles dataset. Must at least contain a "tileset.json" file.

    detailFactor: number

    How much details we shall fetch depending on the tile's distance to the camera. Higher -> More details.

    enableCaching: boolean

    Optional: Enable caching. The system will not release tiles outside the view-frustum unless the "QualityService" reports a drop in quality. The "quality.GPUMemTargetMB" context-variable must be set to a non-zero value. Be aware that this will increase memory usage.

    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    neverDiscardRootTiles: boolean

    Never remove visited root nodes from memory.

    overrideMaterial: MaterialInstance

    Optional: Global override-material which will be applied to all tiles. Please note that there are limits to what makes sense for a global override-material. Textures and other features which requires individual data-arrays will not work.

    showTileBBoxes: boolean

    Render overlay bbox indicators for each tile.

    waitForTileSiblings: boolean

    Do not render child-tiles until all siblings are loaded and ready. Render parent tiles while waiting. When FALSE; all leaf nodes will be rendered as soon as they are ready. This may cause temprorary "holes" in the geometry but the popping down to a lower LOD level while loading siblings will be greatly reduced. Please note that a low value of the context variable "maxNumberOfConcurrentRequests" will increase the risk of holes in the geometry. NOTE: This setting will have no effect if the tileset is of type "refinement=ADD".

    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.