Changes between Version 7 and Version 8 of Examples/ParaviewAnimating

Timestamp:

06/14/18 15:43:44 (6 years ago)

Author:

Herwig Zilken

Comment:

--

Examples/ParaviewAnimating

@@ -87 +87 @@
 }}}
 
+== Key Frames ==
+Before we start our explantion of cues, we give an overview about keyframes, as keyframes are an integral part of cues. Keyframes define what value(s) a cue has at a give point in time.
+Without keyframes, a cue is more or less useless (with the exception of the !TimeAnimationCue, see below). A cue stores the list of attached keyframes in its KeyFrame property.
+
+The two basic keyframe classes are:
+* paraview.simple.!KeyFrame
+* paraview.simple.!BooleanKeyFrame
+These two keyframes have only two intersting properties: !KeyTime and !KeyValues (which is a Python-list of values).
+
+The keyframes used to interpolate values are:
+* paraview.simple.!RampKeyFrame: linear interpolation
+* paraview.simple.!SinusoidKeyFrame: sinusoidal interpolation
+* paraview.simple.!ExponentialKeyFrame: exponential interpolation
+* paraview.simple.!CompositeKeyFrame: composite of four types of keyframes. 'Interpolation' property can be set to 'Boolean', 'Ramp', 'Exponential', or 'Sinusoid'
+
+The keyframe for interpolating camera parameters is:
+* paraview.simple.!CameraKeyFrame
+
 == !KeyFrameAnimationCue ==
 As already mentioned, a !KeyFrameAnimationCue connects the property of a pipeline object to the cue.
 This connection is defined via the attributes !AnimatedProxy (proxy of the pipeline object) and !AnimatedPropertyName (name of the connected property), though typically you do not have to set these attributes on your own. Instead they are set when constructing a !KeyFrameAnimationCue by calling !GetAnimationTrack(...) (see use case below).
-Similar to the !AnimationScene, every cue also has the properties !StartTime and !EndTime. Typically these properties do not have the same values as the corresponding ones of !AnimationScene. When !TimeMode is set to 'Normalize', the start and end time of the animation scene is linearly interpolated to the interval ![0,1]. But don't care, these values are the default ones anyhow.
+Similar to the !AnimationScene, every cue also has the properties !StartTime and !EndTime. Typically these properties do not have the identical values as the corresponding ones of !AnimationScene. When !TimeMode is set to 'Normalize', the start and end time of the animation scene is linearly interpolated to the interval ![0,1]. But don't care, these values are the default anyhow.
 
 === !KeyFrameAnimationCue Use Case ===
@@ -105 +123 @@
 
 
+== !TimeAnimationCue ==
+This type of cue is a very special one: while all other kind of cues are absolutely useless without attached keyframes, this one can fullfill a special task without having any: it can directly hand over the animation clock time (coming from !AnimationScene) to the property of a connected object. The typical use case within !ParaView is as follows: the !AnimationScene sets the value of the !TimeAnimationCue directly to its clock time. The !TimeAnimationCue is connected to the Time property of the !TimeKeeper object, which in turn requests all data objects to load the correct time step of the data. This way the clock time of the animation scene can be kept in sync with the data timsteps.
+But one can override this behaviour by attaching keyframes to this cue and setting "!UseAnimationTime" to 0. This way one can control what data timesteps are loaded/rendered at what animation clock time.
+
+=== !TimeAnimationCue Use Cases ===
+Whatever the AnimationScene clock time is, set the time of the timetrack to 100.
+This setup can be useful e.g. to generate an animated camera flight from one single data timestep (100 in this example).
+{{{
+#!python
+from paraview.simple import *
+timeTrack = GetTimeTrack()
+timeTrack.StartTime = 0
+timeTrack.EndTime = 1
+timeTrack.UseAnimationTime = 0
+keyFrame = CompositeKeyFrame()
+keyFrame.Interpolation = "Ramp"
+keyFrame.KeyValues=[100] # set time step to 100
+keyFrame.KeyTime = 0
+timeTrack.KeyFrames=[keyFrame]
+}}}
+
+Reset the time track to use the AnimationScene clock time again:
+{{{
+#!python
+timeTrack.UseAnimationTime = 1
+}}}
+
+== !CameraAnimationCue ==
+To be done
+
+== !PythonAnimationCue ==
+To be done
+