Cesium JS API
AppearanceArcGisMapServerImageryProviderArcGISTiledElevationTerrainProviderArcTypeAssociativeArrayAxisAxisAlignedBoundingBoxbarycentricCoordinatesBillboardBillboardCollectionBillboardGraphicsBillboardVisualizerbinarySearchbinarySearchComparatorBingMapsGeocoderServiceBingMapsImageryProviderBingMapsStyleBlendEquationBlendFunctionBlendingStateBlendOptionBoundingRectangleBoundingSphereBoxEmitterBoxGeometryBoxGeometryUpdaterBoxGraphicsBoxOutlineGeometrybuildModuleUrlCallbackPropertyCameraCameraEventAggregatorCameraEventTypeCartesian2Cartesian3Cartesian4CartographicCartographicGeocoderServiceCatmullRomSplineCesium3DTileCesium3DTileColorBlendModeCesium3DTileContentCesium3DTileFeatureCesium3DTilePointFeatureCesium3DTilesetCesium3DTilesetGraphicsCesium3DTilesetVisualizerCesium3DTileStyleCesium3DTilesVoxelProviderCesiumTerrainProviderCesiumWidgetCheckerboardMaterialPropertyCircleEmitterCircleGeometryCircleOutlineGeometryClassificationPrimitiveClassificationTypeClippingPlaneClippingPlaneCollectionClockClockRangeClockStepcloneCloudCollectionCloudTypeColorColorBlendModeColorGeometryInstanceAttributeColorMaterialPropertycombineComponentDatatypeCompositeEntityCollectionCompositeMaterialPropertyCompositePositionPropertyCompositePropertyCompressedTextureBufferConditionsExpressionConeEmitterConstantPositionPropertyConstantPropertyConstantSplineContextOptionsCoplanarPolygonGeometryCoplanarPolygonOutlineGeometryCornerTypeCorridorGeometryCorridorGeometryUpdaterCorridorGraphicsCorridorOutlineGeometrycreateElevationBandMaterialcreateElevationBandMaterialBandcreateElevationBandMaterialEntrycreateGuidcreateOsmBuildingscreateTangentSpaceDebugPrimitivecreateWorldImagerycreateWorldTerrainCreditCreditDisplayCubicRealPolynomialCullFaceCullingVolumeCumulusCloudCustomDataSourceCustomHeightmapTerrainProviderCustomShaderCustomShaderModeCustomShaderTranslucencyModeCylinderGeometryCylinderGeometryUpdaterCylinderGraphicsCylinderOutlineGeometryCzmlDataSourceDataSourceDataSourceClockDataSourceCollectionDataSourceDisplayDebugAppearanceDebugCameraPrimitiveDebugModelMatrixPrimitiveDefaultProxydefaultValuedefinedDepthFunctiondestroyObjectDeveloperErrorDirectionalLightDirectionUpDiscardEmptyTileImagePolicyDiscardMissingTileImagePolicyDistanceDisplayConditionDistanceDisplayConditionGeometryInstanceAttributeEasingFunctionEllipseGeometryEllipseGeometryUpdaterEllipseGraphicsEllipseOutlineGeometryEllipsoidEllipsoidGeodesicEllipsoidGeometryEllipsoidGeometryUpdaterEllipsoidGraphicsEllipsoidOutlineGeometryEllipsoidRhumbLineEllipsoidSurfaceAppearanceEllipsoidTangentPlaneEllipsoidTerrainProviderEntityEntityClusterEntityCollectionEntityViewEventEventHelperexcludesReverseAxisexportKmlexportKmlModelCallbackexportKmlResultKmlexportKmlResultKmzExpressionExtrapolationTypeFeatureDetectionFogformatErrorFrameRateMonitorFrustumGeometryFrustumOutlineGeometryFullscreenGeocoderServiceGeocodeTypeGeographicProjectionGeographicTilingSchemeGeoJsonDataSourceGeometryGeometryAttributeGeometryAttributesGeometryFactoryGeometryInstanceGeometryInstanceAttributeGeometryPipelineGeometryUpdaterGeometryVisualizergetAbsoluteUrigetBaseUrigetExtensionFromUriGetFeatureInfoFormatgetFilenameFromUrigetImagePixelsgetTimestampGlobeGlobeTranslucencyGoogleEarthEnterpriseImageryProviderGoogleEarthEnterpriseMapsProviderGoogleEarthEnterpriseMetadataGoogleEarthEnterpriseTerrainDataGoogleEarthEnterpriseTerrainProviderGpxDataSourceGregorianDateGridImageryProviderGridMaterialPropertyGroundGeometryUpdaterGroundPolylineGeometryGroundPolylinePrimitiveGroundPrimitiveHeadingPitchRangeHeadingPitchRollHeadingPitchRollValuesHeightmapEncodingHeightmapTerrainDataHeightReferenceHermitePolynomialApproximationHermiteSplineHilbertOrderHorizontalOriginI3SDataProviderI3SFeatureI3SFieldI3SGeometryI3SLayerI3SNodeImageBasedLightingImageMaterialPropertyImageryLayerImageryLayerCollectionImageryLayerFeatureInfoImageryProviderImageryTypesincludesReverseAxisIndexDatatypeIntersectIntersections2DIntersectionTestsIntervalIonIonGeocoderServiceIonImageryProviderIonResourceIonWorldImageryStyleisLeapYearIso8601JulianDateKeyboardEventModifierKmlCameraKmlDataSourceKmlFeatureDataKmlLookAtKmlTourKmlTourFlyToKmlTourWaitLabelLabelCollectionLabelGraphicsLabelStyleLabelVisualizerLagrangePolynomialApproximationLeapSecondLightLightingModelLinearApproximationLinearSplineMapboxImageryProviderMapboxStyleImageryProviderMapMode2DMapProjectionMaterialMaterialAppearanceMaterialSupportMaterialPropertyMathMatrix2Matrix3Matrix4mergeSortmergeSortComparatorMetadataClassMetadataClassPropertyMetadataComponentTypeMetadataEnumMetadataEnumValueMetadataSchemaMetadataTypeModelModelAnimationModelAnimationCollectionModelAnimationLoopModelFeatureModelGraphicsModelNodeModelVisualizerMoonMorphWeightSplineNearFarScalarNeverTileDiscardPolicyNodeTransformationPropertyobjectToQueryOccluderOpenCageGeocoderServiceOpenStreetMapImageryProviderOrientedBoundingBoxOrthographicFrustumOrthographicOffCenterFrustumPackableForInterpolationParticleParticleBurstParticleEmitterParticleSystemPathGraphicsPathVisualizerPeliasGeocoderServicePerInstanceColorAppearancePerspectiveFrustumPerspectiveOffCenterFrustumPinBuilderPixelDatatypePixelFormatPlanePlaneGeometryPlaneGeometryUpdaterPlaneGraphicsPlaneOutlineGeometryPointCloudShadingPointGraphicspointInsideTrianglePointPrimitivePointPrimitiveCollectionPointVisualizerPolygonGeometryPolygonGeometryUpdaterPolygonGraphicsPolygonHierarchyPolygonOutlineGeometryPolylinePolylineArrowMaterialPropertyPolylineCollectionPolylineColorAppearancePolylineDashMaterialPropertyPolylineGeometryPolylineGeometryUpdaterPolylineGlowMaterialPropertyPolylineGraphicsPolylineMaterialAppearancePolylineOutlineMaterialPropertyPolylineVisualizerPolylineVolumeGeometryPolylineVolumeGeometryUpdaterPolylineVolumeGraphicsPolylineVolumeOutlineGeometryPositionPropertyPositionPropertyArrayPostProcessStagePostProcessStageCollectionPostProcessStageCompositePostProcessStageLibraryPostProcessStageSampleModePrimitivePrimitiveCollectionPrimitiveTypePropertyPropertyArrayPropertyBagProxyQuadraticRealPolynomialQuantizedMeshTerrainDataQuarticRealPolynomialQuaternionQuaternionSplinequeryToObjectQueueRayreadyPromiseRectangleRectangleGeometryRectangleGeometryUpdaterRectangleGraphicsRectangleOutlineGeometryReferenceFrameReferencePropertyremoveExtensionRequestRequestErrorEventRequestSchedulerRequestStateRequestTypeResourceRuntimeErrorSampledPositionPropertySampledPropertysampleTerrainsampleTerrainMostDetailedSceneSceneModeSceneTransformsScreenSpaceCameraControllerScreenSpaceEventHandlerScreenSpaceEventTypeshaderDefinesshaderMaximumIntersectionsLengthshaderUniformsShadowMapShadowModeShowGeometryInstanceAttributeSimon1994PlanetaryPositionsSimplePolylineGeometrySingleTileImageryProviderSkyAtmosphereSkyBoxSphereEmitterSphereGeometrySphereOutlineGeometrySphericalSplineSplitDirectionStencilFunctionStencilOperationSteppedSplineStripeMaterialPropertyStripeOrientationStyleExpressionsubdivideArraySunSunLightTaskProcessorTerrainDataTerrainProviderTextureMagnificationFilterTextureMinificationFilterTextureUniformTileAvailabilityTileCoordinatesImageryProviderTileDiscardPolicyTileMapServiceImageryProviderTileProviderErrorTilingSchemeTimeDynamicImageryTimeDynamicPointCloudTimeIntervalTimeIntervalCollectionTimeIntervalCollectionPositionPropertyTimeIntervalCollectionPropertyTimeStandardTransformsTranslationRotationScaleTridiagonalSystemSolverTrustedServersUniformSpecifierUniformTypeUrlTemplateImageryProviderVaryingTypeVelocityOrientationPropertyVelocityVectorPropertyVertexFormatVerticalOriginVideoSynchronizerViewportQuadVisibilityVisualizerVoxelPrimitiveVoxelProviderVoxelShapeTypeVRTheWorldTerrainProviderWallGeometryWallGeometryUpdaterWallGraphicsWallOutlineGeometryWebGLConstantsWebGLOptionsWebMapServiceImageryProviderWebMapTileServiceImageryProviderWebMercatorProjectionWebMercatorTilingSchemeWindingOrderwriteTextToCanvasAnimationAnimationViewModelBaseLayerPickerBaseLayerPickerViewModelCesium3DTilesInspectorCesium3DTilesInspectorViewModelCesiumInspectorCesiumInspectorViewModelClockViewModelCommandcreateCommandFullscreenButtonFullscreenButtonViewModelGeocoderGeocoderViewModelHomeButtonHomeButtonViewModelInfoBoxInfoBoxViewModelNavigationHelpButtonNavigationHelpButtonViewModelPerformanceWatchdogPerformanceWatchdogViewModelProjectionPickerProjectionPickerViewModelProviderViewModelSceneModePickerSceneModePickerViewModelSelectionIndicatorSelectionIndicatorViewModelSvgPathBindingHandlerTimelineToggleButtonViewModelViewerviewerCesium3DTilesInspectorMixinviewerCesiumInspectorMixinviewerDragDropMixinviewerPerformanceWatchdogMixinviewerVoxelInspectorMixinVoxelInspectorVoxelInspectorViewModelVRButtonVRButtonViewModel

