跨~界开发者中心 跨~界开发者中心
首页
  • 开发环境
  • 转换服务
  • API接口

    • 基础类
    • 工具类
    • 界面类
    • 场景类
    • 构件类
    • 标签装饰类
    • 地图实景类
    • 模型类
    • 事件类
    • 相机类
    • 脚本类
    • 几何类
  • 初版接口

    • 全局接口
    • 工具接口
    • API接口
  • 框架相关
  • 界面相关
  • 场景相关
  • 模型相关
  • 工具相关
  • 功能模块

    • 脚本接口
  • API示例

    • API示例说明
    • API示例下载
  • SDK示例

    • UIApp
    • SceneApp
    • ViewsApp
    • GeometryApp
    • ElementApp
    • ToolApp
访问新版 (opens new window)
首页
  • 开发环境
  • 转换服务
  • API接口

    • 基础类
    • 工具类
    • 界面类
    • 场景类
    • 构件类
    • 标签装饰类
    • 地图实景类
    • 模型类
    • 事件类
    • 相机类
    • 脚本类
    • 几何类
  • 初版接口

    • 全局接口
    • 工具接口
    • API接口
  • 框架相关
  • 界面相关
  • 场景相关
  • 模型相关
  • 工具相关
  • 功能模块

    • 脚本接口
  • API示例

    • API示例说明
    • API示例下载
  • SDK示例

    • UIApp
    • SceneApp
    • ViewsApp
    • GeometryApp
    • ElementApp
    • ToolApp
