Waypoint

From Synfig Studio :: Documentation
Jump to: navigation, search
m (Interpolation)
m (Terminology Updated)
Line 2: Line 2:
 
{{Title|Waypoint}}
 
{{Title|Waypoint}}
 
{{Category|Glossary}}
 
{{Category|Glossary}}
 +
{{Category|NewTerminology}}
 
<!-- Page info end -->
 
<!-- Page info end -->
  
 
== Introduction ==
 
== Introduction ==
  
Waypoints are the graphical symbols that show up on the {{l|timetrack}}
+
{{Literal|Waypoints}} are the graphical symbols that show up on the {{l|Timetrack}}
panel. Each time the value of a parameter is edited in
+
panel. Each time the value of a parameter is edited in
{{l|Animate_Editing_Mode|animate editing mode}}, a waypoint will be
+
{{l|Animate_Editing_Mode|animate editing mode}}, a Waypoint will be
created.  For example, when you adjust a tangent {{l|duck}} of a vertex
+
created.  For example, when you adjust a {{Literal|Tangent}} {{l|Handle}} of a vertex
in a bline, a waypoint will be created to note the change. However,
+
in a {{l|Spline}}, a {{Literal|Waypoint}} will be created to note the change. However,
 
you didn't really adjust the tangent, you adjusted the two parameters
 
you didn't really adjust the tangent, you adjusted the two parameters
which define the tangent: its angle ('Theta'), and its length
+
which define the tangent: its angle ({{Literal|Theta}}), and its length
('Radius').  Opening up the 'tangent' node in the params dialog will
+
({{Literal|Radius}}).  Opening up the tangent's nodes in the {{l|Parameters Panel}} will
show that waypoints have been created against each of these 2
+
show that {{Literal|Waypoints}} have been created against each of these 2
 
parameters.
 
parameters.
  
As a result of adjusting a single tangent duck, waypoints have been created as follows:
+
As a result of adjusting a single {{Literal|Tangent}} Handle, {{Literal|Waypoint}} have been created as follows:
* the length of the tangent changed ('Radius')
+
* the length of the tangent changed ({{Literal|Radius}})
* the angle of the tangent changed ('Theta')
+
* the angle of the tangent changed ({{Literal|Theta}})
*  the tangent changed ('Tangent 1')
+
*  the tangent changed ({{Literal|Tangent 1}})
*    the vertex changed ('Vertex 001')
+
*    the vertex changed ({{Literal|Vertex 001}})
*      the vertices changes ('Vertices')
+
*      the vertices changes ({{Literal|Vertices}})
 
Only the first 2 of these are 'leaf waypoints' - the rest are parents (and grandparents, etc) of these 2 waypoints.
 
Only the first 2 of these are 'leaf waypoints' - the rest are parents (and grandparents, etc) of these 2 waypoints.
  
As things currently stand, it is only possible to delete one leaf
+
<strike>As things currently stand, it is only possible to delete one leaf
 
waypoint at a time.  If, for example, you want to delete the change
 
waypoint at a time.  If, for example, you want to delete the change
made to the tangent duck above, you'll need to open up the tangent and
+
made to the {{Literal|Tangent}} Handle above, you'll need to open up the tangent and
delete both the 'Theta' and 'Radius' waypoints.  The ability to delete
+
delete both the {{Literal|Theta}} and {{Literal|Radius}} Waypoints.  The ability to delete
 
whole trees of waypoints with a single click would be useful, as would
 
whole trees of waypoints with a single click would be useful, as would
 
the ability to select multiple waypoints at once, and operate upon
 
the ability to select multiple waypoints at once, and operate upon
them en masse.
+
them en masse.</strike>
  
 
== Editing Waypoints ==
 
== Editing Waypoints ==
Line 37: Line 38:
 
Waypoints can be dragged left or right with the left mouse button to
 
Waypoints can be dragged left or right with the left mouse button to
 
change the time at which they act upon their parameter(s).  If you
 
change the time at which they act upon their parameter(s).  If you
drag a parent's waypoint, all its child waypoints will move with it.
+
drag a parent's Waypoint, all its child Waypoints will move with it.
  