Model

Model 类型代表地球上的一个可见对象,通常是一个3D模型或一个地面贴图。

构造函数

new Cesium.Model({
    id : id,                            // 可选的字符串
    uri : uri,                          // 必需的字符串
    allowPicking : allowPicking,        // 可选的布尔值,默认为 true
    asynchronous : asynchronous,        // 可选的布尔值,默认为 true
    basePath : basePath,                // 可选的字符串
    clampAnimations : clampAnimations,  // 可选的布尔值,默认为 false
    debugShowBoundingVolume : debugShowBoundingVolume,  // 可选的布尔值,默认为 false
    debugWireframe : debugWireframe,    // 可选的布尔值,默认为 false
    scale : scale,                      // 可选的数字,默认为 1.0
    minimumPixelSize : minimumPixelSize,// 可选的数字,默认为 0.0
    maximumScale : maximumScale,        // 可选的数字,默认为无限大
    distanceDisplayCondition : distanceDisplayCondition,  // 可选的 DistanceDisplayCondition 对象
    modelMatrix : modelMatrix,          // 可选的 Matrix4 对象,默认为 IDENTIY
    color : color,                      // 可选的颜色对象,默认为白色
    colorBlendMode : colorBlendMode,    // 可选的 ColorBlendMode 枚举值,默认为 HIGHLIGHT
    colorBlendAmount : colorBlendAmount,// 可选的数字,范围在 [0, 1] 之间,默认为 0.5
    silhouetteColor : silhouetteColor,  // 可选的颜色对象,默认为黑色
    silhouetteSize : silhouetteSize,    // 可选的数字,默认为 0.0
    shadeless : shadeless,              // 可选的布尔值,默认为 false
    lightColor : lightColor,            // 可选的颜色对象,默认为白色
    luminosityAtZenith : luminosityAtZenith,  // 可选的数字,默认为 1.0
    specularEnvironmentMaps : specularEnvironmentMaps,  // 可选的布尔值,默认为 false
    backFaceCulling : backFaceCulling,  // 可选的布尔值,默认为 true
    castShadows : castShadows,          // 可选的布尔值,默认为 true
    receiveShadows : receiveShadows,    // 可选的布尔值,默认为 true
    shadows : shadows                   // 可选的 ShadowMode 枚举值,默认为 ENABLED
});

