Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | 18x 18x 18x 18x 18x 1x 2x 1x 2x 1x 1x 11x 1x 11x 1x 22x 1x 21x 1x 20x 20x 20x 20x 20x 1x 21x 1x 20x 1x 19x 19x 1x 5x | import defined from "../Core/defined.js";
import DeveloperError from "../Core/DeveloperError.js";
import Event from "../Core/Event.js";
import JulianDate from "../Core/JulianDate.js";
import ReferenceFrame from "../Core/ReferenceFrame.js";
import PositionProperty from "./PositionProperty.js";
/**
* A {@link PositionProperty} whose value is lazily evaluated by a callback function.
*
* @alias CallbackPositionProperty
* @constructor
*
* @param {CallbackPositionProperty.Callback} callback The function to be called when the position property is evaluated.
* @param {boolean} isConstant <code>true</code> when the callback function returns the same value every time, <code>false</code> if the value will change.
* @param {ReferenceFrame} [referenceFrame=ReferenceFrame.FIXED] The reference frame in which the position is defined.
*
* @demo {@link https://sandcastle.cesium.com/index.html?src=Callback%20Position%20Property.html|Cesium Sandcastle Callback Position Property Demo}
*/
function CallbackPositionProperty(callback, isConstant, referenceFrame) {
this._callback = undefined;
this._isConstant = undefined;
this._referenceFrame = referenceFrame ?? ReferenceFrame.FIXED;
this._definitionChanged = new Event();
this.setCallback(callback, isConstant);
}
Object.defineProperties(CallbackPositionProperty.prototype, {
/**
* Gets a value indicating if this property is constant.
* @memberof CallbackPositionProperty.prototype
*
* @type {boolean}
* @readonly
*/
isConstant: {
get: function () {
return this._isConstant;
},
},
/**
* Gets the event that is raised whenever the definition of this property changes.
* The definition is considered to have changed if a call to getValue would return
* a different result for the same time.
* @memberof CallbackPositionProperty.prototype
*
* @type {Event}
* @readonly
*/
definitionChanged: {
get: function () {
return this._definitionChanged;
},
},
/**
* Gets the reference frame in which the position is defined.
* @memberof CallbackPositionProperty.prototype
* @type {ReferenceFrame}
* @default ReferenceFrame.FIXED;
*/
referenceFrame: {
get: function () {
return this._referenceFrame;
},
},
});
const timeScratch = new JulianDate();
/**
* Gets the value of the property at the provided time in the fixed frame.
*
* @param {JulianDate} [time=JulianDate.now()] The time for which to retrieve the value. If omitted, the current system time is used.
* @param {Cartesian3} [result] The object to store the value into, if omitted, a new instance is created and returned.
* @returns {Cartesian3 | undefined} The modified result parameter or a new instance if the result parameter was not supplied.
*/
CallbackPositionProperty.prototype.getValue = function (time, result) {
if (!defined(time)) {
time = JulianDate.now(timeScratch);
}
return this.getValueInReferenceFrame(time, ReferenceFrame.FIXED, result);
};
/**
* Sets the callback to be used.
*
* @param {CallbackPositionProperty.Callback} callback The function to be called when the property is evaluated.
* @param {boolean} isConstant <code>true</code> when the callback function returns the same value every time, <code>false</code> if the value will change.
*/
CallbackPositionProperty.prototype.setCallback = function (
callback,
isConstant,
) {
//>>includeStart('debug', pragmas.debug);
if (!defined(callback)) {
throw new DeveloperError("callback is required.");
}
if (!defined(isConstant)) {
throw new DeveloperError("isConstant is required.");
}
//>>includeEnd('debug');
const changed =
this._callback !== callback || this._isConstant !== isConstant;
this._callback = callback;
this._isConstant = isConstant;
Eif (changed) {
this._definitionChanged.raiseEvent(this);
}
};
/**
* 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 | undefined} The modified result parameter or a new instance if the result parameter was not supplied.
*/
CallbackPositionProperty.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');
const value = this._callback(time, result);
return PositionProperty.convertToReferenceFrame(
time,
value,
this._referenceFrame,
referenceFrame,
result,
);
};
/**
* Compares this property to the provided property and returns
* <code>true</code> if they are equal, <code>false</code> otherwise.
*
* @param {Property} [other] The other property.
* @returns {boolean} <code>true</code> if left and right are equal, <code>false</code> otherwise.
*/
CallbackPositionProperty.prototype.equals = function (other) {
return (
this === other ||
(other instanceof CallbackPositionProperty &&
this._callback === other._callback &&
this._isConstant === other._isConstant &&
this._referenceFrame === other._referenceFrame)
);
};
/**
* A function that returns the value of the position property.
* @callback CallbackPositionProperty.Callback
*
* @param {JulianDate} [time=JulianDate.now()] The time for which to retrieve the value. If omitted, the current system time is used.
* @param {Cartesian3} [result] The object to store the value into. If omitted, the function must create and return a new instance.
* @returns {Cartesian3 | undefined} The modified result parameter, or a new instance if the result parameter was not supplied or is unsupported.
*/
export default CallbackPositionProperty;
|