Add existing to tracked
This commit is contained in:
+208
@@ -0,0 +1,208 @@
|
||||
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} BoxGraphics.ConstructorOptions
|
||||
*
|
||||
* Initialization options for the BoxGraphics constructor
|
||||
*
|
||||
* @property {Property | boolean} [show=true] A boolean Property specifying the visibility of the box.
|
||||
* @property {Property | Cartesian3} [dimensions] A {@link Cartesian3} Property specifying the length, width, and height of the box.
|
||||
* @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 box is filled with the provided material.
|
||||
* @property {MaterialProperty | Color} [material=Color.WHITE] A Property specifying the material used to fill the box.
|
||||
* @property {Property | boolean} [outline=false] A boolean Property specifying whether the box 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 | ShadowMode} [shadows=ShadowMode.DISABLED] An enum Property specifying whether the box casts or receives shadows from light sources.
|
||||
* @property {Property | DistanceDisplayCondition} [distanceDisplayCondition] A Property specifying at what distance from the camera that this box will be displayed.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* Describes a box. The center position and orientation are determined by the containing {@link Entity}.
|
||||
*
|
||||
* @alias BoxGraphics
|
||||
* @constructor
|
||||
*
|
||||
* @param {BoxGraphics.ConstructorOptions} [options] Object describing initialization options
|
||||
*
|
||||
* @demo {@link https://sandcastle.cesium.com/index.html?id=box|Cesium Sandcastle Box Demo}
|
||||
*/
|
||||
function BoxGraphics(options) {
|
||||
this._definitionChanged = new Event();
|
||||
this._show = undefined;
|
||||
this._showSubscription = undefined;
|
||||
this._dimensions = undefined;
|
||||
this._dimensionsSubscription = 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._shadows = undefined;
|
||||
this._shadowsSubscription = undefined;
|
||||
this._distanceDisplayCondition = undefined;
|
||||
this._distanceDisplayConditionSubscription = undefined;
|
||||
|
||||
this.merge(options ?? Frozen.EMPTY_OBJECT);
|
||||
}
|
||||
|
||||
Object.defineProperties(BoxGraphics.prototype, {
|
||||
/**
|
||||
* Gets the event that is raised whenever a property or sub-property is changed or modified.
|
||||
* @memberof BoxGraphics.prototype
|
||||
* @type {Event}
|
||||
* @readonly
|
||||
*/
|
||||
definitionChanged: {
|
||||
get: function () {
|
||||
return this._definitionChanged;
|
||||
},
|
||||
},
|
||||
|
||||
/**
|
||||
* Gets or sets the boolean Property specifying the visibility of the box.
|
||||
* @memberof BoxGraphics.prototype
|
||||
* @type {Property|undefined}
|
||||
* @default true
|
||||
*/
|
||||
show: createPropertyDescriptor("show"),
|
||||
|
||||
/**
|
||||
* Gets or sets {@link Cartesian3} Property property specifying the length, width, and height of the box.
|
||||
* @memberof BoxGraphics.prototype
|
||||
* @type {Property|undefined}
|
||||
*/
|
||||
dimensions: createPropertyDescriptor("dimensions"),
|
||||
|
||||
/**
|
||||
* Gets or sets the Property specifying the {@link HeightReference}.
|
||||
* @memberof BoxGraphics.prototype
|
||||
* @type {Property|undefined}
|
||||
* @default HeightReference.NONE
|
||||
*/
|
||||
heightReference: createPropertyDescriptor("heightReference"),
|
||||
|
||||
/**
|
||||
* Gets or sets the boolean Property specifying whether the box is filled with the provided material.
|
||||
* @memberof BoxGraphics.prototype
|
||||
* @type {Property|undefined}
|
||||
* @default true
|
||||
*/
|
||||
fill: createPropertyDescriptor("fill"),
|
||||
|
||||
/**
|
||||
* Gets or sets the material used to fill the box.
|
||||
* @memberof BoxGraphics.prototype
|
||||
* @type {MaterialProperty|undefined}
|
||||
* @default Color.WHITE
|
||||
*/
|
||||
material: createMaterialPropertyDescriptor("material"),
|
||||
|
||||
/**
|
||||
* Gets or sets the Property specifying whether the box is outlined.
|
||||
* @memberof BoxGraphics.prototype
|
||||
* @type {Property|undefined}
|
||||
* @default false
|
||||
*/
|
||||
outline: createPropertyDescriptor("outline"),
|
||||
|
||||
/**
|
||||
* Gets or sets the Property specifying the {@link Color} of the outline.
|
||||
* @memberof BoxGraphics.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 BoxGraphics.prototype
|
||||
* @type {Property|undefined}
|
||||
* @default 1.0
|
||||
*/
|
||||
outlineWidth: createPropertyDescriptor("outlineWidth"),
|
||||
|
||||
/**
|
||||
* Get or sets the enum Property specifying whether the box
|
||||
* casts or receives shadows from light sources.
|
||||
* @memberof BoxGraphics.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 box will be displayed.
|
||||
* @memberof BoxGraphics.prototype
|
||||
* @type {Property|undefined}
|
||||
*/
|
||||
distanceDisplayCondition: createPropertyDescriptor(
|
||||
"distanceDisplayCondition",
|
||||
),
|
||||
});
|
||||
|
||||
/**
|
||||
* Duplicates this instance.
|
||||
*
|
||||
* @param {BoxGraphics} [result] The object onto which to store the result.
|
||||
* @returns {BoxGraphics} The modified result parameter or a new instance if one was not provided.
|
||||
*/
|
||||
BoxGraphics.prototype.clone = function (result) {
|
||||
if (!defined(result)) {
|
||||
return new BoxGraphics(this);
|
||||
}
|
||||
result.show = this.show;
|
||||
result.dimensions = this.dimensions;
|
||||
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.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 {BoxGraphics} source The object to be merged into this object.
|
||||
*/
|
||||
BoxGraphics.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.dimensions = this.dimensions ?? source.dimensions;
|
||||
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.shadows = this.shadows ?? source.shadows;
|
||||
this.distanceDisplayCondition =
|
||||
this.distanceDisplayCondition ?? source.distanceDisplayCondition;
|
||||
};
|
||||
export default BoxGraphics;
|
||||
Reference in New Issue
Block a user