参数

  • id 可选的字符串(默认值:undefined):标识符用于查询相关的属性。
  • uri 必需的字符串:模型的地址,可以是本地文件或远程文件。
  • allowPicking 可选的布尔值(默认值:true):确定模型是否应响应输入事件。
  • asynchronous 可选的布尔值(默认值:true):确定模型文件是否应异步加载。
  • basePath 可选的字符串(默认值:undefined):用于解决模型文件中引用的任何相对路径的基本 URL。
  • clampAnimations 可选的布尔值(默认值:false):确定动画是否应该被限制为 minimumPixelSize 以下的实体。
  • debugShowBoundingVolume 可选的布尔值(默认值:false):确定模型边界是否应该被渲染。
  • debugWireframe 可选的布尔值(默认值:false):确定模型是否应该以线框形式渲染。
  • scale 可选的数字(默认值:1.0):确定模型对象的缩放比例。
  • minimumPixelSize 可选的数字(默认值:0.0):以屏幕像素为单位的最小尺寸,如果小于此尺寸,则使用 pixelSize 属性代替。
  • maximumScale 可选的数字(默认值:无限大):确定模型对象的最大缩放比例。
  • distanceDisplayCondition 可选的 DistanceDisplayCondition 对象(默认值:undefined):如果定义,该实体仅在距相机视野范围以内时可见。
  • modelMatrix 可选的 Matrix4 对象(默认值:单位矩阵 IDENTITY):确定模型对象的空间变换。
  • color 可选的颜色对象(默认值:白色):亮度将应用于模型的每个部分。
  • colorBlendMode 可选的 ColorBlendMode 枚举值(默认值:ColorBlendMode.HIGHLIGHT):确定如何混合模型颜色和其他颜色(如 primitive.show)。
  • colorBlendAmount 可选的数字(默认值:0.5):指定模型对象的颜色混合量,范围在 [0, 1] 之间。
  • silhouetteColor 可选的颜色对象(默认值:黑色):指定边框颜色。
  • silhouetteSize 可选的数字(默认值:0.0):以屏幕像素为单位指定边框的大小。
  • shadeless 可选的布尔值(默认值:false):确定模型是否应渲染为单色,不考虑光照。
  • lightColor 可选的颜色对象(默认值:白色):指定模型的全局光颜色。
  • luminosityAtZenith 可选的数字(默认值:1.0):指定与相机朝向完全相反的方向的表面亮度。
  • specularEnvironmentMaps 可选的布尔值(默认值:false):确定材质是否使用镜面反射。注意:默认情况下,只有当 shadows 属性设置为 "CAST_ONLY" 此选项才会生效。
  • backFaceCulling 可选的布尔值(默认值:true):确定是否剔除后向面。
  • castShadows 可选的布尔值(默认值:true):确定模型是否应该投射阴影。
  • receiveShadows 可选的布尔值(默认值:true):确定模型是否应该接收阴影。
  • shadows 可选的 ShadowMode 枚举值(默认值:ShadowMode.ENABLED):确定阴影是已启用,已禁用还是仅投射。

