Skip to content

Commit 0604fc1

Browse files
committed
Improve documentation for object animation
1 parent fb19ec6 commit 0604fc1

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -381,15 +381,15 @@ where `dom_element` is the `div` in which the viewer should live. The primary in
381381
<dl>
382382
<dt><code>name</code></dt>
383383
<dd>
384-
The property to be animated, with a leading <code>"."</code> (e.g. <code>".position"</code>)
384+
The property to be animated, with a leading <code>"."</code> (e.g. <code>".position"</code>) A special case is where this field is <code>".object"</code>, allowing the entire object to be animated.
385385
</dd>
386386
<dt><code>type</code></dt>
387387
<dd>
388388
The Three.js data type of the property being animated (e.g. <code>"vector3"</code> for the <code>position</code> property)
389389
</dd>
390390
<dt><code>keys</code></dt>
391391
<dd>
392-
The keyframes of the animation. The format is a list of objects, each with a field <code>time</code> (in frames) and <code>value</code> indicating the value of the animated property at that time.
392+
The keyframes of the animation. The format is a list of objects, each with a field <code>time</code> (in frames) and <code>value</code> indicating the value of the animated property at that time. For animating an entire object, the <code>value</code> field is the same as what you would pass to the <code>object</code> field in the <code>set_object</code> command above.
393393
</dd>
394394
</dl>
395395
</dd>

0 commit comments

Comments
 (0)