@kognifai/cogsengine
    Preparing search index...

    Class PotreeComponent

    Component for Point Cloud Display. The component uses several Cogs variables to control the display. See List of COGS variables, PoTree section, for detailed information about all COGS variables available at runtime that are connected to Point Cloud.

    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 PotreeComponent

    Properties

    baseColor: vec4

    Base color to use when Base coloring strategy is used.

    boxMaterial: MaterialInstance

    Optional debug material override, material should inherit from PotreeBoxCore.material.

    clipPlanes: Float32Array

    (Contents: vec4[]) Deprecated, use clip shapes instead. Up to 6 user-defined world-space clip planes, positive half-space is kept.

    coloring: PotreeColoring

    Specify coloring strategy.

    debugBoxes: PotreeDebugBoxes

    Specify optional debug graphics.

    densityBias: number

    DistanceAndDensityScaled: Offset where depth and density starts to affectg point size calc.

    densityLevelScale: number

    DistanceAndDensityScaled: Strength of level depth in point size calc.

    densityScale: number

    DistanceAndDensityScaled: Strength of local point density in point size calc.

    disableCustomClipping: boolean

    Debug switch to disable clipping of points against custom clipping planes.

    disableCustomCulling: boolean

    Debug switch to disable culling of cells against custom clipping planes.

    disableLodUpdates: boolean

    Debug trigger to disable update of lod calculations.

    distanceCutoffMinimum: number

    Minimum value for distance-based cut-off, cut-off distance will never be less than this value. Set to negative to disable distance-based cutoff.

    distanceCutoffScale: number

    Cut off chunks that are further away than camera elevation above pointcloud z - minimum times this scale value.Default Value is 5.

    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.

    gradient: TextureResource

    Optional gradient texture to colorize scalar values.

    isTyped: boolean

    Internal flag set if component is a Cogs Core component.

    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.

    maxPointSize: number

    Maximum point size in pixels regardless of point size strategy, gets DPI scaled.

    minPointSize: number

    Minimum point size in pixels regardless of point size strategy, gets DPI scaled.

    objectId: number

    Object identifier passed to rendering commands.

    originPolicy: PotreeOriginPolicy

    Specify origin policy, see enum for details.

    outlineColor: vec3

    Color of point outlines if enabled.

    outlineSize: number

    Size of point outlines, set to 0.0 to disable point outlines.

    pointMaterial: MaterialInstance

    Optional point material override, material should inherit from PotreePointCore.material.

    pointScreenSpacing: number

    Maximal screen space distance between points before refining, gets adjusted by DPI scaling.

    pointShape: PotreePointShape

    Specify point shape.

    pointSize: number

    Base point size in pixels, gets DPI scaled.

    pointSizing: PotreePointSizing

    Specify point sizing strategy.

    renderFlags: RenderFlags

    Render flags used to control rendering behavior.

    rootNodeMinScreenSize: number

    Minimal screen-space size root node can have before being eligble for distance-based culling.

    shading: PotreeShading

    Specify optional shading.

    shadingIntensity: number

    Intensity of point shading effect, if enabled.

    source: string

    URL of path where metadata.js(OLD format: cloud.js) resides.

    supportPicking: boolean

    If true, an extra CPU side copy of the point positions are maintained to enable CPU picking.

    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.