/*global define*/
define([
'../Core/defaultValue',
'../Core/defined',
'../Core/defineProperties',
'../Core/DeveloperError',
'../Core/Event',
'../Core/EventHelper',
'../Core/ReferenceFrame',
'./Property'
], function(
defaultValue,
defined,
defineProperties,
DeveloperError,
Event,
EventHelper,
ReferenceFrame,
Property) {
"use strict";
/**
* A {@link PositionProperty} whose value is an array whose items are the computed value
* of other PositionProperty instances.
*
* @alias PositionPropertyArray
* @constructor
*
* @param {Property[]} [value] An array of Property instances.
*/
var PositionPropertyArray = function(value, referenceFrame) {
this._value = undefined;
this._definitionChanged = new Event();
this._eventHelper = new EventHelper();
this._referenceFrame = defaultValue(referenceFrame, ReferenceFrame.FIXED);
this.setValue(value);
};
defineProperties(PositionPropertyArray.prototype, {
/**
* Gets a value indicating if this property is constant. This property
* is considered constant if all property items in the array are constant.
* @memberof PositionPropertyArray.prototype
*
* @type {Boolean}
* @readonly
*/
isConstant : {
get : function() {
var value = this._value;
if (!defined(value)) {
return true;
}
var length = value.length;
for (var i = 0; i < length; i++) {
if (!Property.isConstant(value[i])) {
return false;
}
}
return true;
}
},
/**
* Gets the event that is raised whenever the definition of this property changes.
* The definition is changed whenever setValue is called with data different
* than the current value or one of the properties in the array also changes.
* @memberof PositionPropertyArray.prototype
*
* @type {Event}
* @readonly
*/
definitionChanged : {
get : function() {
return this._definitionChanged;
}
},
/**
* Gets the reference frame in which the position is defined.
* @memberof PositionPropertyArray.prototype
* @type {ReferenceFrame}
* @default ReferenceFrame.FIXED;
*/
referenceFrame : {
get : function() {
return this._referenceFrame;
}
}
});
/**
* Gets the value of the property.
*
* @param {JulianDate} [time] The time for which to retrieve the value. This parameter is unused since the value does not change with respect to time.
* @param {Cartesian3[]} [result] The object to store the value into, if omitted, a new instance is created and returned.
* @returns {Cartesian3[]} The modified result parameter or a new instance if the result parameter was not supplied.
*/
PositionPropertyArray.prototype.getValue = function(time, result) {
return this.getValueInReferenceFrame(time, ReferenceFrame.FIXED, result);
};
/**
* Gets the value of the property at the provided time and in the provided reference frame.
*
* @param {JulianDate} time The time for which to retrieve the value.
* @param {ReferenceFrame} referenceFrame The desired referenceFrame of the result.
* @param {Cartesian3} [result] The object to store the value into, if omitted, a new instance is created and returned.
* @returns {Cartesian3} The modified result parameter or a new instance if the result parameter was not supplied.
*/
PositionPropertyArray.prototype.getValueInReferenceFrame = function(time, referenceFrame, result) {
//>>includeStart('debug', pragmas.debug);
if (!defined(time)) {
throw new DeveloperError('time is required.');
}
if (!defined(referenceFrame)) {
throw new DeveloperError('referenceFrame is required.');
}
//>>includeEnd('debug');
var value = this._value;
if (!defined(value)) {
return undefined;
}
var length = value.length;
if (!defined(result)) {
result = new Array(length);
}
var i = 0;
var x = 0;
while (i < length) {
var property = value[i];
var itemValue = property.getValueInReferenceFrame(time, referenceFrame, result[i]);
if (defined(itemValue)) {
result[x] = itemValue;
x++;
}
i++;
}
result.length = x;
return result;
};
/**
* Sets the value of the property.
* If the value is an object, the object must provide clone and equals functions.
*
* @param {Property[]} value An array of Property instances.
*/
PositionPropertyArray.prototype.setValue = function(value) {
var eventHelper = this._eventHelper;
eventHelper.removeAll();
if (defined(value)) {
this._value = value.slice();
var length = value.length;
for (var i = 0; i < length; i++) {
var property = value[i];
if (defined(property)) {
eventHelper.add(property.definitionChanged, PositionPropertyArray.prototype._raiseDefinitionChanged, this);
}
}
} else {
this._value = undefined;
}
this._definitionChanged.raiseEvent(this);
};
/**
* Compares this property to the provided property and returns
* true
if they are equal, false
otherwise.
*
* @param {Property} [other] The other property.
* @returns {Boolean} true
if left and right are equal, false
otherwise.
*/
PositionPropertyArray.prototype.equals = function(other) {
return this === other || //
(other instanceof PositionPropertyArray && //
this._referenceFrame === other._referenceFrame && //
Property.arrayEquals(this._value, other._value));
};
PositionPropertyArray.prototype._raiseDefinitionChanged = function() {
this._definitionChanged.raiseEvent(this);
};
return PositionPropertyArray;
});