TimeIntervalCollectionProperty

new TimeIntervalCollectionProperty

A Property which is defined by a TimeIntervalCollection, where the data property of each TimeInterval represents the value at time.

Parameters:

Name	Type	Argument	Default	Description
`clone`	Function	<optional>	value.clone	A function which takes the value and a result parameter and clones it. This parameter is only required if the value is not a number or string and does not have a clone function.

Throws:

DeveloperError : value is required.
DeveloperError : clone is a required function.

Examples

//Create a Cartesian2 interval property which contains data on August 1st, 2012
//and uses a different value every 6 hours.
var composite = new TimeIntervalCollectionProperty();
composite.intervals.addInterval(TimeInterval.fromIso8601('2012-08-01T00:00:00.00Z/2012-08-01T06:00:00.00Z', true, false, new Cartesian2(2.0, 3.4)));
composite.intervals.addInterval(TimeInterval.fromIso8601('2012-08-01T06:00:00.00Z/2012-08-01T12:00:00.00Z', true, false, new Cartesian2(12.0, 2.7)));
composite.intervals.addInterval(TimeInterval.fromIso8601('2012-08-01T12:00:00.00Z/2012-08-01T18:00:00.00Z', true, false, new Cartesian2(5.0, 12.4)));
composite.intervals.addInterval(TimeInterval.fromIso8601('2012-08-01T18:00:00.00Z/2012-08-02T00:00:00.00Z', true, true, new Cartesian2(85.0, 4.1)));

//Create a TimeIntervalCollectionProperty that contains user-defined objects.
var myObject = {
    value : 6
};
var myObject2 = {
    value : 12
};
function cloneMyObject(value, result) {
    return {
        value : value.value
    };
}
var composite = new TimeIntervalCollectionProperty(cloneMyObject);
composite.intervals.addInterval(TimeInterval.fromIso8601('2012-08-01T00:00:00.00Z/2012-08-01T06:00:00.00Z', true, false, myObject));
composite.intervals.addInterval(TimeInterval.fromIso8601('2012-08-01T06:00:00.00Z/2012-08-01T12:00:00.00Z', true, false, myObject2));

Source:

/Source/DynamicScene/TimeIntervalCollectionProperty.js

Members

intervals :TimeIntervalCollection

Gets the interval collection.

Methods

equals

Compares this property to the provided property and returns true if they are equal, false otherwise.

Parameters:

Name	Type	Argument	Description
`other`	Property	<optional>	The other property.

Returns:

Boolean true if left and right are equal, false otherwise.

getValue

Gets the value of the property at the provided time.

Parameters:

Name	Type	Argument	Description
`time`	JulianDate		The time for which to retrieve the value.
`result`	Object	<optional>	The object to store the value into, if omitted, a new instance is created and returned.

Throws:

DeveloperError : time is required.
DeveloperError : This value requires a clone function be specified for the TimeIntervalCollectionProperty constructor.

Returns:

Object The modified result parameter or a new instance if the result parameter was not supplied.