Right-clicking on waypoint shows a context menu, containing:
+
Right-clicking on Waypoint shows a context menu, containing:
* Jump to: Set the current time to be the time of the waypoint.
+
* {{Literal|Jump to}}: Set the current time to be the time of the waypoint.
* Edit waypoint: Only appears for single-leaf waypoints.  TODO: writeme (brings up a dialog allowing various parameters to be set).
+
* {{Literal|Duplicate}}: <strike>Only appears for single-leaf Waypoints.</strike> Creates a copy of the current Waypoint at the currently selected time.
* Duplicate: Only appears for single-leaf waypointscreates a copy of the current waypoint at the currently selected time.
+
* {{Literal|Remove}}: Only appears for single-leaf waypoints. Deletes the Waypoint.
* Delete: Only appears for single-leaf waypoints. deletes the waypoint.
+
* {{Literal|Remove '''n''' Waypoints}}: Only appears for multi-leaf waypoints. Deletes the '''n''' Waypoints.
* Change in/out interp.: Only appears for multi-leaf waypoints, and allows you to change the in (or out) interpolation setting for the waypoint and all its children. The choice of 'in' or 'out' is dependent upon which half of the waypoint you clicked on.
+
* {{Literal|Edit}}: <strike>Only appears for single-leaf Waypoints.  </strike>
 +
  TODO: writeme (brings up a dialog allowing various parameters to be set).
 +
