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';
|
|
/**
|
* Describes a box. The center position and orientation are determined by the containing {@link Entity}.
|
*
|
* @alias BoxGraphics
|
* @constructor
|
*
|
* @param {Object} [options] Object with the following properties:
|
* @param {Property} [options.show=true] A boolean Property specifying the visibility of the box.
|
* @param {Property} [options.dimensions] A {@link Cartesian3} Property specifying the length, width, and height of the box.
|
* @param {Property} [options.heightReference=HeightReference.NONE] A Property specifying what the height from the entity position is relative to.
|
* @param {Property} [options.fill=true] A boolean Property specifying whether the box is filled with the provided material.
|
* @param {MaterialProperty} [options.material=Color.WHITE] A Property specifying the material used to fill the box.
|
* @param {Property} [options.outline=false] A boolean Property specifying whether the box is outlined.
|
* @param {Property} [options.outlineColor=Color.BLACK] A Property specifying the {@link Color} of the outline.
|
* @param {Property} [options.outlineWidth=1.0] A numeric Property specifying the width of the outline.
|
* @param {Property} [options.shadows=ShadowMode.DISABLED] An enum Property specifying whether the box casts or receives shadows from light sources.
|
* @param {Property} [options.distanceDisplayCondition] A Property specifying at what distance from the camera that this box will be displayed.
|
*
|
* @demo {@link https://sandcastle.cesium.com/index.html?src=Box.html|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(defaultValue(options, defaultValue.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}
|
* @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}
|
*/
|
dimensions : createPropertyDescriptor('dimensions'),
|
|
/**
|
* Gets or sets the Property specifying the {@link HeightReference}.
|
* @memberof BoxGraphics.prototype
|
* @type {Property}
|
* @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}
|
* @default true
|
*/
|
fill : createPropertyDescriptor('fill'),
|
|
/**
|
* Gets or sets the material used to fill the box.
|
* @memberof BoxGraphics.prototype
|
* @type {MaterialProperty}
|
* @default Color.WHITE
|
*/
|
material : createMaterialPropertyDescriptor('material'),
|
|
/**
|
* Gets or sets the Property specifying whether the box is outlined.
|
* @memberof BoxGraphics.prototype
|
* @type {Property}
|
* @default false
|
*/
|
outline : createPropertyDescriptor('outline'),
|
|
/**
|
* Gets or sets the Property specifying the {@link Color} of the outline.
|
* @memberof BoxGraphics.prototype
|
* @type {Property}
|
* @default Color.BLACK
|
*/
|
outlineColor : createPropertyDescriptor('outlineColor'),
|
|
/**
|
* Gets or sets the numeric Property specifying the width of the outline.
|
* @memberof BoxGraphics.prototype
|
* @type {Property}
|
* @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}
|
* @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}
|
*/
|
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 = defaultValue(this.show, source.show);
|
this.dimensions = defaultValue(this.dimensions, source.dimensions);
|
this.heightReference = defaultValue(this.heightReference, source.heightReference);
|
this.fill = defaultValue(this.fill, source.fill);
|
this.material = defaultValue(this.material, source.material);
|
this.outline = defaultValue(this.outline, source.outline);
|
this.outlineColor = defaultValue(this.outlineColor, source.outlineColor);
|
this.outlineWidth = defaultValue(this.outlineWidth, source.outlineWidth);
|
this.shadows = defaultValue(this.shadows, source.shadows);
|
this.distanceDisplayCondition = defaultValue(this.distanceDisplayCondition, source.distanceDisplayCondition);
|
};
|
export default BoxGraphics;
|
