123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163 |
- import defaultValue from "../Core/defaultValue.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} PathGraphics.ConstructorOptions
- *
- * Initialization options for the PathGraphics constructor
- *
- * @property {Property | boolean} [show=true] A boolean Property specifying the visibility of the path.
- * @property {Property | number} [leadTime] A Property specifying the number of seconds in front the object to show.
- * @property {Property | number} [trailTime] A Property specifying the number of seconds behind of the object to show.
- * @property {Property | number} [width=1.0] A numeric Property specifying the width in pixels.
- * @property {Property | number} [resolution=60] A numeric Property specifying the maximum number of seconds to step when sampling the position.
- * @property {MaterialProperty | Color} [material=Color.WHITE] A Property specifying the material used to draw the path.
- * @property {Property | DistanceDisplayCondition} [distanceDisplayCondition] A Property specifying at what distance from the camera that this path will be displayed.
- */
- /**
- * Describes a polyline defined as the path made by an {@link Entity} as it moves over time.
- *
- * @alias PathGraphics
- * @constructor
- *
- * @param {PathGraphics.ConstructorOptions} [options] Object describing initialization options
- */
- function PathGraphics(options) {
- this._definitionChanged = new Event();
- this._show = undefined;
- this._showSubscription = undefined;
- this._leadTime = undefined;
- this._leadTimeSubscription = undefined;
- this._trailTime = undefined;
- this._trailTimeSubscription = undefined;
- this._width = undefined;
- this._widthSubscription = undefined;
- this._resolution = undefined;
- this._resolutionSubscription = undefined;
- this._material = undefined;
- this._materialSubscription = undefined;
- this._distanceDisplayCondition = undefined;
- this._distanceDisplayConditionSubscription = undefined;
- this.merge(defaultValue(options, defaultValue.EMPTY_OBJECT));
- }
- Object.defineProperties(PathGraphics.prototype, {
- /**
- * Gets the event that is raised whenever a property or sub-property is changed or modified.
- * @memberof PathGraphics.prototype
- * @type {Event}
- * @readonly
- */
- definitionChanged: {
- get: function () {
- return this._definitionChanged;
- },
- },
- /**
- * Gets or sets the boolean Property specifying the visibility of the path.
- * @memberof PathGraphics.prototype
- * @type {Property|undefined}
- * @default true
- */
- show: createPropertyDescriptor("show"),
- /**
- * Gets or sets the Property specifying the number of seconds in front of the object to show.
- * @memberof PathGraphics.prototype
- * @type {Property|undefined}
- */
- leadTime: createPropertyDescriptor("leadTime"),
- /**
- * Gets or sets the Property specifying the number of seconds behind the object to show.
- * @memberof PathGraphics.prototype
- * @type {Property|undefined}
- */
- trailTime: createPropertyDescriptor("trailTime"),
- /**
- * Gets or sets the numeric Property specifying the width in pixels.
- * @memberof PathGraphics.prototype
- * @type {Property|undefined}
- * @default 1.0
- */
- width: createPropertyDescriptor("width"),
- /**
- * Gets or sets the Property specifying the maximum number of seconds to step when sampling the position.
- * @memberof PathGraphics.prototype
- * @type {Property|undefined}
- * @default 60
- */
- resolution: createPropertyDescriptor("resolution"),
- /**
- * Gets or sets the Property specifying the material used to draw the path.
- * @memberof PathGraphics.prototype
- * @type {MaterialProperty}
- * @default Color.WHITE
- */
- material: createMaterialPropertyDescriptor("material"),
- /**
- * Gets or sets the {@link DistanceDisplayCondition} Property specifying at what distance from the camera that this path will be displayed.
- * @memberof PathGraphics.prototype
- * @type {Property|undefined}
- */
- distanceDisplayCondition: createPropertyDescriptor(
- "distanceDisplayCondition"
- ),
- });
- /**
- * Duplicates this instance.
- *
- * @param {PathGraphics} [result] The object onto which to store the result.
- * @returns {PathGraphics} The modified result parameter or a new instance if one was not provided.
- */
- PathGraphics.prototype.clone = function (result) {
- if (!defined(result)) {
- return new PathGraphics(this);
- }
- result.show = this.show;
- result.leadTime = this.leadTime;
- result.trailTime = this.trailTime;
- result.width = this.width;
- result.resolution = this.resolution;
- result.material = this.material;
- 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 {PathGraphics} source The object to be merged into this object.
- */
- PathGraphics.prototype.merge = function (source) {
- //>>includeStart('debug', pragmas.debug);
- if (!defined(source)) {
- throw new DeveloperError("source is required.");
- }
- //>>includeEnd('debug');
- this.show = defaultValue(this.show, source.show);
- this.leadTime = defaultValue(this.leadTime, source.leadTime);
- this.trailTime = defaultValue(this.trailTime, source.trailTime);
- this.width = defaultValue(this.width, source.width);
- this.resolution = defaultValue(this.resolution, source.resolution);
- this.material = defaultValue(this.material, source.material);
- this.distanceDisplayCondition = defaultValue(
- this.distanceDisplayCondition,
- source.distanceDisplayCondition
- );
- };
- export default PathGraphics;
|