org.cesiumjs.cs.scene

Class Model

java.lang.Object

org.cesiumjs.cs.scene.Model

@JsType(isNative=true,
        namespace="Cesium",
        name="Model")
public class Model
extends Object

A 3D model based on glTF, the runtime asset format for WebGL, OpenGL ES, and OpenGL. Cesium includes support for geometry and materials, glTF animations, and glTF skinning. In addition, individual glTF nodes are pickable with Scene.pick(org.cesiumjs.cs.core.Cartesian2) and animatable with getNode(java.lang.String). glTF cameras and lights are not currently supported. An external glTF asset is created with Model.fromGltf. glTF JSON can also be created at runtime and passed to this constructor function. In either case, the readyPromise() is resolved when the model is ready to render, i.e., when the external binary, image, and shader files are downloaded and the WebGL resources are created. For high-precision rendering, Cesium supports the CESIUM_RTC extension, which introduces the CESIUM_RTC_MODELVIEW parameter semantic that says the node is in WGS84 coordinates translated relative to a local origin.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
ModelAnimationCollection	activeAnimations The currently playing glTF animations.
boolean	clampAnimations Determines if the model's animations should hold a pose over frames where no keyframes are specified.
ClippingPlaneCollection	clippingPlane The ClippingPlaneCollection used to selectively disable rendering the model.
Color	color A color that blends with the model's rendered color.
double	colorBlendAmount Value used to determine the color strength when the colorBlendMode is MIX.
Number	colorBlendMode Defines how the color blends with the model.
double	debugShowBoundingVolume This property is for debugging only; it is not for production use nor is it optimized.
boolean	debugWireframe This property is for debugging only; it is not for production use nor is it optimized.
DistanceDisplayCondition	distanceDisplayCondition Gets or sets the condition specifying at what distance from the camera that this model will be displayed.
Object	gltf The object for the glTF JSON, including properties with default values omitted from the JSON provided to this model.
Object	id User-defined object returned when the model is picked.
boolean	incrementallyLoadTextures Determine if textures may continue to stream in after the model is loaded.
Cartesian3	lightColor The color and intensity of the sunlight used to shade the model.
double	luminanceAtZenith The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map.
double	maximumScale The maximum scale size for a model.
double	minimumPixelSize The approximate minimum pixel size of the model regardless of zoom.
Matrix4	modelMatrix The 4x4 transformation matrix that transforms the model from model to world coordinates.
double	scale A uniform scale applied to this model before the Model#modelMatrix.
Number	shadows Determines whether the model casts or receives shadows from each light source.
boolean	show Determines if the model primitive will be shown.
Color	silhouetteColor The silhouette color.
double	silhouetteSize The size of the silhouette in pixels.
String	specularEnvironmentMaps A URL to a KTX file that contains a cube map of the specular lighting and the convoluted specular mipmaps.
Cartesian3[]	sphericalHarmonicCoefficients The third order spherical harmonic coefficients used for the diffuse color of image-based lighting.

Constructor Summary

Constructors

Constructor and Description
Model()
Model(ModelOptions options)

Method Summary

Modifier and Type	Method and Description
boolean	allowPicking() When true, each glTF mesh and primitive is pickable with Scene#pick.
boolean	asynchronous() Determines if model WebGL resource creation will be spread out over several frames or block until completion once all glTF files are loaded.
String	basePath() The base path that paths in the glTF JSON are relative to.
BoundingSphere	boundingSphere() The model's bounding sphere in its local coordinate system.
void	destroy() Destroys the WebGL resources held by this object.
static Model	fromGltf(FromGltfOptions options) Creates a model from a glTF asset.
ModelMaterial	getMaterial(String name) Returns the glTF material with the given name property.
ModelMesh	getMesh(String name) Returns the glTF mesh with the given name property.
ModelNode	getNode(String name) Returns the glTF node with the given name property.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.
double	pendingTextureLoads() Return the number of pending texture loads.
boolean	ready() When true, this model is ready to render, i.e., the external binary, image, and shader files were downloaded and the WebGL resources were created.
Promise<Model,Void>	readyPromise() Gets the promise that will be resolved when this model is ready to render, i.e., when the external binary, image, and shader files were downloaded and the WebGL resources were created.
static boolean	silhouetteSupported(Scene scene) Determines if silhouettes are supported.
void	update() Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

activeAnimations

@JsProperty
public ModelAnimationCollection activeAnimations

