@cesium/engine
Version:
CesiumJS is a JavaScript library for creating 3D globes and 2D maps in a web browser without a plugin.
34 lines (29 loc) • 782 B
JavaScript
/**
* Specifies the type of the cloud that is added to a {@link CloudCollection} in {@link CloudCollection#add}.
*
* @enum {number}
*/
const CloudType = {
/**
* Cumulus cloud.
*
* @type {number}
* @constant
*/
CUMULUS: 0,
};
/**
* Validates that the provided cloud type is a valid {@link CloudType}
*
* @param {CloudType} cloudType The cloud type to validate.
* @returns {boolean} <code>true</code> if the provided cloud type is a valid value; otherwise, <code>false</code>.
*
* @example
* if (!Cesium.CloudType.validate(cloudType)) {
* throw new Cesium.DeveloperError('cloudType must be a valid value.');
* }
*/
CloudType.validate = function (cloudType) {
return cloudType === CloudType.CUMULUS;
};
export default Object.freeze(CloudType);