@cesium/engine
Version:
CesiumJS is a JavaScript library for creating 3D globes and 2D maps in a web browser without a plugin.
259 lines (237 loc) • 10.1 kB
JavaScript
import Frozen from "../Core/Frozen.js";
import defined from "../Core/defined.js";
import DeveloperError from "../Core/DeveloperError.js";
import Event from "../Core/Event.js";
import createMaterialPropertyDescriptor from "./createMaterialPropertyDescriptor.js";
import createPropertyDescriptor from "./createPropertyDescriptor.js";
/**
* @typedef {object} CylinderGraphics.ConstructorOptions
*
* Initialization options for the CylinderGraphics constructor
*
* @property {Property | boolean} [show=true] A boolean Property specifying the visibility of the cylinder.
* @property {Property | number} [length] A numeric Property specifying the length of the cylinder.
* @property {Property | number} [topRadius] A numeric Property specifying the radius of the top of the cylinder.
* @property {Property | number} [bottomRadius] A numeric Property specifying the radius of the bottom of the cylinder.
* @property {Property | HeightReference} [heightReference=HeightReference.NONE] A Property specifying what the height from the entity position is relative to.
* @property {Property | boolean} [fill=true] A boolean Property specifying whether the cylinder is filled with the provided material.
* @property {MaterialProperty | Color} [material=Color.WHITE] A Property specifying the material used to fill the cylinder.
* @property {Property | boolean} [outline=false] A boolean Property specifying whether the cylinder is outlined.
* @property {Property | Color} [outlineColor=Color.BLACK] A Property specifying the {@link Color} of the outline.
* @property {Property | number} [outlineWidth=1.0] A numeric Property specifying the width of the outline.
* @property {Property | number} [numberOfVerticalLines=16] A numeric Property specifying the number of vertical lines to draw along the perimeter for the outline.
* @property {Property | number} [slices=128] The number of edges around the perimeter of the cylinder.
* @property {Property | ShadowMode} [shadows=ShadowMode.DISABLED] An enum Property specifying whether the cylinder casts or receives shadows from light sources.
* @property {Property | DistanceDisplayCondition} [distanceDisplayCondition] A Property specifying at what distance from the camera that this cylinder will be displayed.
*/
/**
* Describes a cylinder, truncated cone, or cone defined by a length, top radius, and bottom radius.
* The center position and orientation are determined by the containing {@link Entity}.
*
* @alias CylinderGraphics
* @constructor
*
* @param {CylinderGraphics.ConstructorOptions} [options] Object describing initialization options
*/
function CylinderGraphics(options) {
this._definitionChanged = new Event();
this._show = undefined;
this._showSubscription = undefined;
this._length = undefined;
this._lengthSubscription = undefined;
this._topRadius = undefined;
this._topRadiusSubscription = undefined;
this._bottomRadius = undefined;
this._bottomRadiusSubscription = undefined;
this._heightReference = undefined;
this._heightReferenceSubscription = undefined;
this._fill = undefined;
this._fillSubscription = undefined;
this._material = undefined;
this._materialSubscription = undefined;
this._outline = undefined;
this._outlineSubscription = undefined;
this._outlineColor = undefined;
this._outlineColorSubscription = undefined;
this._outlineWidth = undefined;
this._outlineWidthSubscription = undefined;
this._numberOfVerticalLines = undefined;
this._numberOfVerticalLinesSubscription = undefined;
this._slices = undefined;
this._slicesSubscription = undefined;
this._shadows = undefined;
this._shadowsSubscription = undefined;
this._distanceDisplayCondition = undefined;
this._distanceDisplayConditionSubscription = undefined;
this.merge(options ?? Frozen.EMPTY_OBJECT);
}
Object.defineProperties(CylinderGraphics.prototype, {
/**
* Gets the event that is raised whenever a property or sub-property is changed or modified.
* @memberof CylinderGraphics.prototype
*
* @type {Event}
* @readonly
*/
definitionChanged: {
get: function () {
return this._definitionChanged;
},
},
/**
* Gets or sets the boolean Property specifying the visibility of the cylinder.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
* @default true
*/
show: createPropertyDescriptor("show"),
/**
* Gets or sets the numeric Property specifying the length of the cylinder.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
*/
length: createPropertyDescriptor("length"),
/**
* Gets or sets the numeric Property specifying the radius of the top of the cylinder.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
*/
topRadius: createPropertyDescriptor("topRadius"),
/**
* Gets or sets the numeric Property specifying the radius of the bottom of the cylinder.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
*/
bottomRadius: createPropertyDescriptor("bottomRadius"),
/**
* Gets or sets the Property specifying the {@link HeightReference}.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
* @default HeightReference.NONE
*/
heightReference: createPropertyDescriptor("heightReference"),
/**
* Gets or sets the boolean Property specifying whether the cylinder is filled with the provided material.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
* @default true
*/
fill: createPropertyDescriptor("fill"),
/**
* Gets or sets the Property specifying the material used to fill the cylinder.
* @memberof CylinderGraphics.prototype
* @type {MaterialProperty|undefined}
* @default Color.WHITE
*/
material: createMaterialPropertyDescriptor("material"),
/**
* Gets or sets the boolean Property specifying whether the cylinder is outlined.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
* @default false
*/
outline: createPropertyDescriptor("outline"),
/**
* Gets or sets the Property specifying the {@link Color} of the outline.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
* @default Color.BLACK
*/
outlineColor: createPropertyDescriptor("outlineColor"),
/**
* Gets or sets the numeric Property specifying the width of the outline.
* <p>
* Note: This property will be ignored on all major browsers on Windows platforms. For details, see (@link https://github.com/CesiumGS/cesium/issues/40}.
* </p>
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
* @default 1.0
*/
outlineWidth: createPropertyDescriptor("outlineWidth"),
/**
* Gets or sets the Property specifying the number of vertical lines to draw along the perimeter for the outline.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
* @default 16
*/
numberOfVerticalLines: createPropertyDescriptor("numberOfVerticalLines"),
/**
* Gets or sets the Property specifying the number of edges around the perimeter of the cylinder.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
* @default 128
*/
slices: createPropertyDescriptor("slices"),
/**
* Get or sets the enum Property specifying whether the cylinder
* casts or receives shadows from light sources.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
* @default ShadowMode.DISABLED
*/
shadows: createPropertyDescriptor("shadows"),
/**
* Gets or sets the {@link DistanceDisplayCondition} Property specifying at what distance from the camera that this cylinder will be displayed.
* @memberof CylinderGraphics.prototype
* @type {Property|undefined}
*/
distanceDisplayCondition: createPropertyDescriptor(
"distanceDisplayCondition",
),
});
/**
* Duplicates this instance.
*
* @param {CylinderGraphics} [result] The object onto which to store the result.
* @returns {CylinderGraphics} The modified result parameter or a new instance if one was not provided.
*/
CylinderGraphics.prototype.clone = function (result) {
if (!defined(result)) {
return new CylinderGraphics(this);
}
result.show = this.show;
result.length = this.length;
result.topRadius = this.topRadius;
result.bottomRadius = this.bottomRadius;
result.heightReference = this.heightReference;
result.fill = this.fill;
result.material = this.material;
result.outline = this.outline;
result.outlineColor = this.outlineColor;
result.outlineWidth = this.outlineWidth;
result.numberOfVerticalLines = this.numberOfVerticalLines;
result.slices = this.slices;
result.shadows = this.shadows;
result.distanceDisplayCondition = this.distanceDisplayCondition;
return result;
};
/**
* Assigns each unassigned property on this object to the value
* of the same property on the provided source object.
*
* @param {CylinderGraphics} source The object to be merged into this object.
*/
CylinderGraphics.prototype.merge = function (source) {
//>>includeStart('debug', pragmas.debug);
if (!defined(source)) {
throw new DeveloperError("source is required.");
}
//>>includeEnd('debug');
this.show = this.show ?? source.show;
this.length = this.length ?? source.length;
this.topRadius = this.topRadius ?? source.topRadius;
this.bottomRadius = this.bottomRadius ?? source.bottomRadius;
this.heightReference = this.heightReference ?? source.heightReference;
this.fill = this.fill ?? source.fill;
this.material = this.material ?? source.material;
this.outline = this.outline ?? source.outline;
this.outlineColor = this.outlineColor ?? source.outlineColor;
this.outlineWidth = this.outlineWidth ?? source.outlineWidth;
this.numberOfVerticalLines =
this.numberOfVerticalLines ?? source.numberOfVerticalLines;
this.slices = this.slices ?? source.slices;
this.shadows = this.shadows ?? source.shadows;
this.distanceDisplayCondition =
this.distanceDisplayCondition ?? source.distanceDisplayCondition;
};
export default CylinderGraphics;