The currently playing glTF animations.

clampAnimations

@JsProperty
public boolean clampAnimations

Determines if the model's animations should hold a pose over frames where no keyframes are specified.

color

@JsProperty
public Color color

A color that blends with the model's rendered color. Default: Color.WHITE().

colorBlendAmount

@JsProperty
public double colorBlendAmount

Value used to determine the color strength when the colorBlendMode is MIX. A value of 0.0 results in the model's rendered color while a value of 1.0 results in a solid color, with any value in-between resulting in a mix of the two. Default: 0.5.

colorBlendMode

@JsProperty
public Number colorBlendMode

Defines how the color blends with the model. Default: ColorBlendMode.HIGHLIGHT().

debugShowBoundingVolume

@JsProperty
public double debugShowBoundingVolume

This property is for debugging only; it is not for production use nor is it optimized. Draws the bounding sphere for each draw command in the model. A glTF primitive corresponds to one draw command. A glTF mesh has an array of primitives, often of length one. Default: false

debugWireframe

@JsProperty
public boolean debugWireframe

This property is for debugging only; it is not for production use nor is it optimized. Draws the model in wireframe. Default: false.

distanceDisplayCondition

@JsProperty
public DistanceDisplayCondition distanceDisplayCondition

Gets or sets the condition specifying at what distance from the camera that this model will be displayed. Default: undefined

gltf

@JsProperty
public Object gltf

The object for the glTF JSON, including properties with default values omitted from the JSON provided to this model. Default: undefined

id

@JsProperty
public Object id

User-defined object returned when the model is picked. Default: undefined.

See Also:

Scene.pick(org.cesiumjs.cs.core.Cartesian2)

incrementallyLoadTextures

@JsProperty
public boolean incrementallyLoadTextures

Determine if textures may continue to stream in after the model is loaded. Default: true.

lightColor

@JsProperty
public Cartesian3 lightColor

The color and intensity of the sunlight used to shade the model. For example, disabling additional light sources by setting model.imageBasedLightingFactor = new Cesium.Cartesian2(0.0, 0.0) will make the model much darker. Here, increasing the intensity of the light source will make the model brighter. Default: undefined

luminanceAtZenith

@JsProperty
public double luminanceAtZenith

The sun's luminance at the zenith in kilo candela per meter squared to use for this model's procedural environment map. This is used when specularEnvironmentMaps and sphericalHarmonicCoefficients are not defined. Default: 0.5

maximumScale

@JsProperty
public double maximumScale

The maximum scale size for a model. This can be used to give an upper limit to the minimumPixelSize, ensuring that the model is never an unreasonable scale.

minimumPixelSize

@JsProperty
public double minimumPixelSize

The approximate minimum pixel size of the model regardless of zoom. This can be used to ensure that a model is visible even when the viewer zooms out. When 0.0, no minimum size is enforced. Default: 0.0

modelMatrix

@JsProperty
public Matrix4 modelMatrix

The 4x4 transformation matrix that transforms the model from model to world coordinates. When this is the identity matrix, the model is drawn in world coordinates, i.e., Earth's WGS84 coordinates. Local reference frames can be used by providing a different transformation matrix, like that returned by Transforms.eastNorthUpToFixedFrame. Default: Matrix4.IDENTITY().

scale

@JsProperty
public double scale

A uniform scale applied to this model before the Model#modelMatrix. Values greater than 1.0 increase the size of the model; values less than 1.0 decrease. Default: 1.0

shadows

@JsProperty
public Number shadows

Determines whether the model casts or receives shadows from each light source. Default: ShadowMode.ENABLED().

show

@JsProperty
public boolean show

Determines if the model primitive will be shown. Default: true.

silhouetteColor

@JsProperty
public Color silhouetteColor

The silhouette color. Default: Color.RED().

silhouetteSize

@JsProperty
public double silhouetteSize

The size of the silhouette in pixels. Default: 0.0

clippingPlane

@JsProperty
public ClippingPlaneCollection clippingPlane

The ClippingPlaneCollection used to selectively disable rendering the model. Clipping planes are not currently supported in Internet Explorer.

specularEnvironmentMaps

@JsProperty
public String specularEnvironmentMaps

A URL to a KTX file that contains a cube map of the specular lighting and the convoluted specular mipmaps.

See Also:

sphericalHarmonicCoefficients

sphericalHarmonicCoefficients

@JsProperty
public Cartesian3[] sphericalHarmonicCoefficients