方法

update()

每帧更新实体的位置、姿态以及其他变换。

isDestroyed() → Boolean

确定实体是否已经被销毁。

destroy()

销毁该实体。 这一步操作无法撤消并同时也会销毁其包含的 webgl 上下文等资源,因此请考虑使用 Cesium3DTilesettileset.unloadTile(tile)Cesium.ModelCesium.ModelCollection 中的 modelCollection.remove(model),或者如 DataSourceCollectiondataSourceCollection.destroy() 等逐步销毁资源的方法。

属性

allowPicking

可选的布尔值(默认值:true):确定模型是否应响应输入事件。

asynchronous

可选的布尔值(默认值:true):确定模型文件是否应异步加载。

basePath

可选的字符串(默认值:undefined):用于解决模型文件中引用的任何相对路径的基本 URL。

boundingSphere

用于确定拒绝测试优化的模型的常量包围球。

cesiumAnimations

模型上定义的所有动画名称的字符串数组。

color

可选的颜色对象(默认值:白色):亮度将应用于模型的每个部分。

colorBlendAmount

可选的数字(默认值:0.5):指定模型对象的颜色混合量,范围在 [0, 1] 之间。

colorBlendMode

可选的 ColorBlendMode 枚举值(默认值:ColorBlendMode.HIGHLIGHT):确定如何混合模型颜色和其他颜色(如 primitive.show)。

