main.cesium.DataSourceClock.kt Maven / Gradle / Ivy
The newest version!
// Automatically generated - do not modify!
@file:JsModule("cesium")
package cesium
/**
* Represents desired clock settings for a particular [DataSource]. These settings may be applied
* to the [Clock] when the DataSource is loaded.
* @see Online Documentation
*/
external class DataSourceClock {
/**
* Gets the event that is raised whenever a new property is assigned.
* @see Online Documentation
*/
val definitionChanged: Event
/**
* Gets or sets the desired start time of the clock.
* See [Clock.startTime].
* @see Online Documentation
*/
var startTime: JulianDate
/**
* Gets or sets the desired stop time of the clock.
* See [Clock.stopTime].
* @see Online Documentation
*/
var stopTime: JulianDate
/**
* Gets or sets the desired current time when this data source is loaded.
* See [Clock.currentTime].
* @see Online Documentation
*/
var currentTime: JulianDate
/**
* Gets or sets the desired clock range setting.
* See [Clock.clockRange].
* @see Online Documentation
*/
var clockRange: ClockRange
/**
* Gets or sets the desired clock step setting.
* See [Clock.clockStep].
* @see Online Documentation
*/
var clockStep: ClockStep
/**
* Gets or sets the desired clock multiplier.
* See [Clock.multiplier].
* @see Online Documentation
*/
var multiplier: Double
/**
* Duplicates a DataSourceClock instance.
* @param [result] The object onto which to store the result.
* @return The modified result parameter or a new instance if one was not provided.
* @see Online Documentation
*/
fun clone(result: DataSourceClock? = definedExternally): DataSourceClock
/**
* Assigns each unassigned property on this object to the value
* of the same property on the provided source object.
* @param [source] The object to be merged into this object.
* @see Online Documentation
*/
fun merge(source: DataSourceClock)
/**
* Gets the value of this clock instance as a [Clock] object.
* @return The modified result parameter or a new instance if one was not provided.
* @see Online Documentation
*/
fun getValue(): Clock
}