The third order spherical harmonic coefficients used for the diffuse color of image-based lighting. When undefined, a diffuse irradiance computed from the atmosphere color is used. There are nine Cartesian3 coefficients. The order of the coefficients is: L00, L1-1, L10, L11, L2-2, L2-1, L20, L21, L22 These values can be obtained by preprocessing the environment map using the cmgen tool of Google's Filament project. This will also generate a KTX file that can be supplied to Model#specularEnvironmentMaps.

See Also:

An Efficient Representation for Irradiance Environment Maps

Constructor Detail

Model

@JsConstructor
public Model()

Model

@JsConstructor
public Model(ModelOptions options)

Method Detail

allowPicking

@JsProperty(name="allowPicking")
public boolean allowPicking()

When true, each glTF mesh and primitive is pickable with Scene#pick. When false, GPU memory is saved. Default: true.

asynchronous

@JsProperty(name="asynchronous")
public boolean asynchronous()

Determines if model WebGL resource creation will be spread out over several frames or block until completion once all glTF files are loaded. Default: true.

basePath

@JsProperty(name="basePath")
public String basePath()

The base path that paths in the glTF JSON are relative to. The base path is the same path as the path containing the .gltf file minus the .gltf file, when binary, image, and shader files are in the same directory as the .gltf. When this is '', the app's base path is used. Default: empty.

boundingSphere

@JsProperty(name="boundingSphere")
public BoundingSphere boundingSphere()

The model's bounding sphere in its local coordinate system. This does not take into account glTF animations and skins nor does it take into account Model#minimumPixelSize. Default: undefined

pendingTextureLoads

@JsProperty(name="pendingTextureLoads")
public double pendingTextureLoads()

Return the number of pending texture loads.

ready

@JsProperty(name="ready")
public boolean ready()

When true, this model is ready to render, i.e., the external binary, image, and shader files were downloaded and the WebGL resources were created. This is set to true right before Model#readyPromise is resolved. Default: false

readyPromise

@JsProperty(name="readyPromise")
public Promise<Model,Void> readyPromise()

Gets the promise that will be resolved when this model is ready to render, i.e., when the external binary, image, and shader files were downloaded and the WebGL resources were created. This promise is resolved at the end of the frame before the first frame the model is rendered in.

See Also:

ready()

fromGltf

@JsMethod
public static Model fromGltf(FromGltfOptions options)

Creates a model from a glTF asset. When the model is ready to render, i.e., when the external binary, image, and shader files are downloaded and the WebGL resources are created, the Model#readyPromise is resolved. The model can be a traditional glTF asset with a .gltf extension or a Binary glTF using the KHR_binary_glTF extension with a .glb extension. For high-precision rendering, Cesium supports the CESIUM_RTC extension, which introduces the CESIUM_RTC_MODELVIEW parameter semantic that says the node is in WGS84 coordinates translated relative to a local origin.

Parameters:

options -

Returns:

Loaded model.

silhouetteSupported

@JsMethod
public static boolean silhouetteSupported(Scene scene)

Determines if silhouettes are supported.

Parameters:

scene - The scene.

Returns:

true if silhouettes are supported; otherwise, returns false

destroy

@JsMethod
public void destroy()

Destroys the WebGL resources held by this object. Destroying an object allows for deterministic release of WebGL resources, instead of relying on the garbage collector to destroy this object. Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

See Also:

isDestroyed()

getMaterial

@JsMethod
public ModelMaterial getMaterial(String name)

Returns the glTF material with the given name property.

Parameters:

name - The glTF name of the material.

Returns:

The material or undefined if no material with name exists.

getMesh

@JsMethod
public ModelMesh getMesh(String name)

Returns the glTF mesh with the given name property.

Parameters:

name - The glTF name of the mesh.

Returns:

The mesh or undefined if no mesh with name exists.

getNode

@JsMethod
public ModelNode getNode(String name)

Returns the glTF node with the given name property. This is used to modify a node's transform for animation outside of glTF animations.

Parameters:

name - The glTF name of the node.

Returns:

The node or undefined if no node with name exists.

isDestroyed

@JsMethod
public boolean isDestroyed()

Returns true if this object was destroyed; otherwise, false. If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:

true if this object was destroyed; otherwise, false.

See Also:

destroy()

update

@JsMethod
public void update()

Called when Viewer or CesiumWidget render the scene to get the draw commands needed to render this primitive. Do not call this function directly.