* {{Literal|Both}}.: Allows you to change the {{Literal|In}} and {{Literal|Out}} {{l|Waypoint#Interpolation|interpolation}} setting for the Waypoint and all its children.
 +
* {{Literal|In}}.: Allows you to change the {{Literal|In}} interpolation setting for the Waypoint and all its children.  
 +
* {{Literal|Out}}.: Allows you to change the {{Literal|Out}} interpolation setting for the Waypoint and all its children.
 +
 
 +
If the Waypoint is {{l|Linking|Linked}} other menu entries related to the link will appear up to those one.
 +
  TODO: writeme (describe added menu entries in case of linked waypoint)
  
 
== Interpolation ==
 
== Interpolation ==
  
Each waypoint has an 'In' and an 'Out' interpolation setting, which
+
Each Waypoint has an {{Literal|In}} and an {{Literal|Out}} interpolation setting, which
 
determines the manner in which its parameter changes - whether it
 
determines the manner in which its parameter changes - whether it
 
changes linearly over time, or follows a curve.
 
changes linearly over time, or follows a curve.
  
The 'In' interpolation defines how the parameter changes in the
+
The {{Literal|In}} interpolation defines how the parameter changes in the
moments before the waypoint is reached, and 'Out' defines how it
+
moments before the Waypoint is reached, and {{Literal|Out}} defines how it
changes in the moments after the waypoint.  Available interpolation
+
changes in the moments after the Waypoint.  Available interpolation
 
types are as follows:
 
types are as follows:
  
* {{l|TCB|TCB Smooth}}: If you imagine a graph of the parameter's value against time, using the TCB interpolation type will fit a smooth curve between adjacent waypoints, much like the bline tool fits smooth curves between adjacent bline vertices.
+
* {{l|TCB|TCB Smooth}}: If you imagine a graph of the parameter's value against time, using the TCB interpolation type will fit a smooth curve between adjacent waypoints, much like the {{l|Spline Tool}} fits smooth curves between adjacent spline vertices.
* {{l|Clamped interpolation|Clamped}}: Acts like TCB interpolation, but never "overshoots" (or "undershoots") the values you set in the parameters panel.
+
* {{l|Clamped interpolation|Clamped}}: Acts like TCB interpolation, but never "overshoots" (or "undershoots") the values you set in the {{l|Parameters Panel}}.
 
* {{l|Constant|Constant}}: Stops the animation.
 
* {{l|Constant|Constant}}: Stops the animation.
* {{l|Ease In/Out|Ease In/Out}}: The graph is horizontal as it leaves the waypoint.
+
* {{l|Ease In/Out|Ease In/Out}}: The graph is horizontal as it leaves the Waypoint.
 
* {{l|Linear|Linear}}: The graph of parameter value against time is a straight line.
 
* {{l|Linear|Linear}}: The graph of parameter value against time is a straight line.
* Undefined: This is only shown for multi-leaf waypoints, where there is more than one different interpolation type amongst its leaf waypoints.
+
* Undefined: This is only shown for multi-leaf Waypoints, where there is more than one different interpolation type amongst its leaf Waypoints.
  
 
=== Graphical Representation ===
 
=== Graphical Representation ===
  
The color and shape of the waypoint as displayed in the timetrack
+
The color and shape of the Waypoint as displayed in the {{l|Timetrack}}
 
indicates its interpolation type:
 
indicates its interpolation type:
  
Line 78: Line 86:
 
</gallery>
 
</gallery>
  
Each waypoint is split into two halves.  The left half indicates its
+
Each Waypoint is split into two halves.  The left half indicates its
'in interpolation' and the right half indicates its 'out
+
{{Literal|In}} interpolation and the right half indicates its {{Literal|Out}}
interpolation', so many different combinations are possible:
+
interpolation, so many different combinations are possible:
  
 
{{l|Image:Waypoint-combos.png}}
 
{{l|Image:Waypoint-combos.png}}
  
In the chart above the 'in' interpolation is shown on the left, and the 'out' interpolation is shown across the top.
+
In the chart above the {{Literal|In}} interpolation is shown on the left, and the {{Literal|Out}} interpolation is shown across the top.
  
 
Note: the .sif file used to generate these screenshots is
 
Note: the .sif file used to generate these screenshots is
Line 91: Line 99:
 
Here is an [http://dooglus.rincevent.net/synfig/interpolation.sif
 
Here is an [http://dooglus.rincevent.net/synfig/interpolation.sif
 
experimental .sif file] showing 25 different blobs, and how they move
 
experimental .sif file] showing 25 different blobs, and how they move
with different combinations of waypoints.  It renders to a
+
with different combinations of Waypoints.  It renders to a
 
[http://dooglus.rincevent.net/synfig/interpolation.avi 634K .avi
 
[http://dooglus.rincevent.net/synfig/interpolation.avi 634K .avi
 
file], and is available in lower resolution
 
file], and is available in lower resolution
 
[http://www.youtube.com/watch?v=SI1VaH2psts on YouTube].  Notice how:
 
[http://www.youtube.com/watch?v=SI1VaH2psts on YouTube].  Notice how:
* the blobs with any red (constant) on them don't move at all
+
* the blobs with any red ({{l|Constant|Constant}}) on them don't move at all
* the yellow (linear) sides of blobs 'bounce' off the walls
+
* the yellow ({{l|Linear|Linear}}) sides of blobs 'bounce' off the walls
* the cyan (ease) sides slow gracefully to a halt at the walls
+
* the cyan ({{l|Ease In/Out|Ease}}) sides slow gracefully to a halt at the walls
* the green (TCB smooth) sides bounce at the top (the animation is a single down-and-up animation, looped, so there's no 'context' at the top for the TCB to fit the curve to) but act smoothly at the bottom
+
* the green ({{l|TCB|TCB Smooth}}) sides bounce at the top (the animation is a single down-and-up animation, looped, so there's no 'context' at the top for the TCB to fit the curve to) but act smoothly at the bottom
  
The 'undefined' (grey) symbol is used when the row in the timetrack
+
The 'undefined' (grey) symbol is used when the row in the {{l|Timetrack_Panel}} represents multiple Waypoints.  For example, the 'vertices'
dialog represents multiple waypoints.  For example, the 'vertices'
+
row represents all the vertices making up a Spline.  Each of those
row represents all the vertices making up a bline.  Each of those
+
vertices can have multiple Waypoints, each with different
vertices can have multiple waypoints, each with different
+
 
interpolations.  If all the interpolations are the same, that
 
interpolations.  If all the interpolations are the same, that
 
interpolation's symbol will be used.  Otherwise, the grey 'undefined'
 
interpolation's symbol will be used.  Otherwise, the grey 'undefined'
 
symbol is used.
 
symbol is used.
  
Look at the waypoints below. They are from the timetrack for the {{Literal|Vertices}} of an Outline layer.
+
Look at the Waypoints below. They are from the Timetrack for the {{Literal|Vertices}} of an {{l|Outline Layer}}.
  
 
{{l|Image:Waypoints-undefined.png}}
 
{{l|Image:Waypoints-undefined.png}}
  
You'll see the left side of each of the Waypoints is colored. This means the 'in' interpolation for each vertex is the same. However, the right side is grey, indicating that the 'out' interpolation for each vertex differs.
+
You'll see the left side of each of the Waypoints is colored. This means the {{Literal|In}} interpolation for each vertex is the same. However, the right side is grey, indicating that the {{Literal|Out}} interpolation for each vertex differs.
  
 
TODO: rewrite the above so it doesn't hurt the brain so much.
 
TODO: rewrite the above so it doesn't hurt the brain so much.

Revision as of 05:15, 18 February 2013

Languages Language: 

English • suomi • français


Introduction

"Waypoints" are the graphical symbols that show up on the Timetrack panel. Each time the value of a parameter is edited in animate editing mode, a Waypoint will be created. For example, when you adjust a "Tangent" Handle of a vertex in a Spline, a "Waypoint" will be created to note the change. However, you didn't really adjust the tangent, you adjusted the two parameters which define the tangent: its angle ("Theta"), and its length ("Radius"). Opening up the tangent's nodes in the Parameters Panel will show that "Waypoints" have been created against each of these 2 parameters.

As a result of adjusting a single "Tangent" Handle, "Waypoint" have been created as follows:

  • the length of the tangent changed ("Radius")
  • the angle of the tangent changed ("Theta")
  • the tangent changed ("Tangent 1")
  • the vertex changed ("Vertex 001")
  • the vertices changes ("Vertices")

Only the first 2 of these are 'leaf waypoints' - the rest are parents (and grandparents, etc) of these 2 waypoints.

As things currently stand, it is only possible to delete one leaf waypoint at a time. If, for example, you want to delete the change made to the "Tangent" Handle above, you'll need to open up the tangent and delete both the "Theta" and "Radius" Waypoints. The ability to delete whole trees of waypoints with a single click would be useful, as would the ability to select multiple waypoints at once, and operate upon them en masse.

Editing Waypoints

Waypoints can be dragged left or right with the left mouse button to change the time at which they act upon their parameter(s). If you drag a parent's Waypoint, all its child Waypoints will move with it.

Right-clicking on Waypoint shows a context menu, containing:

  • "Jump to": Set the current time to be the time of the waypoint.
  • "Duplicate": Only appears for single-leaf Waypoints. Creates a copy of the current Waypoint at the currently selected time.
  • "Remove": Only appears for single-leaf waypoints. Deletes the Waypoint.
  • "Remove n Waypoints": Only appears for multi-leaf waypoints. Deletes the n Waypoints.
  • "Edit": Only appears for single-leaf Waypoints.
  TODO: writeme (brings up a dialog allowing various parameters to be set).
  • "Both".: Allows you to change the "In" and "Out" interpolation setting for the Waypoint and all its children.
  • "In".: Allows you to change the "In" interpolation setting for the Waypoint and all its children.
  • "Out".: Allows you to change the "Out" interpolation setting for the Waypoint and all its children.

If the Waypoint is Linked other menu entries related to the link will appear up to those one.

  TODO: writeme (describe added menu entries in case of linked waypoint)

Interpolation

Each Waypoint has an "In" and an "Out" interpolation setting, which determines the manner in which its parameter changes - whether it changes linearly over time, or follows a curve.

The "In" interpolation defines how the parameter changes in the moments before the Waypoint is reached, and "Out" defines how it changes in the moments after the Waypoint. Available interpolation types are as follows:

  • TCB Smooth: If you imagine a graph of the parameter's value against time, using the TCB interpolation type will fit a smooth curve between adjacent waypoints, much like the Spline Tool fits smooth curves between adjacent spline vertices.
  • Clamped: Acts like TCB interpolation, but never "overshoots" (or "undershoots") the values you set in the Parameters Panel.
  • Constant: Stops the animation.
  • Ease In/Out: The graph is horizontal as it leaves the Waypoint.
  • Linear: The graph of parameter value against time is a straight line.
  • Undefined: This is only shown for multi-leaf Waypoints, where there is more than one different interpolation type amongst its leaf Waypoints.

Graphical Representation

The color and shape of the Waypoint as displayed in the Timetrack indicates its interpolation type:

Each Waypoint is split into two halves. The left half indicates its "In" interpolation and the right half indicates its "Out" interpolation, so many different combinations are possible:

Image:Waypoint-combos.png

In the chart above the "In" interpolation is shown on the left, and the "Out" interpolation is shown across the top.

Note: the .sif file used to generate these screenshots is available. [1]

Here is an [http://dooglus.rincevent.net/synfig/interpolation.sif experimental .sif file] showing 25 different blobs, and how they move with different combinations of Waypoints. It renders to a [http://dooglus.rincevent.net/synfig/interpolation.avi 634K .avi file], and is available in lower resolution on YouTube. Notice how:

  • the blobs with any red (Constant) on them don't move at all
  • the yellow (Linear) sides of blobs 'bounce' off the walls
  • the cyan (Ease) sides slow gracefully to a halt at the walls
  • the green (TCB Smooth) sides bounce at the top (the animation is a single down-and-up animation, looped, so there's no 'context' at the top for the TCB to fit the curve to) but act smoothly at the bottom

The 'undefined' (grey) symbol is used when the row in the Time Track Panel represents multiple Waypoints. For example, the 'vertices' row represents all the vertices making up a Spline. Each of those vertices can have multiple Waypoints, each with different interpolations. If all the interpolations are the same, that interpolation's symbol will be used. Otherwise, the grey 'undefined' symbol is used.

Look at the Waypoints below. They are from the Timetrack for the "Vertices" of an Outline Layer.

Image:Waypoints-undefined.png

You'll see the left side of each of the Waypoints is colored. This means the "In" interpolation for each vertex is the same. However, the right side is grey, indicating that the "Out" interpolation for each vertex differs.

TODO: rewrite the above so it doesn't hurt the brain so much.


Languages Language: 

English • suomi • français