访问新版 (opens new window)
  • SDK接口

    • 框架相关

      • KsjSampleApp
    • 界面相关

      • UI
    • 场景相关

      • Scene
        • Camera
        • BaseDecorator
        • MapInterface
      • 模型相关

        • ElementInterface
        • ElementAttribute
      • 工具相关

        • 基础工具
      • 功能模块

        • 脚本接口

          • 脚本接口总览
          • ScriptControl
          • Action
          • CameraAction_ViewPoint
          • CameraAction_PosAndTarget
          • CameraAction_RotateTarget
          • CameraAction_Line
          • CameraAction_Line2
          • ElementMoveAction
          • ElementRotateAction
          • MovedElementRotateAction
          • ElementMoveAndRotateAction
          • ElementMoveAndScaleAction
          • ElementMoveAndRotateAndScaleAction
          • AppearanceAction_AllTransparency
          • AppearanceAction_Transparency
          • AppearanceAction_AllColor
          • AppearanceAction_Color
          • AppearanceAction_TransparencyChange
          • ClipAction_ClipOpenOne
          • ClipAction_ClipOpenMore
          • ClipAction_ClipWithLine
    目录

    Scene

    场景渲染等基础场景接口。

    来源于@ksj/bw

    # 接口

    接口 说明
    setBkColor 设置背景色。
    setRenderMode 设置渲染模式。
    getRenderMode 获取当前渲染模式。
    getBkColor 获取当前设置的背景色。
    setBkColor 设置当前背景颜色。
    clip 场景剖切。
    clearClip 清除场景剖切。
    showClipFace 创建剖切面。
    hideClipFace 不创建剖切面。
    isClipFaceShow 当前是否创建剖切面。
    isClipEditorShow 是否开启剖切面编辑。
    showClipEditor 开启剖切面编辑。
    hideClipEditor 关闭剖切面编辑。
    showGrid 显示网格线。
    hideGrid 隐藏网格线。
    isGirdShow 网格线是否显示。
    isAcsShow Acs是否显示。
    showAcs 显示Acs。
    hideAcs 隐藏Acs。
    isConstructionsShow 是否显示结构线。
    showConstructions 显示结构线。
    hideConstructions 隐藏结构线。
    isVisibleEdgesShow 是否显示可见边线。
    showVisibleEdges 显示可见边线。
    hideVisibleEdges 隐藏可见边线。
    isMonochromeShow 是否单色方式。
    showMonochrome 开启单色显示方式。
    hideMonochrome 关闭单色显示方式。
    isHiddenEdgesShow 是否显示不可见边线。
    showHiddenEdges 显示不可见边线。
    hideHiddenEdges 隐藏不可见边线。
    isAmbientOcclusionShow 是否开启环境遮蔽。
    showAmbientOcclusion 开启环境遮蔽。
    hideAmbientOcclusion 关闭环境遮蔽。
    isShadowsShow 是否显阴影。
    showShadows 开启阴影显示。
    hideShadows 关闭阴影显示。
    isBackgroundMapShow 是否显示背景地图。
    showBackgroundMap 开启背景地图。
    hideBackgroundMap 关闭背景地图。
    createMovedObj 创建可移动物件。
    clearMovedObj 清除可移动物件。
    transformMovedObj 移动可以动物体。
    moveMovedObj 移动可移动物体。
    worldToView 模型坐标转到客户区坐标。
    viewToWorld 客户区坐标转模型坐标。
    getScreenShot 获取三维场景截图。
    getSelectedElements 获取当前选中的构件。
    hasRealitiesShow 当前是否有实景显示。
    showRealities 显示实景。
    hideRealities 隐藏所有实景。
    addReality 添加实景。
    removeReality 移除实景。

    # 1. setBackColor

    设置背景颜色。

    static setBackColor( r:number, g:number, b:number )

    参数:

    r/g/b: 颜色三分量值;0--255。
    

    返回: 无。

    # 2. setRenderMode

    设置渲染模式。

    static setRenderMode( mode:string )

    参数:

    Mode:渲染模式。“实体模式”|“线框模式”|“消隐模式”|“光滑模式”。
    

    返回: 无。

    # 3. getRenderMode

    获取当前渲染模式。

    static getRenderMode():string

    参数: 无。

    返回:

    返回当前渲染模式。“实体模式”|“线框模式”|“消隐模式”|“光滑模式”

    # 4. getBkColor

    获取当前背景色。

    static getBkColor():ColorDef

    参数: 无。

    返回:

    返回当前背景颜色值。

    # 5. setBkColor

    设置当前背景颜色。

    static setBkColor( r:number, g:number, b:number )

    参数:

    r/g/b: 颜色三分量值;0--255。
    

    返回: 无。

    # 6. clip

    对场景进行剖切。

    static clip(faces: any, innerColor: RgbColor | undefined, outerColor: RgbColor | undefined)

    参数:

    faces: 剖切面的数组。每一个剖切面采用,点及法线(单位向量)的方式进行定义。{pt: Point3d, normal: Verctor3d}
    
    innerColor: 剖切保留区域的颜色。不设置则保持原来的颜色。
    
    outerColor: 场景被切除部分的显示颜色,不设置则不显示被切除部分。
    

    返回: 无。

    # 7. clearClip

    清除剖切。

    static clearClip()

    参数: 无。

    返回: 无。

    # 8. showClipFace

    创建剖切面,在剖切位置显示断面。

    static showClipFace()

    参数: 无。

    返回: 无。

    # 9. hideClipFace

    不创建剖切面,不显示剖切断面。

    static hideClipFace()

    参数: 无。

    返回: 无。

    # 10. isClipFaceShow

    是否显示剖切断面。

    static isClipFaceShow()

    参数: 无。

    返回:

    true/false。

    # 11. isClipEditorShow

    视口开启剖切面编辑。

    static isClipEditorShow()

    参数: 无。

    返回:

    true/false。

    # 12. showClipEditor

    开启剖切面编辑。

    static showClipEditor()

    参数: 无。

    返回: 无。

    # 13. hideClipEditor

    关闭剖切面编辑。

    static hideClipEditor()

    参数: 无。

    返回: 无。

    # 14. showGrid

    显示网格线。

    static showGrid()

    参数: 无。

    返回: 无。

    # 15. hideGrid

    隐藏网格线。

    static hideGrid()

    参数: 无。

    返回: 无。

    # 16. isGirdShow

    当前网格线是否显示。

    static isGirdShow():boolean

    参数: 无。

    返回:

    true/false。

    # 17. isAcsShow

    当前Acs坐标系标识是否显示。

    static isAcsShow():boolean

    参数: 无。

    返回: 无。

    # 18. showAcs

    显示Acs坐标系标识。

    static showAcs()

    参数: 无。

    返回: 无。

    # 19. hideAcs

    隐藏Acs坐标系标识。

    static hideAcs()

    参数: 无。

    返回: 无。

    # 20. isConstructionsShow

    结构线是否显示。

    static isConstructionsShow():boolean

    参数: 无。

    返回:

    true/false。。

    # 21. showConstructions

    显示结构线。

    static showConstructions()

    参数: 无。

    返回: 无。

    # 22. hideConstructions

    隐藏结构线。

    static hideConstructions()

    参数: 无。

    返回: 无。

    # 23. isVisibleEdgesShow

    可见边线是否显示。

    static isVisibleEdgesShow():boolean

    参数: 无。

    返回:

    true/false。

    # 24. showVisibleEdges

    显示可见边线。

    static showVisibleEdges()

    参数: 无。

    返回: 无。

    # 25. hideVisibleEdges

    隐藏可见边线。

    static hideVisibleEdges()

    参数: 无。

    返回: 无。

    # 26. isMonochromeShow

    是否开启单色显示。

    static isMonochromeShow():boolean

    参数: 无。

    返回:

    true/false。

    # 27. showMonochrome

    开启单色显示。

    static showMonochrome()

    参数: 无。

    返回: 无。

    # 28. hideMonochrome

    关闭单色显示。

    static hideMonochrome()

    参数: 无。

    返回: 无。

    # 29. isHiddenEdgesShow

    是否显示不可见边线。

    static isHiddenEdgesShow():boolean

    参数: 无。

    返回:

    true/false。

    # 30. showHiddenEdges

    显示不可见边线。注:可见边线不显示的情况下,不可见边线不显示。

    static hideMonochrome()

    参数: 无。

    返回: 无。

    # 31. hideHiddenEdges

    隐藏不可见边线。

    static hideHiddenEdges()

    参数: 无。

    返回: 无。

    # 32. isAmbientOcclusionShow

    是否开启环境遮蔽。

    static isAmbientOcclusionShow():boolean

    参数: 无。

    返回:

    true/false。

    # 33. showAmbientOcclusion

    开启环境遮蔽。

    static showAmbientOcclusion()

    参数: 无。

    返回: 无。

    # 34. hideAmbientOcclusion

    关闭环境遮蔽。

    static hideAmbientOcclusion()

    参数: 无。

    返回: 无。

    # 35. isShadowsShow

    是否显示阴影。

    static static isShadowsShow():boolean

    参数: 无。

    返回:

    true/false。

    # 36. showShadows

    显示阴影。

    static showShadows()

    参数: 无。

    返回: 无。

    # 37. hideShadows

    不显示阴影。

    static hideShadows()

    参数: 无。

    返回: 无。

    # 38. isBackgroundMapShow

    是否显示背景地图。

    static static isBackgroundMapShow():boolean

    参数: 无。

    返回:

    true/false。

    # 39. showBackgroundMap

    显示背景地图。

    static showBackgroundMap()

    参数: 无。

    返回: 无。

    # 40. hideBackgroundMap

    隐藏背景地图。

    static hideBackgroundMap()

    参数: 无。

    返回: 无。

    # 41. createMovedObj

    创建可移动物件。参与创建的构件将自动隐藏。

    static async createMovedObj( ids:string[] ) : Promise<TransformElementDecorator|undefined>

    参数:

    ids: 构件ID的数组。
    

    返回:

    成功则返回创建的可移动物件,否则返回undefined。

    # 42. clearMovedObj

    清除创建的可移动物件。参与创建的构件自动恢复显示。

    static async clearMovedObj( obj:TransformElementDecorator )

    参数:

    obj: 要清楚的物件。createMovedObj 返回。
    

    返回: 无。

    # 43. transformMovedObj

    对可移动物件进行转换。含位移,旋转,缩放等。

    static transformMovedObj( obj:TransformElementDecorator, transform:Transform )

    参数:

    obj: 要转换物件。createMovedObj 返回。
    
    Transform:转换矩阵。
    

    返回: 无。

    # 44. moveMovedObj

    对可移动物件进行位置变更。

    static moveMovedObj( obj:TransformElementDecorator, disX:number, disY:number, disZ:number )

    参数:

    obj: 移动的可移动物件。createMovedObj 返回。
    
    disX/disY/disZ:相对初始位置的移动三个方向的移动距离。
    

    返回: 无。

    # 45. worldToView

    模型坐标系下的坐标转换到视口客户去坐标。

    static worldToView( pt:Point3d ) : Point3d|undefined

    参数:

    pt: 要转换的模型坐标系下坐标值。
    

    返回:

    成功 返回客户区坐标(其中z值保留)。

    失败 返回 undefined。

    # 46. viewToWorld

    模型坐标系下的坐标转换到视口客户去坐标。

    static viewToWorld( pt:Point3d ) : Point3d|undefined

    参数:

    pt: 要转换的客服区坐标。
    

    返回:

    成功 返回模型坐标系下坐标值。

    失败 返回 undefined。

    # 47. getScreenShot

    获取当前客户区截图。

    static getScreenShot():any

    参数: 无。

    返回:

    成功 返回截图资源。

    失败 返回 undefined。

    示例 :

    var imgSrc = Scene.getScreenShot();
    var _img = document.createElement( "img" );
    _img.setAttribute( 'src', imgSrc );
    

    # 48. getSelectedElements

    获取当前处于选中状态的构件的ID的数组。

    static getSelectedElements():string[]

    参数: 无。

    返回:

    返回当前选中的模型构件的ID的数组。

    # 49. hasRealitiesShow

    当前是否存在显示的实景模型。

    static async hasRealitiesShow()

    参数: 无。

    返回:

    true/false。

    # 50. showRealities

    显示当前配置的实景模型。

    static async showRealities()

    参数: 无。

    返回: 无。

    # 51. hideRealities

    隐藏所有的实景模型。

    static async hideRealities()

    参数: 无。

    返回: 无。

    # 52. addReality

    添加实景模型到模型配置中。注:新添加的实景模型不会立即显示。

    static async addReality( url:string )

    参数:

    url: 实景模型的地址。
    

    返回: 无。

    # 53. removeReality

    从模型实景配置中移除一个实景。

    static async removeReality( url:string )

    参数:

    url: 实景模型的地址。
    

    返回: 无。

    # 示例

    UI
    Camera

    ← UI Camera→

    Theme by Vdoing | Copyright © 1999-2024 | 北京跨世纪软件技术有限公司 | 京ICP备2020036512号-1
    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式