JSAPI Three API Reference
    正在准备搜索索引...

    类 Icon

    图标渲染对象，用于在地图上绘制图标标记。支持自定义图片、大小、颜色和动画效果。 主要特性：

    • 支持自定义图标图片
    • 支持固定像素大小或随图缩放
    • 支持颜色调整和透明度
    • 支持平面贴地或面向屏幕展示
    • 支持跳动动画效果
    // 创建一个基础图标
    const icon = engine.add(new mapvthree.Icon({
        mapSrc: 'path/to/icon.png',
        width: 32,
        height: 32,
        keepSize: true,
        vertexIcons: true
    }));

    // 设置数据源
    let data = mapvthree.GeoJSONDataSource.fromGeoJSON(pointData);
    data.defineAttribute('icon', 'icon');  // 如果使用 vertexIcons
    icon.dataSource = data;

    层级

    • GeoMesh
      • Icon
    索引

    构造函数

    constructor

    属性

    isGeoObject isMesh

    方法

    addAttributeRename clearAttributeRename dispose intersectsFrustum removeAttributeRename

    访问器

    clampToGround dataSource needsUpdate

    构造函数

    • 创建图标渲染对象

      参数

      • parameters: {
            animationJump?: boolean;
            clampToGround?: boolean;
            color?: string;
            flat?: boolean;
            groundTargets?: any[];
            height?: number;
            jumpHeight?: number;
            jumpSpeed?: number;
            keepSize?: boolean;
            mapSrc?: string;
            offset?: number[];
            opacity?: number;
            rotateZ?: number;
            transparent?: boolean;
            vertexColors?: boolean;
            vertexIcons?: boolean;
            width?: number;
        } = {}

        配置参数

        • 可选animationJump?: boolean

          是否启用跳动动画, 默认false

        • 可选clampToGround?: boolean

          锚点贴合三维实体表面，保留自身朝向

        • 可选color?: string

          图标颜色

        • 可选flat?: boolean

          是否采用平面朝向，不控制三维表面贴地

        • 可选groundTargets?: any[]

          接收对象根节点；省略时自动发现，空数组表示不接收

        • 可选height?: number

          图标高度, 默认12

        • 可选jumpHeight?: number

          跳动高度, 默认20

        • 可选jumpSpeed?: number

          跳动速度, 默认1

        • 可选keepSize?: boolean

          是否保持像素大小, 默认true

        • 可选mapSrc?: string

          图标图片URL

        • 可选offset?: number[]

          图标偏移量, 默认[0,0]

        • 可选opacity?: number

          整体透明度, 默认1

        • 可选rotateZ?: number

          旋转弧度(0~2π)，仅在flat为true时生效

        • 可选transparent?: boolean

          是否启用透明, 默认true

        • 可选vertexColors?: boolean

          是否通过数据携带颜色, 默认false

        • 可选vertexIcons?: boolean

          是否通过数据携带图标URL, 默认false

        • 可选width?: number

          图标宽度, 默认12

      返回 Icon

    属性

    isGeoObject: true

    类型为GeoObject的标识

    isMesh: true

    类型为Mesh的标识

    方法

    • 添加属性重命名

      参数

      • key: string

        原始属性名，该组件的属性名

      • value: string

        重命名后的属性名，数据源的属性名

      返回 void

    • 清空属性重命名

      返回 void

    • 销毁object上的geometry和material实例，释放资源, 调用engine.remove(object)会自动销毁资源，不需要手动调用

      返回 void

    • 视锥剔除测试。

      three r18x 起 WebGLRenderer 把剔除判断从 frustum.intersectsObject(object) 改成了 object.intersectsFrustum(frustum)，而 Object3D 的基类实现是空函数（返回 undefined）。 本类只是打了 isMesh 标记、并不继承 three 的 Mesh，所以必须自己实现， 否则在新版 three 下会被判定为「不在视锥内」而永远不渲染。 行为与 three 的 Mesh.intersectsFrustum 一致；Frustum.intersectsObject 在 0.179 与 0.186 中都存在，所以这份实现对两个版本都安全。

      参数

      • frustum: Frustum

        视锥

      返回 boolean

      是否与视锥相交

    • 移除属性重命名

      参数

      • key: string

        原始属性名

      返回 void

    访问器

    • get clampToGround(): boolean

      Only move the anchor; flat, rotation and pixel offsets keep their original semantics.

      返回 boolean

    • get dataSource(): DataSource

      对象连接的 DataSource 数据源。

      返回 DataSource

    • set dataSource(dataSource: DataSource): void

      设置object的数据源

      参数

      • dataSource: DataSource

        数据源

      返回 void

    • get needsUpdate(): boolean

      是否需要更新

      返回 boolean

    • set needsUpdate(value: boolean): void

      设置object是否在下一帧更新

      参数

      • value: boolean

        设置为true，则下一帧渲染前更新该object

      返回 void

    显示设置

    成员可见性

    目录

    构造函数
    属性
    方法
    访问器