qd-changjing/public/static/Build/Documentation/ModelAnimation.html

935 lines
60 KiB
HTML
Raw Normal View History

2022-07-05 16:56:29 +08:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>ModelAnimation - Cesium Documentation</title>
<!--[if lt IE 9]>
<script src="javascript/html5.js"></script>
<![endif]-->
<link href="styles/jsdoc-default.css" rel="stylesheet">
<link href="styles/prism.css" rel="stylesheet">
</head>
<body>
<div id="main">
<h1 class="page-title">
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
ModelAnimation
<div class="titleCenterer"></div>
</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="nameContainer">
<h4 class="name" id="ModelAnimation">
<a href="#ModelAnimation" class="doc-link"></a>
new Cesium.ModelAnimation<span class="signature">()</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L23">Scene/ModelAnimation.js 23</a>
</div>
</h4>
</div>
<div class="description">
An active glTF animation. A glTF asset can contain animations. An active animation
is an animation that is currently playing or scheduled to be played because it was
added to a model's <a href="ModelAnimationCollection.html"><code>ModelAnimationCollection</code></a>. An active animation is an
instance of an animation; for example, there can be multiple active animations
for the same glTF animation, each with a different start time.
<p>
Create this by calling <a href="ModelAnimationCollection.html#add"><code>ModelAnimationCollection#add</code></a>.
</p>
</div>
<dl class="details">
<h5>See:</h5>
<ul class="see-list">
<li><a href="ModelAnimationCollection.html#add">ModelAnimationCollection#add</a></li>
</ul>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="nameContainer">
<h4 class="name" id="delay">
<a href="#delay" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> delay<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L158">Scene/ModelAnimation.js 158</a>
</div>
</h4>
</div>
<div class="description">
The delay, in seconds, from <a href="ModelAnimation.html#startTime"><code>ModelAnimation#startTime</code></a> to start playing.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="loop">
<a href="#loop" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> loop<span class="type-signature"> : <a href="global.html#ModelAnimationLoop">ModelAnimationLoop</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L227">Scene/ModelAnimation.js 227</a>
</div>
</h4>
</div>
<div class="description">
Determines if and how the animation is looped.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript"><a href="global.html#ModelAnimationLoop#.NONE"><code>ModelAnimationLoop.NONE</code></a></code>
</dl>
<div class="nameContainer">
<h4 class="name" id="multiplier">
<a href="#multiplier" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> multiplier<span class="type-signature"> : Number</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L195">Scene/ModelAnimation.js 195</a>
</div>
</h4>
</div>
<div class="description">
Values greater than <code>1.0</code> increase the speed that the animation is played relative
to the scene clock speed; values less than <code>1.0</code> decrease the speed. A value of
<code>1.0</code> plays the animation at the speed in the glTF animation mapped to the scene
clock speed. For example, if the scene is played at 2x real-time, a two-second glTF animation
will play in one second even if <code>multiplier</code> is <code>1.0</code>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">1.0</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="name">
<a href="#name" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> name<span class="type-signature"> : String</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L125">Scene/ModelAnimation.js 125</a>
</div>
</h4>
</div>
<div class="description">
The glTF animation name that identifies this animation.
</div>
<dl class="details">
</dl>
<div class="nameContainer">
<h4 class="name" id="removeOnStop">
<a href="#removeOnStop" class="doc-link"></a>
removeOnStop<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L37">Scene/ModelAnimation.js 37</a>
</div>
</h4>
</div>
<div class="description">
When <code>true</code>, the animation is removed after it stops playing.
This is slightly more efficient that not removing it, but if, for example,
time is reversed, the animation is not played again.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="reverse">
<a href="#reverse" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> reverse<span class="type-signature"> : Boolean</span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L211">Scene/ModelAnimation.js 211</a>
</div>
</h4>
</div>
<div class="description">
When <code>true</code>, the animation is played in reverse.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">false</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="start">
<a href="#start" class="doc-link"></a>
start<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L57">Scene/ModelAnimation.js 57</a>
</div>
</h4>
</div>
<div class="description">
The event fired when this animation is started. This can be used, for
example, to play a sound or start a particle system, when the animation starts.
<p>
This event is fired at the end of the frame after the scene is rendered.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Event()</code>
<h5>Example:</h5>
<pre><code class="language-javascript">animation.start.addEventListener(function(model, animation) {
console.log('Animation started: ' + animation.name);
});</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="startTime">
<a href="#startTime" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> startTime<span class="type-signature"> : <a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L142">Scene/ModelAnimation.js 142</a>
</div>
</h4>
</div>
<div class="description">
The scene time to start playing this animation. When this is <code>undefined</code>,
the animation starts at the next frame.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="stop">
<a href="#stop" class="doc-link"></a>
stop<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L93">Scene/ModelAnimation.js 93</a>
</div>
</h4>
</div>
<div class="description">
The event fired when this animation is stopped. This can be used, for
example, to play a sound or start a particle system, when the animation stops.
<p>
This event is fired at the end of the frame after the scene is rendered.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Event()</code>
<h5>Example:</h5>
<pre><code class="language-javascript">animation.stop.addEventListener(function(model, animation) {
console.log('Animation stopped: ' + animation.name);
});</code></pre>
</dl>
<div class="nameContainer">
<h4 class="name" id="stopTime">
<a href="#stopTime" class="doc-link"></a>
<span class="type-signature attribute-readonly">readonly</span> stopTime<span class="type-signature"> : <a href="JulianDate.html">JulianDate</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L176">Scene/ModelAnimation.js 176</a>
</div>
</h4>
</div>
<div class="description">
The scene time to stop playing this animation. When this is <code>undefined</code>,
the animation is played for its full duration and perhaps repeated depending on
<a href="ModelAnimation.html#loop"><code>ModelAnimation#loop</code></a>.
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">undefined</code>
</dl>
<div class="nameContainer">
<h4 class="name" id="update">
<a href="#update" class="doc-link"></a>
update<span class="type-signature"> : <a href="Event.html">Event</a></span>
<div class="source-link rightLinks">
<a href="https://github.com/CesiumGS/cesium/blob/1.91/Source/Scene/ModelAnimation.js#L76">Scene/ModelAnimation.js 76</a>
</div>
</h4>
</div>
<div class="description">
The event fired when on each frame when this animation is updated. The
current time of the animation, relative to the glTF animation time span, is
passed to the event, which allows, for example, starting new animations at a
specific time relative to a playing animation.
<p>
This event is fired at the end of the frame after the scene is rendered.
</p>
</div>
<dl class="details">
<span class="details-header">Default Value:</span>
<code class="language-javascript">new Event()</code>
<h5>Example:</h5>
<pre><code class="language-javascript">animation.update.addEventListener(function(model, animation, time) {
console.log('Animation updated: ' + animation.name + '. glTF animation time: ' + time);
});</code></pre>
</dl>
</article>
</section>
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.10</a>
</footer>
</div>
<div class="nav">
<div class="menu">
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcGISTiledElevationTerrainProvider"><a href="ArcGISTiledElevationTerrainProvider.html">ArcGISTiledElevationTerrainProvider</a></li><li data-name="ArcType"><a href="global.html#ArcType">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="Axis"><a href="global.html#Axis">Axis</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="backFaceCulling"><a href="global.html#backFaceCulling">backFaceCulling</a></li><li data-name="barycentricCoordinates"><a href="global.html#barycentricCoordinates">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="global.html#binarySearch">binarySearch</a></li><li data-name="binarySearchComparator"><a href="global.html#binarySearchComparator">binarySearchComparator</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="global.html#BingMapsStyle">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="global.html#BlendEquation">BlendEquation</a></li><li data-name="BlendFunction"><a href="global.html#BlendFunction">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="global.html#BlendOption">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="boundingSphere"><a href="global.html#boundingSphere">boundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="buildModuleUrl"><a href="global.html#buildModuleUrl">buildModuleUrl</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="global.html#CameraEventType">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="global.html#cancelAnimationFrame">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderServic
</div>
</div>
<script>
if (window.frameElement) {
document.body.className = 'embedded';
var ele = document.createElement('a');
ele.className = 'popout';
ele.target = '_blank';
ele.href = window.location.href;
ele.title = 'Pop out';
document.getElementById('main').appendChild(ele);
}
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
if (/^https?:/i.test(a.getAttribute('href'))) {
a.target='_blank';
}
});
</script>
<script src="javascript/prism.js"></script>
<script src="javascript/cesiumDoc.js"></script>
</body>
</html>