Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// Automatically generated - do not modify!
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* A 3D model. This is a new architecture that is more decoupled than the older [Model]. This class is still experimental.
*
* Do not call this function directly, instead use the `from` functions to create
* the Model from your source data type.
* @see Online Documentation
*/
@JsName("\$cesium__ModelExperimental")
external class ModelExperimental(options: ConstructorOptions) {
/**
* @property [resource] The Resource to the 3D model.
* @property [modelMatrix] The 4x4 transformation matrix that transforms the model from model to world coordinates.
* Default value - [Matrix4.IDENTITY]
* @property [debugShowBoundingVolume] For debugging only. Draws the bounding sphere for each draw command in the model.
* Default value - `false`
* @property [cull] Whether or not to cull the model using frustum/horizon culling. If the model is part of a 3D Tiles tileset, this property will always be false, since the 3D Tiles culling system is used.
* Default value - `true`
* @property [opaquePass] The pass to use in the [DrawCommand] for the opaque portions of the model.
* Default value - [Pass.OPAQUE]
* @property [allowPicking] When `true`, each primitive is pickable with [Scene.pick].
* Default value - `true`
* @property [customShader] A custom shader. This will add user-defined GLSL code to the vertex and fragment shaders. Using custom shaders with a [Cesium3DTileStyle] may lead to undefined behavior.
* @property [content] The tile content this model belongs to. This property will be undefined if model is not loaded as part of a tileset.
* @property [show] Whether or not to render the model.
* Default value - `true`
* @property [color] A color that blends with the model's rendered color.
* @property [colorBlendMode] Defines how the color blends with the model.
* Default value - [ColorBlendMode.HIGHLIGHT]
* @property [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 value - `0.5`
* @property [featureIdAttributeIndex] The index of the feature ID attribute to use for picking features per-instance or per-primitive.
* Default value - `0`
* @property [featureIdTextureIndex] The index of the feature ID texture to use for picking features per-primitive.
* Default value - `0`
*/
interface ConstructorOptions {
var resource: Resource
var modelMatrix: Matrix4?
var debugShowBoundingVolume: Boolean?
var cull: Boolean?
var opaquePass: Boolean?
var allowPicking: Boolean?
var customShader: CustomShader?
var content: Cesium3DTileContent?
var show: Boolean?
var color: Color?
var colorBlendMode: ColorBlendMode?
var colorBlendAmount: Double?
var featureIdAttributeIndex: Int?
var featureIdTextureIndex: Int?
}
/**
* 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 [ModelExperimental.readyPromise] is resolved.
* @see Online Documentation
*/
val ready: Boolean
/**
* Gets the promise that will be resolved when this model is ready to render, i.e. when the external resources
* have been downloaded and the WebGL resources are created.
*
* This promise is resolved at the end of the frame before the first frame the model is rendered in.
* @see Online Documentation
*/
val readyPromise: kotlin.js.Promise
/**
* The model's custom shader, if it exists. Using custom shaders with a [Cesium3DTileStyle]
* may lead to undefined behavior.
* @see Online Documentation
*/
var customShader: CustomShader
/**
* The color to blend with the model's rendered color.
* @see Online Documentation
*/
var color: Color
/**
* Defines how the color blends with the model.
* @see Online Documentation
*/
var colorBlendMode: dynamic
/**
* 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.
* @see Online Documentation
*/
var colorBlendAmount: Double
/**
* Gets the model's bounding sphere.
* @see Online Documentation
*/
val boundingSphere: BoundingSphere
/**
* 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.
* @see Online Documentation
*/
var debugShowBoundingVolume: Boolean
/**
* Whether or not to render the model.
* @see Online Documentation
*/
var show: Boolean
/**
* The index of the feature ID attribute to use for picking features per-instance or per-primitive.
* @see Online Documentation
*/
var featureIdAttributeIndex: Int
/**
* The index of the feature ID texture to use for picking features per-primitive.
* @see Online Documentation
*/
var featureIdTextureIndex: Int
/**
* Called when [Viewer] or [CesiumWidget] render the scene to
* get the draw commands needed to render this primitive.
*
* Do not call this function directly. This is documented just to
* list the exceptions that may be propagated when the scene is rendered:
* @see Online Documentation
*/
fun update()
/**
* 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.
* @return `true` if this object was destroyed; otherwise, `false`.
* @see Online Documentation
*/
fun isDestroyed(): Boolean
/**
* 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.
* ```
* model = model && model.destroy();
* ```
* @see Online Documentation
*/
fun destroy()
companion object {
/**
* 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 .glb extension.
* @return The newly created model.
* @see Online Documentation
*/
fun fromGltf(options: FromGltfOptions): ModelExperimental
/**
* @property [gltf] A Resource/URL to a glTF/glb file, a binary glTF buffer, or a JSON object containing the glTF contents
* @property [basePath] The base path that paths in the glTF JSON are relative to.
* Default value - `''`
* @property [modelMatrix] The 4x4 transformation matrix that transforms the model from model to world coordinates.
* Default value - [Matrix4.IDENTITY]
* @property [incrementallyLoadTextures] Determine if textures may continue to stream in after the model is loaded.
* Default value - `true`
* @property [releaseGltfJson] When true, the glTF JSON is released once the glTF is loaded. This is is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective.
* Default value - `false`
* @property [debugShowBoundingVolume] For debugging only. Draws the bounding sphere for each draw command in the model.
* Default value - `false`
* @property [cull] Whether or not to cull the model using frustum/horizon culling. If the model is part of a 3D Tiles tileset, this property will always be false, since the 3D Tiles culling system is used.
* Default value - `true`
* @property [opaquePass] The pass to use in the [DrawCommand] for the opaque portions of the model.
* Default value - [Pass.OPAQUE]
* @property [upAxis] The up-axis of the glTF model.
* Default value - [Axis.Y]
* @property [forwardAxis] The forward-axis of the glTF model.
* Default value - [Axis.Z]
* @property [allowPicking] When `true`, each primitive is pickable with [Scene.pick].
* Default value - `true`
* @property [customShader] A custom shader. This will add user-defined GLSL code to the vertex and fragment shaders. Using custom shaders with a [Cesium3DTileStyle] may lead to undefined behavior.
* @property [content] The tile content this model belongs to. This property will be undefined if model is not loaded as part of a tileset.
* @property [show] Whether or not to render the model.
* Default value - `true`
* @property [color] A color that blends with the model's rendered color.
* @property [colorBlendMode] Defines how the color blends with the model.
* Default value - [ColorBlendMode.HIGHLIGHT]
* @property [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 value - `0.5`
* @property [featureIdAttributeIndex] The index of the feature ID attribute to use for picking features per-instance or per-primitive.
* Default value - `0`
* @property [featureIdTextureIndex] The index of the feature ID texture to use for picking features per-primitive.
* Default value - `0`
*/
interface FromGltfOptions {
var gltf: dynamic
var basePath: Resource?
var modelMatrix: Matrix4?
var incrementallyLoadTextures: Boolean?
var releaseGltfJson: Boolean?
var debugShowBoundingVolume: Boolean?
var cull: Boolean?
var opaquePass: Boolean?
var upAxis: Axis?
var forwardAxis: Axis?
var allowPicking: Boolean?
var customShader: CustomShader?
var content: Cesium3DTileContent?
var show: Boolean?
var color: Color?
var colorBlendMode: ColorBlendMode?
var colorBlendAmount: Double?
var featureIdAttributeIndex: Int?
var featureIdTextureIndex: Int?
}
}
}
