Difference between revisions of "Waypoint"

From Synfig Studio :: Documentation
Jump to: navigation, search
m
m (first attempt at documenting waypoints - needs more work)
Line 1: Line 1:
Waypoints are the graphical symbols that show up on the [[timetrack]] dialog.  Each time the value of a parameter is edited in Animate Editing Mode, a waypoint will be created.
+
Waypoints are the graphical symbols that show up on the [[timetrack]] dialog.  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 duck of a vertex in a bline, 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' node in the params dialog will show that waypoints have been created against each of these 2 parameters.
 +
 
 +
As a result of adjusting a single tangent duck, waypoints 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 ('Verticies')
 +
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 duck 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.
 +
* Edit waypoint: Only appears for single-leaf waypoints.  TODO: writeme (brings up a dialog allowing various parameters to be set).
 +
* Duplicate: Only appears for single-leaf waypoints.  creates a copy of the current waypoint at the currently selected time.
 +
* Delete: Only appears for single-leaf waypoints.  deletes the waypoint.
 +
* 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.
 +
 
 +
==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.
 +
 
 +
TODO: document the various types of interpolation.  What does TCB stand for?  Etc.
  
 
The colour and shape of the waypoint indicates its interpolation type:
 
The colour and shape of the waypoint indicates its interpolation type:

Revision as of 22:49, 24 March 2007

Languages Language: 

English • suomi • français


Waypoints are the graphical symbols that show up on the timetrack dialog. 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 duck of a vertex in a bline, 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' node in the params dialog will show that waypoints have been created against each of these 2 parameters.

As a result of adjusting a single tangent duck, waypoints 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 ('Verticies')

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 duck 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.
  • Edit waypoint: Only appears for single-leaf waypoints. TODO: writeme (brings up a dialog allowing various parameters to be set).
  • Duplicate: Only appears for single-leaf waypoints. creates a copy of the current waypoint at the currently selected time.
  • Delete: Only appears for single-leaf waypoints. deletes the waypoint.
  • 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.

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.

TODO: document the various types of interpolation. What does TCB stand for? Etc.

The colour and shape of the waypoint indicates its interpolation type:

waypoint-colours.png

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. The following waypoints are from 5 verticies of a single bline:

waypoints-all.png

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

The 'undefined' (grey) symbol is used when the row in the timetrack dialog represents multiple waypoints. For example, the 'verticies' row represents all the verticies making up a bline. Each of those verticies 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.

The following waypoints are from the 'verticies' row of the same bline as before. Notice that since the left side of each of the waypoints is coloured, indicating that the 'in' interpolation of the verticies are the same for all verticies, whereas the right side is grey, indicating that there is more than one 'out' interpolation in each column.

waypoints-undef.png

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


Languages Language: 

English • suomi • français