| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312 |
- 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} EllipsoidGraphics.ConstructorOptions
- *
- * Initialization options for the EllipsoidGraphics constructor
- *
- * @property {Property | boolean} [show=true] A boolean Property specifying the visibility of the ellipsoid.
- * @property {Property | Cartesian3} [radii] A {@link Cartesian3} Property specifying the radii of the ellipsoid.
- * @property {Property | Cartesian3} [innerRadii] A {@link Cartesian3} Property specifying the inner radii of the ellipsoid.
- * @property {Property | number} [minimumClock=0.0] A Property specifying the minimum clock angle of the ellipsoid.
- * @property {Property | number} [maximumClock=2*PI] A Property specifying the maximum clock angle of the ellipsoid.
- * @property {Property | number} [minimumCone=0.0] A Property specifying the minimum cone angle of the ellipsoid.
- * @property {Property | number} [maximumCone=PI] A Property specifying the maximum cone angle of the ellipsoid.
- * @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 ellipsoid is filled with the provided material.
- * @property {MaterialProperty | Color} [material=Color.WHITE] A Property specifying the material used to fill the ellipsoid.
- * @property {Property | boolean} [outline=false] A boolean Property specifying whether the ellipsoid 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} [stackPartitions=64] A Property specifying the number of stacks.
- * @property {Property | number} [slicePartitions=64] A Property specifying the number of radial slices.
- * @property {Property | number} [subdivisions=128] A Property specifying the number of samples per outline ring, determining the granularity of the curvature.
- * @property {Property | ShadowMode} [shadows=ShadowMode.DISABLED] An enum Property specifying whether the ellipsoid casts or receives shadows from light sources.
- * @property {Property | DistanceDisplayCondition} [distanceDisplayCondition] A Property specifying at what distance from the camera that this ellipsoid will be displayed.
- */
-
- /**
- * Describe an ellipsoid or sphere. The center position and orientation are determined by the containing {@link Entity}.
- *
- * @alias EllipsoidGraphics
- * @constructor
- *
- * @param {EllipsoidGraphics.ConstructorOptions} [options] Object describing initialization options
- *
- * @demo {@link https://sandcastle.cesium.com/index.html?id=spheres-and-ellipsoids|Cesium Sandcastle Spheres and Ellipsoids Demo}
- */
- function EllipsoidGraphics(options) {
- this._definitionChanged = new Event();
- this._show = undefined;
- this._showSubscription = undefined;
- this._radii = undefined;
- this._radiiSubscription = undefined;
- this._innerRadii = undefined;
- this._innerRadiiSubscription = undefined;
- this._minimumClock = undefined;
- this._minimumClockSubscription = undefined;
- this._maximumClock = undefined;
- this._maximumClockSubscription = undefined;
- this._minimumCone = undefined;
- this._minimumConeSubscription = undefined;
- this._maximumCone = undefined;
- this._maximumConeSubscription = 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._stackPartitions = undefined;
- this._stackPartitionsSubscription = undefined;
- this._slicePartitions = undefined;
- this._slicePartitionsSubscription = undefined;
- this._subdivisions = undefined;
- this._subdivisionsSubscription = undefined;
- this._shadows = undefined;
- this._shadowsSubscription = undefined;
- this._distanceDisplayCondition = undefined;
- this._distanceDisplayConditionSubscription = undefined;
-
- this.merge(options ?? Frozen.EMPTY_OBJECT);
- }
-
- Object.defineProperties(EllipsoidGraphics.prototype, {
- /**
- * Gets the event that is raised whenever a property or sub-property is changed or modified.
- * @memberof EllipsoidGraphics.prototype
- *
- * @type {Event}
- * @readonly
- */
- definitionChanged: {
- get: function () {
- return this._definitionChanged;
- },
- },
-
- /**
- * Gets or sets the boolean Property specifying the visibility of the ellipsoid.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default true
- */
- show: createPropertyDescriptor("show"),
-
- /**
- * Gets or sets the {@link Cartesian3} {@link Property} specifying the radii of the ellipsoid.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- */
- radii: createPropertyDescriptor("radii"),
-
- /**
- * Gets or sets the {@link Cartesian3} {@link Property} specifying the inner radii of the ellipsoid.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default radii
- */
- innerRadii: createPropertyDescriptor("innerRadii"),
-
- /**
- * Gets or sets the Property specifying the minimum clock angle of the ellipsoid.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default 0.0
- */
- minimumClock: createPropertyDescriptor("minimumClock"),
-
- /**
- * Gets or sets the Property specifying the maximum clock angle of the ellipsoid.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default 2*PI
- */
- maximumClock: createPropertyDescriptor("maximumClock"),
-
- /**
- * Gets or sets the Property specifying the minimum cone angle of the ellipsoid.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default 0.0
- */
- minimumCone: createPropertyDescriptor("minimumCone"),
-
- /**
- * Gets or sets the Property specifying the maximum cone angle of the ellipsoid.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default PI
- */
- maximumCone: createPropertyDescriptor("maximumCone"),
-
- /**
- * Gets or sets the Property specifying the {@link HeightReference}.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default HeightReference.NONE
- */
- heightReference: createPropertyDescriptor("heightReference"),
-
- /**
- * Gets or sets the boolean Property specifying whether the ellipsoid is filled with the provided material.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default true
- */
- fill: createPropertyDescriptor("fill"),
-
- /**
- * Gets or sets the Property specifying the material used to fill the ellipsoid.
- * @memberof EllipsoidGraphics.prototype
- * @type {MaterialProperty}
- * @default Color.WHITE
- */
- material: createMaterialPropertyDescriptor("material"),
-
- /**
- * Gets or sets the Property specifying whether the ellipsoid is outlined.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default false
- */
- outline: createPropertyDescriptor("outline"),
-
- /**
- * Gets or sets the Property specifying the {@link Color} of the outline.
- * @memberof EllipsoidGraphics.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 EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default 1.0
- */
- outlineWidth: createPropertyDescriptor("outlineWidth"),
-
- /**
- * Gets or sets the Property specifying the number of stacks.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default 64
- */
- stackPartitions: createPropertyDescriptor("stackPartitions"),
-
- /**
- * Gets or sets the Property specifying the number of radial slices per 360 degrees.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default 64
- */
- slicePartitions: createPropertyDescriptor("slicePartitions"),
-
- /**
- * Gets or sets the Property specifying the number of samples per outline ring, determining the granularity of the curvature.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- * @default 128
- */
- subdivisions: createPropertyDescriptor("subdivisions"),
-
- /**
- * Get or sets the enum Property specifying whether the ellipsoid
- * casts or receives shadows from light sources.
- * @memberof EllipsoidGraphics.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 ellipsoid will be displayed.
- * @memberof EllipsoidGraphics.prototype
- * @type {Property|undefined}
- */
- distanceDisplayCondition: createPropertyDescriptor(
- "distanceDisplayCondition",
- ),
- });
-
- /**
- * Duplicates this instance.
- *
- * @param {EllipsoidGraphics} [result] The object onto which to store the result.
- * @returns {EllipsoidGraphics} The modified result parameter or a new instance if one was not provided.
- */
- EllipsoidGraphics.prototype.clone = function (result) {
- if (!defined(result)) {
- return new EllipsoidGraphics(this);
- }
- result.show = this.show;
- result.radii = this.radii;
- result.innerRadii = this.innerRadii;
- result.minimumClock = this.minimumClock;
- result.maximumClock = this.maximumClock;
- result.minimumCone = this.minimumCone;
- result.maximumCone = this.maximumCone;
- 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.stackPartitions = this.stackPartitions;
- result.slicePartitions = this.slicePartitions;
- result.subdivisions = this.subdivisions;
- 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 {EllipsoidGraphics} source The object to be merged into this object.
- */
- EllipsoidGraphics.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.radii = this.radii ?? source.radii;
- this.innerRadii = this.innerRadii ?? source.innerRadii;
- this.minimumClock = this.minimumClock ?? source.minimumClock;
- this.maximumClock = this.maximumClock ?? source.maximumClock;
- this.minimumCone = this.minimumCone ?? source.minimumCone;
- this.maximumCone = this.maximumCone ?? source.maximumCone;
- 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.stackPartitions = this.stackPartitions ?? source.stackPartitions;
- this.slicePartitions = this.slicePartitions ?? source.slicePartitions;
- this.subdivisions = this.subdivisions ?? source.subdivisions;
- this.shadows = this.shadows ?? source.shadows;
- this.distanceDisplayCondition =
- this.distanceDisplayCondition ?? source.distanceDisplayCondition;
- };
- export default EllipsoidGraphics;
|