credit

实体的信用数据类,包含来源和版权信息。

debugShowBoundingVolume

可选的布尔值(默认值:false):确定模型边界是否应该被 Render。

debugWireframe

可选的布尔值(默认值:false):确定模型是否应该以线框形式渲染。

distanceDisplayCondition

可选的 DistanceDisplayCondition 对象(默认值:undefined):如果定义,该实体仅在距相机视野范围以内时可见。

id

可选的字符串(默认值:undefined):标识符用于查询相关的属性。

isDestroyed

只读的布尔值,指示实体是否已经被销毁。

maximumScale

可选的数字(默认值:无限大):确定模型对象的最大缩放比例。

mesh

枚举对象,用于确定发布的模型数据如何呈现。

minimumPixelSize

可选的数字(默认值:0.0):以屏幕像素为单位的最小尺寸,如果小于此尺寸,则使用 pixelSize 属性代替。

modelMatrix

可选的 Matrix4 对象(默认值:单位矩阵 IDENTITY):确定模型对象的空间变换。

ready

只读的 Promise,表示模型是否已准备好呈现。

readyPromise

只读的 Promise,表示模型是否已准备好呈现。

scale

可选的数字(默认值:1.0):确定模型对象的缩放比例。

shadows

可选的 ShadowMode 枚举值(默认值:ShadowMode.ENABLED):确定阴影是已启用,已禁用还是仅投射。

show

模型是否显示。

silhouetteColor

可选的颜色对象(默认值:黑色):指定边框颜色。

silhouetteSize

可选的数字(默认值:0.0):以屏幕像素为单位指定边框的大小。

uri

模型的地址,可以是本地文件或远程文件。

debugColorizeTiles

可选的布尔值(默认值:false):确定是否将每个瓦片转换为其层次深度,以帮助调试 GPU 瓶颈。

debugFreezeFrame

可选的数字(默认值:0):以毫秒为单位的时间,在此之后,每个动画都会由一个位置进行渲染。

restrictToBoundingSphere

可选的布尔值(默认值:false):设为 true 以优化瓦片剖分,从而限制瓦片显示内容至该模型的 boundingSphere 属性的包围球范围之内。

事件

appearanceChanged

具有新值的事件,指示模型 appearance 属性已更改。

ready

表示模型已准备好进行呈现的事件。

show, modelMatrix, distanceDisplayCondition, id, color, allowPicking, scale, minimumPixelSize, maximumScale, silhouetteColor, silhouetteSize, debugShowBoundingVolume, debugWireframe, shadows, colorBlendMode, colorBlendAmount, specularEnvironmentMaps, shadeless, castShadows, receiveShadows

属性已更改的事件。

destroyed

当实体已被销毁时发出的事件。

示例

参阅使用示例页面.