Difference between revisions of "Convert"

From Synfig Studio :: Documentation
Jump to: navigation, search
m (→‎Radial Composite)
m (→‎Overview: parabolic image)
 
(267 intermediate revisions by 12 users not shown)
Line 1: Line 1:
−
Right-clicking on a value in the Parameters dialog brings up a context menu which has a sub-menu called "Convert". The "Convert" menu allows you to specify that the parameter should be controlled automatically in various ways. Depending on the type of the parameter the Convert menu will contain different options.
+
<!-- Page info -->
 +
{{Title|Convert}}
 +
{{TOCright}}
 +
{{Category|Glossary}}
 +
{{NewTerminology}}
 +
{{Category|Data Linking}}
 +
<!-- Page info end -->
 +
  * This page need a better formating (for example sorting by categories : math/angle/boolean/...)
 +
  * Some convert types are missing [https://github.com/synfig/synfig/blob/master/synfig-core/src/synfig/valuenode.cpp#L151 see here]
  
−
To convert the value back to its original type, select "Disconnect" from its context menu.
+
==Overview==
 +
Right-clicking on a value in the {{l|Parameters Panel}} brings up a context menu which has a sub-menu called {{Literal|Convert}}.
  
−
* Angle values can be converted to [[Convert#Linear|Linear]], [[Convert#Reference|Reference]], [[Convert#Scale|Scale]], and [[Convert#Subtract|Subtract]] types.
+
The {{Literal|Convert}} menu allows you to specify that the parameter should be controlled automatically in various ways or used in mathematical formulas. Depending on the type of the parameter the Convert menu will contain different options.
  
−
* BLinePoint values can be converted to ...
+
To convert the parameter back to its original type, select {{Literal|Disconnect}} from its context menu.
  
−
* Bool values can only be converted to the [[Convert#Reference|Reference]] type.
+
[[File:Parabolic-Shot.gif|frame|center|100px|You can have a look to the {{l|Parabolic Shot}} tutorial for a "real life" use of the {{l|Convert}} feature.
 +
]]
  
−
* Canvas values can be converted to the [[Convert#Reference|Reference]] type.
+
{{Note|Converting animated values|When a parameter is animated it is (internally) converted to '''Animated Value node'''. Converting to another '''Convert Types''' replaces the link. }}
  
−
* Color values can be converted to [[Convert#Composite|Composite]], [[Convert#Radial Composite|Radial Composite]], [[Convert#Reference|Reference]], [[Convert#Scale|Scale]], and [[Convert#Subtract|Subtract]] types.
+
== Convert Types ==
  
−
* Gradient values can be converted to [[Convert#Gradient Rotate|Gradient Rotate]], [[Convert##Reference|Reference]], [[Convert#Stripes|Stripes]], and [[Convert#Two-Tone|Two-Tone]] types.
+
=== Add ===
  
−
* Integer values can be converted to [[Convert#Reference|Reference]], [[Convert#Scale|Scale]], and [[Convert#Subtract|Subtract]] types.
+
Converting a parameter to {{Literal|Add}} adds three sub-parameters, the first two of which are the same type as the parameter itself:
 +
* <param> "LHS"
 +
* <param> "RHS"
 +
* real "Scalar"
  
−
* List values can be converted to [[Convert#BLine|BLine]], [[Convert#Dynamic List|Dynamic List]], and [[Convert#Reference|Reference]] types.
+
The {{Literal|Add}} conversion can be used with parameters of type {{l|Convert#Angle|angle}}, {{l|Convert#Color|color}}, {{l|Convert#Gradient|gradient}}, {{l|Convert#Integer|integer}}, {{l|Convert#Real|real}}, {{l|Convert#Time|time}}, and {{l|Convert#Vector|vector}}.
  
−
* Real values can be converted to [[Convert#Linear|Linear]], [[Convert#Reference|Reference]], [[Convert#Scale|Scale]], [[Convert#Sine|Sine]], and [[Convert#Subtract|Subtract]] types.
+
The resulting value is:
 +
  (LHS + RHS) * Scalar
  
−
* Segment values can be converted to the [[Convert#Composite|Composite]] and [[Convert#Reference|Reference]] types.
+
=== And ===
  
−
* String values can be converted to the [[Convert#Reference|Reference]] type.
+
Converting a {{l|Convert#Bool|bool}} parameter to {{Literal|And}} adds two sub-parameters:
 +
* bool "Link1"
 +
* bool "Link2"
  
−
* Time values can be converted to the [[Convert#Linear|Linear]] and [[Convert#Reference|Reference]] types.
+
The resulting value is true only if both Link1 and Link2 are true.
  
−
* Vector values can be converted to [[Convert#Composite|Composite]], [[Convert#Linear|Linear]], [[Convert#Radial Composite|Radial Composite]], [[Convert#Reference|Reference]], [[Convert#Scale|Scale]], [[Convert#Seg Calc Tangent|Seg Calc Tangent]], [[Convert#Seg Calc Vertex|Seg Calc Vertex]], and [[Convert#Subtract|Subtract]] types.
 
  
−
== BLine ==
+
=== Angle String ===
  
−
Converting a parameter to "BLine" doesn't seem to change anything.  Perhaps that's the default type for lists of verticies, such as are found in outlines and regions?
+
Converting an {{l|Convert#String|string}}-valued parameter to {{Literal|Angle String}} adds four sub-parameters:
 +
* angle "Angle"
 +
* integer "Width"
 +
* integer "Precision"
 +
* bool "Zero Padded"
  
−
== Composite ==
+
The resulting value a string containing the value of {{Literal|Angle}} (in degrees) formatted as a string with a minimum width {{Literal|Width}}, with {{Literal|Precision}} decimal places. If {{Literal|Zero Padded}} is true, it will be left-padded with '''0''' characters.
  
−
Converting a parameter to "Composite" adds four real-valued sub-parameters called "Red", "Green", "Blue", and "Alpha".
+
=== aTan2 ===
  
−
== Dynamic List ==
+
Converting an {{l|Convert#Angle|angle}}-valued parameter to {{Literal|aTan2}} adds two sub-parameters:
 +
* real "X"
 +
* real "Y".
  
−
Converting a parameter to "Dynamic List" seems to replace each of the "Vertex NNN" sub-parameters with "Item NNN" parameters which can't be expanded, but can be exported.
+
The resulting value is:
 +
  atan2(y,x)
  
−
== Gradient Rotate ==
+
ie. atan(y/x) but without an error when x is '''0'''. The value is the angle between the x axis and the vector (x,y).
  
−
writeme
+
=== Spline ===
  
−
== Linear ==
+
Converting a {{l|Convert#List|list}} parameter to {{Literal|Spline}} doesn't seem to change anything. Perhaps that's the default type for lists of vertices, such as are found in outlines and regions?
  
−
Converting a real parameter to be 'Linear' adds two real-valued sub-parameters "Rate" and "Offset" for controlling the parameter's value.
+
=== Compare ===
  
−
The parameter's value will change linearly over time, start with the value specified by "Offset" at time zero, and increasing by the value specified by "Rate" every second.
+
Converting a {{l|Convert#Bool|bool}} parameter to {{Literal|Compare}} adds five sub-parameters:
 +
* real "LHS"
 +
* real "RHS"
 +
* bool "Greater than"
 +
* bool "Equal to"
 +
* bool "Less than"
  
−
However, converting a vector parameter to be 'Linear' adds two vector sub-parameters called "Slope" and "Offset". These work just like "Rate" and "Offset" above, but in two dimensions instead of one.  (So it looks like each of these subsections can behave differently depending on the type of the value being converted - so I'll probably have to re-arrange this page...)
+
The valuenode compares {{Literal|LHS}} and {{Literal|RHS}}. The three boolean values determine which comparison returns '''true'''. For example, if LHS>RHS and {{Literal|Greater than}} is checked, the valuenode will evaluate to '''true'''.
  
−
== Radial Composite ==
+
=== Composite ===
  
−
Converting a color to "Radial Composite" adds four sub-parameters called "Luma", "Saturation", "Hue", and "Alpha".  "Hue" is an angle value and the other three are real values.
+
Converting a {{l|Convert#Spline Point|Spline Point}} parameter to {{Literal|Composite}} adds six sub-parameters:
 +
* vector "Vertex"
 +
* real "Width"
 +
* real "Origin"
 +
* bool "Split Tangents"
 +
* vector "Tangent 1"
 +
* vector "Tangent 2"
  
−
Converting a vector to "Radial Composite" adds two sub-parameters: a real called "Radius" and an angle called "Theta".  Specifying an angle and a distance from the origin gives us a point, which is used as the value for the vector.
+
Converting a {{l|Convert#Color|color}} parameter to {{Literal|Composite}} adds four real-valued sub-parameters:
 +
* real "Red"
 +
* real "Green"
 +
* real "Blue"
 +
* real "Alpha"
  
−
== Reference ==
+
Converting a {{l|Convert#Segment|segment}} parameter to {{Literal|Composite}} adds four vertex sub-parameters:
 +
* vertex "Vertex 1"
 +
* vertex "Tangent 1"
 +
* vertex "Vertex 2"
 +
* vertex "Tangent 2"
  
−
Converting a parameter to "Reference" adds a single real-valued sub-parameter called "Link".
+
Converting a {{l|Convert#Vector|vector}} parameter to {{Literal|Composite}} adds two real-valued sub-parameters:
 +
* real "X-Axis"
 +
* real "Y-Axis"
  
−
== Scale ==
+
The resulting value is a Spline Point, Color, Segment, or Vector made by combining the component parts.
  
−
Converting a parameter to "Scale" adds two real-valued sub-parameters called "Link" and "Scalar".
+
==== Composite for {{l|Group Layer}}====
 +
The {{Literal|Transformation}} parameter of a {{l|Group Layer}} and {{l|Switch Group Layer}} is a composite parameter, it hold an {{l|Offset Parameter|Offset}}, {{l|Rotation Parameter|Rotation}}, {{l|Skew Parameter|Skew}} and {{l|Scale Parameter|Scale}} subparameter for the group.
  
−
== Seg Calc Tangent ==
+
=== Cos ===
  
−
Converting a parameter to "Seg Calc Tangent" adds two sub-parameters called "Segment" and "Amount".  "Segment" is a composite type containing two vertices and two tangents.  "Amount" is a real value.
+
Converting a {{l|Convert#Real|real}}-valued parameter to {{Literal|Cos}} adds two sub-parameters:
 +
* angle "Angle"
 +
* real "Amplitude".
  
−
== Seg Calc Vertex ==
+
The resulting value is:
 +
  {{Literal|Amplitude}} * cos({{Literal|Angle}})
  
−
Converting a parameter to "Seg Calc Vertex" adds two sub-parameters called "Segment" and "Amount".  "Segment" is a composite type containing two vertices and two tangents.  "Amount" is a real value.
+
=== Derivative ===
  
−
== Sine ==
+
It allows to calculate the derivative (first or second order) of a given value node using the finite differences method. It has the following sub parameters:
  
−
Converting a parameter to "Sine" adds two sub-parameters: a angle value called "Angle" and a real-valued value called "Amplitude".
+
* real "Link" : Value Node whom is calculated the derivative (Real, Angle, Time, Vector)
 +
* real "Interval" : Size of the interval to calculate the finite differences (Real >0).
 +
* integer "Accuracy" : Accuracy order. (ROUGH, NORMAL, FINE & EXTREME)
 +
* integer "Order" : First or Second order derivative (FIRST, SECOND)
  
−
== Stripes ==
+
=== Dot Product ===
  
−
writeme
+
Converting a {{l|Convert#Real|real}} or {{l|Convert#Angle|angle}} parameter to a {{Literal|Dot Product}} adds two sub-parameters:
 +
* vector "LHS"
 +
* vector "RHS"
  
−
== Subtract ==
+
If the converted value is an angle, the return value is the angle between the two vectors:
  
−
Converting a parameter to "Subtract" adds three real-valued sub-parameters called "LHS", "RHS", and "Scalar".
+
return = acos((LHS · RHS) / (|LHS| * |RHS|))
  
−
== Timed Swap ==
+
If the converted value is a real, the result value is the dot product of the two vectors:
  
−
This conversion is currently disabled.
+
return = LHS · RHS = |LHS| * |RHS| * cos(alpha)
  
−
== Two-Tone ==
+
(where alpha is the angle between {{Literal|LHS}} and {{Literal|RHS}}).
  
−
Converting a parameter to "Two-Tone" adds two color-valued sub-parameters called "Color1" and "Color2".
+
=== Duplicate ===
  
−
The two parameters define two colors which are used to create the gradient.  These color parameters can be animated, giving us the ability to have the gradient change color over time. This can be used as a workaround for [http://sourceforge.net/tracker/index.php?func=detail&aid=1568818&group_id=144022&atid=757416 this bug].
+
This ValueNode type is only used by the {{l|Duplicate Layer}}. It never appears in the {{Literal|Convert}} menu. It is used to control the range of the Index in the Duplicate Layer (q.v.).
 +
 
 +
The {{Literal|Duplicate}} ValueNode type has 3 real-valued sub-parameters:
 +
 
 +
* real "From"
 +
* real "To"
 +
* real "Step"
 +
 
 +
The value of the ValueNode varies from the value of {{Literal|From}} to the value of {{Literal|To}} in steps of size {{Literal|Step}}. The sign of {{Literal|Step}} is ignored. If From<To the steps are positive, else they're negative.
 +
 
 +
=== Dynamic ===
 +
 
 +
Allows to link two vectors with a dynamic link. The ValueNode (vector type) that is converted to {{Literal|Dynamic}} will be linked to another vector value using a linear/rotational spring system with damping and friction.
 +
 
 +
{|border="0" align="center" style="border-collapse" cellpadding="0" cellspacing="0"
 +
|-
 +
|| [[Image:Convert-Dynamic-Example1.gif|center|c|thumb|[[File:Convert-Dynamics-Example1-project.sifz]]]]
 +
|| [[Image:Convert-Dynamic-Example2.gif|center|c|thumb|[[File:Convert-Dynamics-Example2-project.sifz]]]]
 +
|}
 +
Once you convert the Value to {{Literal|Dynamic}} it offers the following sub-parameters:
 +
 
 +
* vector {{Literal|Tip Static}} This is the equilibrium position of the system without external forces relative to the Origin. See Origin. Since it is a vector its length is used for the linear spring equilibrium length and its angle form the x axis is used for the torsion spring equilibrium angle. The initial value of this subparameter is the current value of the Value that is being converted to Dynamic.
 +
* vector {{Literal|Origin}} This is the basement of the dynamic system. Defaults to ('''0.0''', '''0.0'''). If the user changes this value the final equilibrium calculated position of the value is modified too. Accelerations of the Origin are used to move the Tip due to the fictitious forces needed to apply under non inertial reference systems.
 +
* vector {{Literal|Force}} External force applied on the Tip of the dynamic system. Defaults to ('''0.0''', '''0.0''').
 +
* real {{Literal|Torque}} External momentum applied tot he dynamic system at the Origin. Defaults to '''0.0'''.
 +
* real {{Literal|Damping}} Damper coefficient of the linear link. Defaults to '''0.4'''
 +
* real {{Literal|Friction}} Friction coefficient of the rotational link. Defaults to '''0.4'''
 +
* real {{Literal|Spring}} Spring coefficient of the linear link. Defaults to '''30.0'''
 +
* real {{Literal|Torsion}} Torsion coefficient of the rotational link. Defaults to '''30.0'''
 +
* real {{Literal|Mass}} Mass of the dynamic system. Defaults to '''0.3'''
 +
* real {{Literal|Inertia}} Moment of inertia of the dynamic system. Defaults to '''0.3'''
 +
* bool {{Literal|Spring rigid}} When checked linear spring is rigid. Defaults to '''off'''
 +
* bool {{Literal|Torsion rigid}} When checked torsion spring is rigid. Defaults to '''off'''
 +
* bool {{Literal|Origin drags tip}} When checked result is origin + dynamic tip otherwise result is just dynamic tip. Defaults to '''off'''
 +
 
 +
==== Comments ====
 +
[[Image:Dynamics.png|right|thumb|500px|Graphical representation of the dynamics system]]The movement of the Origin produces two effects. It drags the resulting vector the same amount of the Origin along the time (that is the resulting vector is the sum of the Origin(t) + dynamic tip(t)) and its acceleration produces an inertial force contrary to the acceleration direction and magnitude.
 +
 
 +
The Torque only affects the angle of the resulting vector respect to the Origin. This means that the mass center of gravity is located at the origin (where the torque is applied) and so there is not centrifugal effects.
 +
 
 +
Since the Origin only can be translated and not rotated, there are not Coriolis forces.
 +
 
 +
The Force is applied on the tip position so it would produce effects on the angle and on the length of the tip. Force (F) is decomposed into two vectors one aligned with the Tip vector (Fr) and other perpendicular (Fa). The one aligned (Fr) is used on the linear damper spring equations. The one perpendicular (Fa) is used as additional torque by this expression Fr*R (where R is the variable length of the Tip vector)
 +
 
 +
If Mass (Inertia) reaches near to zero, then the movement for linear (rotational) link is disabled.
 +
 
 +
User is responsible of the meaning of the values of the parameters (i.e. negative mass, or negative friction or spring constant)
 +
 
 +
Origin is automatically connected to a subparameter of an internal Value Node in order to calculate the second derivative of the Origin (that is the acceleration of the Origin). '''Do not''' Disconnect Origin value node. Export it instead and link or connect other Value Nodes to the exported.
 +
 
 +
=== Dynamic List ===
 +
 
 +
Converting a {{l|Convert#List|list}} parameter to {{Literal|Dynamic List}} seems to replace each of the {{Literal|Vertex NNN}} sub-parameters with {{Literal|Item NNN}} parameters which '''can't be expanded''', but can be {{l|export}}ed.
 +
 
 +
=== Exponential ===
 +
 
 +
Converting a {{l|Convert#Real|real}} parameter to {{Literal|Exponential}} adds two sub-parameters:
 +
 
 +
* real "Exponent"
 +
* real "Scale"
 +
 
 +
The resulting value is the result raising the [http://en.wikipedia.org/wiki/E_%28mathematical_constant%29 mathematical constant 'e'] to the power of {{Literal|Exponent}}, and scaling the result by {{Literal|Scale}}. That is, it returns:
 +
  Scale * e^Exponent
 +
 
 +
This is useful for tracking layers which have been zoomed, since the {{l|Zoom Layer}} scales by e^(zoom factor).
 +
 
 +
See [http://youtube.com/watch?v=GAWtndOHkUw this video] for an example of the use of this convert type.
 +
 
 +
=== From Integer ===
 +
 
 +
This is currently disabled. It converts an integer to one of several types.
 +
 
 +
=== Gradient Color ===
 +
 
 +
Converting a {{l|Convert#Color|color}} parameter to {{Literal|Gradient Color}} adds two sub-parameters:
 +
 
 +
* gradient "Gradient"
 +
* real "Index"
 +
 
 +
The resulting value is a color taken from the {{l|Gradient Tool}} at the given index position. {{Literal|Index}} '''0''' corresponds to the left of the {{Literal|Gradient}}; {{Literal|Index}} '''1''' corresponds to the right of the {{Literal|Gradient}}.
 +
 
 +
=== Gradient Rotate ===
 +
 
 +
Converting a {{l|Convert#Gradient|gradient}} parameter to {{Literal|Gradient Rotate}} adds two sub-parameters:
 +
 
 +
* gradient "Gradient"
 +
* real "Offset"
 +
 
 +
The resulting value is a gradient based on the {{Literal|Gradient}} parameter, but shifted left (for negative values) or right, according to the value of the {{Literal|Offset}} parameter.  An offset of '''1.0''' will shift the gradient by its entire visible width. Values shifted off the left or right edge aren't lost - they aren't visible in the gradient as it's displayed in the parameters dialog, but they will still be used when rendering (depending on parameters such as {{Literal|Loop}} and {{Literal|Zigzag}}, which can cause gradients to be looped between their their left and right edges, rather than using the non-displayed parts).
 +
 
 +
=== Int String ===
 +
 
 +
Converting an {{l|Convert#String|string}}-valued parameter to {{Literal|Int String}} adds three sub-parameters:
 +
* integer "Int"
 +
* integer "Width"
 +
* bool "Zero Padded"
 +
 
 +
The resulting value a string containing {{Literal|Int}} formatted as a string with a minimum width {{Literal|Width}}.  If {{Literal|Zero Padded}} is '''true''', it will be left-padded with "0" characters.
 +
 
 +
=== Joined List ===
 +
 
 +
Converting a {{l|Convert#String|string}} parameter to be {{Literal|Joined List}} adds four sub-parameters:
 +
* list "Strings"
 +
* string "Before"
 +
* string "Separator"
 +
* string "After"
 +
 
 +
The result is a string containing the value of {{Literal|Before}}, followed by all the strings in the {{Literal|Strings}} list, with the value of {{Literal|Separator}} between each pair, followed by the value of {{Literal|After}}.
 +
 
 +
=== Linear ===
 +
 
 +
Converting an {{l|Convert#Angle|angle}} parameter to be {{Literal|Linear}} adds two angle sub-parameters:
 +
* angle "Rate"
 +
* angle "Offset"
 +
 
 +
Converting a {{l|Convert#Color|color}} parameter to be {{Literal|Linear}} adds two angle sub-parameters:
 +
* color "Rate"
 +
* color "Offset"
 +
 
 +
Converting an {{l|Convert#Integer|integer}} parameter to be {{Literal|Linear}} adds two angle sub-parameters:
 +
* integer "Rate"
 +
* integer "Offset"
 +
 
 +
Converting a {{l|Convert#Real|real}} parameter to be {{Literal|Linear}} adds two real-valued sub-parameters:
 +
* real "Rate"
 +
* real "Offset"
 +
 
 +
Converting a {{l|Convert#Time|time}} parameter to be {{Literal|Linear}} adds two time sub-parameters:
 +
* time "Rate"
 +
* time "Offset"
 +
 
 +
Converting a {{l|Convert#Vector|vector}} parameter to be {{Literal|Linear}} adds two vector sub-parameters:
 +
* vector "Slope"
 +
* vector "Offset"
 +
 
 +
The parameter's value will change linearly over time, starting with the value specified by {{Literal|Offset}} at time zero, and increasing by the value specified by {{Literal|Rate}} (or {{Literal|Slope}}, in the case of vector parameters) every second.
 +
 
 +
The resulting value for vector parameters is:
 +
  Offset + Slope*time
 +
 
 +
and for the other 5 types of parameter it is:
 +
  Offset + Rate*time
 +
 
 +
=== Logarithm ===
 +
 
 +
Converting a {{l|Convert#Real|real}}-valued parameter to {{Literal|Logarithm}} adds three sub-parameters:
 +
 
 +
* real "Link"
 +
* real "Epsilon".
 +
* real "Infinite".
 +
 
 +
The resulting value is:
 +
 
 +
  Log(Link) (if Link >= Epsilon)
 +
  -Infinite (if Link < Epsilon)
 +
 
 +
The {{Literal|Epsilon}} and {{Literal|Infinite}} parameters are only needed to prevent logarithm of negative or zero numbers. For regular operation the resulting value is simply the natural logarithm of {{Literal|Link}}. In fact a logarithm of a negative number cannot be calculated in the space of Real numbers. This convert type returns -Infinite for simplicity.
 +
 
 +
=== Not ===
 +
 
 +
Converting a {{l|Convert#Bool|bool}} parameter to {{Literal|Not}} adds one sub-parameter:
 +
* bool "Link"
 +
 
 +
The resulting value is the opposite of {{Literal|Link}}.
 +
 
 +
=== Or ===
 +
 
 +
Converting a {{l|Convert#Bool|bool}} parameter to {{Literal|Or}} adds two sub-parameters:
 +
* bool "Link1"
 +
* bool "Link2"
 +
 
 +
The resulting value is true if either {{Literal|Link1}}, {{Literal|Link2}}, or both are '''true'''.
 +
 
 +
=== Power ===
 +
 
 +
Converting a {{l|Convert#Real|real}}-valued parameter to {{Literal|Power}} adds three sub-parameters:
 +
* real "Base"
 +
* real "Power"
 +
* real "Epsilon".
 +
* real "Infinite".
 +
 
 +
The resulting value is Base^Power if the operation is defined.
 +
The undefined cases will also return a value (to avoid errors):
 +
  0^0 = 1
 +
  0^-x = +/- infinite
 +
  If a negative base is raised to a noninteger power, the power is rounded (typecast) to an integer
 +
 
 +
The {{Literal|Epsilon}} and {{Literal|Infinite}} parameters are only needed to prevent division by zero.
 +
 
 +
===Reverse===
 +
 
 +
It operates on every type I could figure out how to reverse: lists, strings, spline points and segments, gradients, width points, and dash items.
 +
 
 +
From the {{l|Parameters Panel}}, select what you want to reverse, right click and select {{c|Convert|Reverse}}
 +
 
 +
When reversing a list, it also reverses the individual elements of that list, meaning that, for instance, a spline will look exactly the same after being reversed.
 +
 
 +
=== Radial Composite ===
 +
 
 +
Converting a {{l|Convert#Color|color}} to {{Literal|Radial Composite}} adds four sub-parameters:
 +
* real "Luma"
 +
* real "Saturation"
 +
* angle "Hue"
 +
* real "Alpha"
 +
 
 +
Converting a {{l|Convert#Vector|vector}} to {{Literal|Radial Composite}} adds two sub-parameters:
 +
* real "Radius"
 +
* angle "Theta"
 +
 
 +
For color parameters, the resulting value is the color with the given {{Literal|Luma}}, {{Literal|Saturation}}, {{Literal|Hue}}, and {{Literal|Alpha}} amounts.
 +
 
 +
For vector parameters, the resulting value is the point reached by traveling a distance {{Literal|Radius}} from the origin, in the distance given by the angle {{Literal|Theta}}.
 +
 
 +
=== Random ===
 +
 
 +
Converting a parameter to {{Literal|Random}} adds five sub-parameters, the first of which is the same type as the converted parameter:
 +
 
 +
* <param> "Link"
 +
* real "Radius"
 +
* integer "Seed"
 +
* real "Animation Speed"
 +
* integer "Interpolation"
 +
* real "Loop Time"
 +
 
 +
{{Literal|Random}} can be used on {{l|Convert#Angle|angles}}, {{l|Convert#Color|colors}}, {{l|Convert#Integer|integers}}, {{l|Convert#Real|reals}}, {{l|Convert#Time|times}}, and {{l|Convert#Vector|vectors}}.
 +
 
 +
It is used to cause a parameter's value to vary randomly over time, around a central value:
 +
 
 +
* {{Literal|Link}} provides the central value.
 +
* {{Literal|Radius}} defines the maximum random difference.
 +
* {{Literal|Seed}} seeds the random number generator
 +
* {{Literal|Animation Speed}} defines how often a new random value is chosen (in choices per second)
 +
* {{Literal|Interpolation}} determines how the value is interpolated from one random choice to the next.  Possible values are:
 +
** '''0''' - no interpolation; the value jumps from one value to the next
 +
** '''1''' - linear interpolation
 +
** '''2''' - cosine
 +
** '''3''' - spline
 +
** '''4''' - cubic (the default); uses [http://www.gamedev.net/reference/articles/article1497.asp Catmull-Rom] spline interpolation
 +
* {{Literal|Loop Time}} makes the random value repeat after the given time. The value ends up the same at the given time as at time=0 so it's possible to make random looping animations without a nasty jump when the time wraps back to zero.
 +
 
 +
The {{Literal|Interpolation}} sub-parameter should really be a drop-down menu, rather than an integer field, but that isn't yet implemented.
 +
 
 +
=== Range ===
 +
 
 +
Converting a parameter to {{Literal|Range}} adds three sub-parameters, all the same type as the parameter itself:
 +
* <param> "Min"
 +
* <param> "Max"
 +
* <param> "Link"
 +
 
 +
{{Literal|Range}} can be used on {{l|Convert#Angle|angles}}, {{l|Convert#Integer|integers}}, {{l|Convert#Real|reals}}, and {{l|Convert#Time|times}}.
 +
 
 +
It is used to limit the value of the linked parameter to be between {{Literal|Min}} and {{Literal|Max}}.
 +
 
 +
The resulting value is:
 +
  Min (if Link < Min)
 +
  Max (if Link > Max)
 +
  Link (otherwise)
 +
 
 +
=== Real String ===
 +
 
 +
Converting a {{l|Convert#String|string}} parameter to {{Literal|Real String}} adds four sub-parameters:
 +
 
 +
* real "Real"
 +
* int "Width"
 +
* int "Precision"
 +
* bool "Zero Padded"
 +
 
 +
The result is a string formatted to contain the given value {{Literal|Real}}. {{Literal|Width}} specifies the minimum field width, {{Literal|Precision}} specifies the number of decimal places and {{Literal|Zero Padded}} specifies whether to pad with zeros on the left hand side.
 +
 
 +
For example, with Real=3.1415, Width=6, Precision=2, and ZeroPadded=true, we get:
 +
  "003.14"
 +
(6 characters long, 2 decimal places, and padded with zeros on the left).
 +
 
 +
=== Reciprocal ===
 +
 
 +
Converting a {{l|Convert#Real|real}}-valued parameter to {{Literal|Reciprocal}} adds three sub-parameters:
 +
* real "Link"
 +
* real "Epsilon".
 +
* real "Infinite".
 +
 
 +
The resulting value is:
 +
  1/Link (Link <= -epsilon or epsilon <= Link)
 +
  Infinite (if 0 <= Link < epsilon)
 +
  -Infinite (if -epsilon < Link < 0)
 +
 
 +
The {{Literal|Epsilon}} and {{Literal|Infinite}} parameters are only needed to prevent division by zero. For regular operation the resulting value is simply the reciprocal of {{Literal|Link}}.
 +
 
 +
=== Reference ===
 +
 
 +
Converting a parameter to {{Literal|Reference}} adds a single sub-parameter called {{Literal|Link}}.  The {{Literal|Link}} parameter is the same type as the parameter being converted.
 +
 
 +
It doesn't seem to do anything at all, other than adding an extra parameter.  Whatever value is put into {{Literal|Link}} becomes the value of the parameter being converted.
 +
 
 +
The only use for this conversion type I can think of is the following:
 +
 
 +
* you know that point A should follow point B, so you export point B and connect point A to it
 +
* you're not yet sure exactly how point B should move, so you experiment with different conversion types for point B
 +
* changing the conversion type for point B breaks the connection you made in the first step
 +
* converting point B to be a reference, and then experimenting with different conversions in its {{Literal|Link}} parameter allows point A to connect to point B and for the connection to remain in place while you experiment in the {{Literal|Link}} parameter
 +
 
 +
The resulting value is:
 +
  Link
 +
 
 +
=== Repeat Gradient ===
 +
 
 +
Converting a {{l|Convert#Gradient|gradient}} parameter to {{Literal|Repeat Gradient}} adds seven sub-parameters:
 +
* gradient "Gradient"
 +
* integer "Count"
 +
* real "Width"
 +
* bool "Specify Start"
 +
* bool "Specify End"
 +
* color "Start Color"
 +
* color "End Color"
 +
 
 +
The resulting value is a gradient containing {{Literal|Count}} equally spaced, equally wide copies of {{Literal|Gradient}}. Each copy has {{Literal|Gradient}} going forwards and then backwards. {{Literal|Width}} specifies relative width of the forward copy, with a width of '''0''' or less meaning only the backward copy is used, and a width of '''1''' or more meaning only the forward copy is used. A value of '''0.5''' will result in the forward and reverse copies of {{Literal|Gradient}} being the same width.
 +
 
 +
If {{Literal|Specify Start}} is checked then {{Literal|Start Color}} will be inserted at the beginning of the new gradient, otherwise the beginning of {{Literal|Gradient}} will be used as the beginning of the new gradient.
 +
 
 +
If {{Literal|Specify End}} is checked then {{Literal|End Color}} will be appended to the end of the new gradient, otherwise the end of {{Literal|Gradient}} will be used as the end of the new gradient.
 +
 
 +
Here's an example of a repeated gradient - the radiating green/yellow lines are a repeated gradient, applied to a perpendicular curve gradient.  This gradient was repeated with a width of '''0.5''', meaning it is used backwards and forwards the same amount:
 +
 
 +
[[File:Repeat-gradient-valuenode-gradient.png|frame|center]]
 +
 
 +
and here's the resulting image, along with the .sif file:
 +
 
 +
[[File:Repeat-gradient-valuenode.png|frame|center]]
 +
 
 +
  You can donwload the project {{l|Media:Repeat-gradient-valuenode.sif}}
 +
 
 +
=== Reverse Tangent ===
 +
 
 +
Converting a {{l|Convert#Spline Point|Spline Point}} parameter to {{Literal|Reverse Tangent}} adds two sub-parameters: one called {{Literal|Reference}} of type Spline Point, and a boolean parameter called {{Literal|Reverse}}.
 +
* Spline Point "Reference"
 +
* bool "Reverse"
 +
 
 +
{{Literal|Reverse Tangent}} can only be used on {{l|Convert#Spline Point|Spline Points}}.
 +
 
 +
The resulting value is the same as the {{Literal|Reference}} Spline Point, but with its tangents switched over. This is useful when attempting to link the vertices of a {{l|Region Layer|region}} to the vertices of an {{l|Outline Layer|outline}} when the region and the outline were drawn in opposite directions, and so tangent1 of an outline vertex needs to be linked to tangent2 of the region vertex, and vice versa.
 +
 
 +
=== Scale ===
 +
 
 +
Converting a parameter to {{Literal|Scale}} adds two sub-parameters: one called {{Literal|Link}}, of the same type as the parameter itself, and a real-valued parameter called {{Literal|Scalar}}.
 +
* <param> "Link"
 +
* real "Scalar"
 +
 
 +
{{Literal|Scale}} can be used on {{l|Convert#Angle|angles}}, {{l|Convert#Color|colors}}, {{l|Convert#Integer|integers}}, {{l|Convert#Real|reals}}, {{l|Convert#Time|times}}, and {{l|Convert#Vector|vectors}}.
 +
 
 +
The resulting value is:
 +
  Link * Scalar
 +
 
 +
=== Segment Tangent ===
 +
 
 +
Converting a {{l|Convert#Vector|vector}} parameter to {{Literal|Segment Tangent}} adds two sub-parameters:
 +
* segment "Segment"
 +
* real "Amount"
 +
 
 +
{{Literal|Amount}} is a number between '''0''' and '''1''', defining the distance along the given {{Literal|Segment}}. The resulting value for the whole parameter is the tangent to the segment, at the given point along the segment.
 +
 
 +
=== Segment Vertex ===
 +
 
 +
Converting a {{l|Convert#Vector|vector}} parameter to {{Literal|Segment Vertex}} adds two sub-parameters:
 +
* segment "Segment"
 +
* real "Amount"
 +
 
 +
{{Literal|Amount}} is a number between '''0''' and '''1''', defining the distance along the given {{Literal|Segment}}. The resulting value is the vertex at the given point along the segment.
 +
 
 +
=== Sine ===
 +
 
 +
Converting a {{l|Convert#Real|real}}-valued parameter to {{Literal|Sine}} adds two sub-parameters:
 +
* angle "Angle"
 +
* real "Amplitude".
 +
 
 +
The resulting value is:
 +
  Amplitude * sin(Angle)
 +
 
 +
=== Spline Tangent ===
 +
 
 +
Converting a {{l|Convert#Angle|angle}}, {{l|Convert#Real|real}, or {{l|Convert#Vector|vector}} parameter to {{Literal|Spline Tangent}} adds six sub-parameters:
 +
* spline "Spline"
 +
* bool "Loop"
 +
* real "Amount"
 +
* angle "Offset"
 +
* real "Scale"
 +
* bool "Fixed Length"
 +
 
 +
{{Literal|Amount}} is a number between '''0''' and '''1''', defining the distance along the given spline. The resulting value for the whole parameter is the tangent to the spline, at the given point along the spline, optionally rotated and scaled according to the {{Literal|Offset}}, {{Literal|Scale}}, and {{Literal|Fixed Length}} parameters.
 +
 
 +
{{Literal|Offset}} is an angle used to give the tangent an extra rotation before returning it. If {{Literal|Fixed Length}} is '''true''', the tangent is then scaled to have a length equal to {{Literal|Scale}}. Otherwise the tangent is multiplied by {{Literal|Scale}}.
 +
 
 +
If a vector was converted the result is the tangent itself. If an angle was converted, the result is the angle of the tangent to the horizontal, and if a real was converted, the result is the length of the tangent.
 +
 
 +
This {{l|Following a Spline|tutorial}} gives an example of the use of this convert type.
 +
 
 +
=== Spline Vertex ===
 +
 
 +
Converting a {{l|Convert#Vector|vector}} parameter to {{Literal|Spline Vertex}} adds three sub-parameters:
 +
* spline "Spline"
 +
* bool "Loop"
 +
* real "Amount"
 +
 
 +
{{Literal|Amount}} is a number between '''0''' and '''1''', defining the distance along the given spline. The resulting value for the whole parameter is a vector giving the position of the given point along the spline.
 +
 
 +
This {{l|Following a Spline|tutorial}} gives an example of the use of this convert type.
 +
 
 +
=== Spline Width ===
 +
 
 +
Converting a {{l|Convert#Real|real}} parameter to {{Literal|Spline Width}} adds three sub-parameters:
 +
* spline "Spline"
 +
* bool "Loop"
 +
* real "Amount"
 +
* real "Scale"
 +
 
 +
{{Literal|Amount}} is a number between '''0''' and '''1''', defining the distance along the given spline. The resulting value for the whole parameter is the width of the spline at the given point along it, multiplied by the {{Literal|Scale}} parameter.
 +
 
 +
=== Step ===
 +
 
 +
Converting an {{l|Convert#Angle|angle}}, {{l|Convert#Color|color}}, {{l|Convert#Integer|integer}}, {{l|Convert#Real|real}}, {{l|Convert#Time|time}}, or {{l|Convert#Vector|vector}} parameter to be {{Literal|Step}} adds four sub-parameters:
 +
* <param> "Link"
 +
* time "Duration"
 +
* time "Start Time"
 +
* real "Intersection"
 +
 
 +
The parameter's value will change in steps. Each step is {{Literal|Duration}} seconds long. The steps start at times {{Literal|Start Time}}, {{Literal|Start Time}}+{{Literal|Duration}}, etc. The value of the valuenode is the value of {{Literal|Link}} at some time. {{Literal|Intersection}} determines which time is used. An {{Literal|Intersection}} of '''0.0''' means that the value of {{Literal|Link}} at the start of the step should be used. An {{Literal|Intersection}} of '''0.5''' (the default) means to use the value of {{Literal|Link}} at the middle of the step, etc.
 +
 
 +
The resulting value at time <math>T</math> is:
 +
  <math>Link \Bigg ( \Bigg ( Duration \cdot \left ( \left \lfloor \frac{T - Start\ Time}{Duration} \right \rfloor + Intersection \right ) \Bigg ) + Start \ Time \Bigg )</math>
 +
 
 +
==== Example ====
 +
 
 +
{{Literal|Link}} is a sine wave. {{Literal|Duration}} is '''10f''' (the frame rate is 24 fps). {{Literal|Start Time}} is '''1s'''.
 +
 
 +
So one step starts at '''1s''', and others start at '''0s 14f''', '''0s 4f''', '''1s 10f''', etc.
 +
 
 +
This is the (kind of) sine wave:
 +
 
 +
[[File:Convert Smooth-sine 0.63.06.png|frame|center]]
 +
 
 +
And this is the effect of the Step valuenode on it, with an {{Literal|Intersection}} of '''0.0'''. Notice that at time '''0s''', the step has a negative value -- that step runs from '''-6f''' to '''4f''', and so its value is the value of {{Literal|Link}} at time '''-6f'''.  ''These images were created in [http://www.gimp.org/ The Gimp] - it's not currently possible to view two curves at the same time in Synfig Studio.''
 +
 
 +
[[File:Convert Stepped-sine 0.0 0.63.06.png|frame|center]]
 +
 
 +
Here it is with an {{Literal|Intersection}} of '''0.5''':
 +
 
 +
[[File:Convert Stepped-sine 0.5 0.63.06.png|frame|center]]
 +
 
 +
and here, with an {{Literal|Intersection}} '''of 1.0''':
 +
 
 +
[[File:Convert Stepped-sine 1.0 0.63.06.png|frame|center]]
 +
 
 +
  You can download the project {{l|Media:Doc Convert Step.sifz}}
 +
 
 +
=== Stripes ===
 +
 
 +
Converting a {{l|Convert#Gradient|gradient}} parameter to {{Literal|Stripes}} adds four sub-parameters:
 +
* color "Color 1"
 +
* color "Color 2"
 +
* integer "Stripe Count"
 +
* real "Width"
 +
 
 +
The resulting value is a gradient containing {{Literal|Stripe Count}} equally spaced, equally wide stripes of color {{Literal|Color 2}} with a background of {{Literal|Color 1}}. {{Literal|Width}} specifies the width of the stripes, with a {{Literal|Width}} of '''0''' or less meaning they are invisible, and a {{Literal|Width}} of '''1''' or more meaning the whole gradient is of {{Literal|Color 2}}.
 +
 
 +
=== Subtract ===
 +
 
 +
Converting a parameter to {{Literal|Subtract}} adds three sub-parameters, the first two of which are the same type as the parameter itself:
 +
* <param> "LHS"
 +
* <param> "RHS"
 +
* real "Scalar"
 +
 
 +
The {{Literal|Subtract}} conversion can be used with parameters of type {{l|Convert#Angle|angle}}, {{l|Convert#Color|color}}, {{l|Convert#Gradient|gradient}}, {{l|Convert#Integer|integer}}, {{l|Convert#Real|real}}, {{l|Convert#Time|time}}, and {{l|Convert#Vector|vector}}.
 +
 
 +
The resulting value is:
 +
  (LHS - RHS) * Scalar
 +
 
 +
=== Switch ===
 +
 
 +
Converting a parameter to {{Literal|Switch}} adds three sub-parameters:
 +
* <param> "Link Off"
 +
* <param> "Link On"
 +
* bool "Switch"
 +
 
 +
{{Literal|Link Off}} and {{Literal|Link On}} are the same type as the parameter being converted.
 +
 
 +
The resulting value is the value of {{Literal|Link Off}} when {{Literal|Switch}} is '''off''', and {{Literal|Link On}} when {{Literal|Switch}} is '''on'''.
 +
 
 +
This conversion can be used on all value types.
 +
 
 +
=== Time Loop ===
 +
 
 +
Converting a parameter to {{Literal|Time Loop}} adds four sub-parameters: one called {{Literal|Link}}, of the same type as the parameter itself, and three time parameters:
 +
 
 +
* <param> "Link"
 +
* time "Link Time"
 +
* time "Local Time"
 +
* time "Duration"
 +
 
 +
It works similarly to the {{l|Time Loop Layer}} but affects only a single parameter.
 +
 
 +
For any integer value '''n''', from "Local Time + abs(Duration)*n" to "Local Time + abs(Duration)*(n+1)", the resulting value of the parameter is the same as that of the {{Literal|Link}} parameter from {{Literal|Link Time}} to "Link Time + Duration".
 +
 
 +
In other words, {{Literal|Duration}} seconds of values of the parameter {{Literal|Link}} starting from time {{Literal|Link Time}} onwards are looped over and over, with the value of the {{Literal|Link}} parameter at time {{Literal|Link Time}} corresponding to the resulting value at time {{Literal|Local Time}}.
 +
 
 +
As an example, suppose the {{Literal|Link}} parameter has a value of time the current time. At '''0s''' the value is '''0''', at '''10s''' the value is '''20'''.
 +
 
 +
If we set:
 +
* Link Time = 5s
 +
* Local Time = 2s
 +
* Duration = 4s
 +
then from '''2s''' to '''6s''' and from '''6s''' to '''10s''', etc., the resulting value is the value of {{Literal|Link}} from '''5s''' to '''9s''', as follows:
 +
 
 +
Then the resulting values will be:
 +
* 0s -> "Link" value at 7s = 14
 +
* 1s -> "Link" value at 8s = 16
 +
* 2s -> "Link" value at 5s = 10 (at "Link Time" = 2s, result is the value of "Link" at "Link Time" = 5s = 10)
 +
* 3s -> "Link" value at 6s = 12
 +
* 4s -> "Link" value at 7s = 14
 +
* 5s -> "Link" value at 8s = 16
 +
* 6s -> "Link" value at 5s = 10 ("Duration" = 4s later, the value is the same as at 2s)
 +
* 7s -> "Link" value at 6s = 12
 +
 
 +
If {{Literal|Duration}} is '''zero''', the resulting value is whatever the value of the {{Literal|Link}} parameter is at time {{Literal|Link Time}}.
 +
 
 +
If {{Literal|Duration}} is negative, the resulting value at {{Literal|Local Time}} still matches the value of {{Literal|Link}} at {{Literal|Link Time}}, but the animation goes in the opposite direction.  For example:
 +
 
 +
If we set:
 +
* Link Time = 5s
 +
* Local Time = 2s
 +
* Duration = -4s
 +
then from '''2s''' to '''6s''' and from '''6s''' to '''10s''', etc., the resulting value is the value of {{Literal|Link}} from '''5s''' to '''1s''', as follows:
 +
 
 +
Then the resulting values will be:
 +
* 0s -> "Link" value at 3s = 6
 +
* 1s -> "Link" value at 2s = 4
 +
* 2s -> "Link" value at 5s = 10 (at "Link Time" = 2s, result is the value of "Link" at "Link Time" = 5s = 10)
 +
* 3s -> "Link" value at 4s = 8
 +
* 4s -> "Link" value at 3s = 6
 +
* 5s -> "Link" value at 2s = 4
 +
* 6s -> "Link" value at 5s = 10 (4s later, the value is the same as at "Link Time" = 2s)
 +
* 7s -> "Link" value at 4s = 8
 +
 
 +
This conversion can be used on all value types.
 +
 
 +
=== Time String ===
 +
 
 +
Converting a {{l|Convert#String|string}} parameter to {{Literal|Time String}} adds one sub-parameter called {{Literal|Time}}, of type time:
 +
 
 +
* time "Time"
 +
 
 +
The result is a string containing the given {{Literal|Time}}.
 +
 
 +
=== Timed Swap ===
 +
<!-- This convert type was disabled in Synfig 0.61.06 and earlier because it didn't work. -->
 +
Converting a parameter to {{Literal|Timed Swap}} adds four sub-parameters:
 +
* <param> "Before"
 +
* <param> "After"
 +
* {{l|Image:Type_time_icon.png|14px}} {{l|Dev:Types|'''time'''}} "Time"
 +
* {{l|Image:Type_time_icon.png|14px}} {{l|Dev:Types|'''time'''}} "Lenght"
 +
 
 +
{{Literal|Before}} and {{Literal|After}} are the same type as the parameter being converted.
 +
 
 +
This conversion type linearly switches from {{Literal|Before}} to {{Literal|After}}, taking {{Literal|Lenght}} seconds to do so, and completing the swap at {{Literal|Time}}.
 +
 
 +
Note that this doesn't give us anything that we can't achieve using the "{{l|Convert#Linear|Linear}}" conversion type and a few {{l|Waypoint|waypoints}}.
 +
 
 +
{{Literal|Timed Swap}} can be used on {{l|Convert#Angle|angles}}, {{l|Convert#Color|colors}}, {{l|Convert#Integer|integers}}, {{l|Convert#Real|reals}}, {{l|Convert#Time|times}}, and {{l|Convert#Vector|vectors}}.
 +
 
 +
The resulting value is:
 +
  if "current time" > "swap Time" then "After"
 +
  else if "current time" < ("swap Time" - "Lenght") then "Before"
 +
  else interpolate between "Before" and "After"
 +
 
 +
See {{l|Doc:Slideshow_Tutorial}} for an example.
 +
 
 +
=== Two-Tone ===
 +
 
 +
Converting a {{l|Convert#Gradient|gradient}} to {{Literal|Two-Tone}} adds two color-valued sub-parameters:
 +
* color "Color1"
 +
* color "Color2"
 +
 
 +
The resulting gradient has two {{l|Color Stop}}, one at each end, starting with {{Literal|Color1}} and ending with {{Literal|Color2}}.
 +
 
 +
These color parameters can be animated, giving us the ability to have the gradient change color over time. It used to be used as a workaround for [http://sourceforge.net/tracker/index.php?func=detail&aid=1568818&group_id=144022&atid=757416 this bug].
 +
 
 +
=== Vector Angle ===
 +
 
 +
Converting an {{l|Convert#Angle|angle}} to {{Literal|Vector Angle}} adds a vector sub-parameter:
 +
* vector "Vector"
 +
 
 +
The resulting value is the angle between the {{Literal|Vector}} and the X axis.
 +
 
 +
=== Vector Length ===
 +
 
 +
Converting a {{l|Convert#Real|real}} to {{Literal|Vector Length}} adds a vector sub-parameter:
 +
* vector "Vector"
 +
 
 +
The resulting value is the length of the {{Literal|Vector}}.
 +
 
 +
=== Vector X ===
 +
 
 +
Converting a {{l|Convert#Real|real}} to {{Literal|Vector X}} adds a vector sub-parameter:
 +
* vector "Vector"
 +
 
 +
The resulting value is the X component of the {{Literal|Vector}}.
 +
 
 +
=== Vector Y ===
 +
 
 +
Converting a {{l|Convert#Real|real}} to {{Literal|Vector Y}} adds a vector sub-parameter:
 +
* vector "Vector"
 +
 
 +
The resulting value is the Y component of the {{Literal|Vector}}.
 +
 
 +
== Which Value Types can use which Convert Types? ==
 +
 
 +
There are 13 different types of value in Synfig. Each of these types has a different set of convert types available to it, as follows:
 +
 
 +
=== {{l|Image:type_angle_icon.png|22px}} Angle ===
 +
 
 +
Angle parameters can be converted to {{l|Convert#Add|Add}}, {{l|Convert#aTan2|aTan2}}, {{l|Convert#Spline Tangent|Spline Tangent}}, {{l|Convert#Dot Product|Dot Product}}, {{l|Convert#Linear|Linear}}, {{l|Convert#Random|Random}}, {{l|Convert#Range|Range}}, {{l|Convert#Scale|Scale}}, {{l|Convert#Step|Step}}, {{l|Convert#Subtract|Subtract}}, {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, {{l|Convert#Timed Swap|Timed Swap}}, {{l|Convert#Vector Angle|Vector Angle}}, and {{l|Convert#Reference|Reference}} types.
 +
 
 +
=== {{l|Image:type_bool_icon.png|22px}} Bool ===
 +
 
 +
Bool parameters can only be converted to the {{l|Convert#And|And}}, {{l|Convert#Greyed|Greyed}}, {{l|Convert#Or|Or}}, {{l|Convert#Not|Not}}, {{l|Convert#Compare|Compare}} {{l|Convert#Random|Random}},  {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}},and {{l|Convert#Reference|Reference}} types.
 +
 
 +
=== {{l|Image:Type canvas icon 0.63.06.png|22px}} Canvas ===
 +
 
 +
Canvas parameters can be converted to the {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, and {{l|Convert#Reference|Reference}} type.
 +
 
 +
=== {{l|Image:type_color_icon.png|22px}} Color ===
 +
 
 +
Color parameters can be converted to {{l|Convert#Add|Add}}, {{l|Convert#Composite|Composite}}, {{l|Convert#Gradient Color|Gradient Color}}, {{l|Convert#Linear|Linear}}, {{l|Convert#Radial Composite|Radial Composite}}, {{l|Convert#Random|Random}}, {{l|Convert#Scale|Scale}}, {{l|Convert#Step|Step}}, {{l|Convert#Subtract|Subtract}}, {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, {{l|Convert#Timed Swap|Timed Swap}}, and {{l|Convert#Reference|Reference}} types.
 +
 
 +
=== {{l|Image:type_gradient_icon.png|22px}} Gradient ===
 +
 
 +
Gradient parameters can be converted to {{l|Convert#Add|Add}}, {{l|Convert#Gradient Rotate|Gradient Rotate}}, {{l|Convert#Repeat Gradient|Repeat Gradient}}, {{l|Convert#Stripes|Stripes}}, {{l|Convert#Subtract|Subtract}}, {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, {{l|Convert#Two-Tone|Two-Tone}}, and {{l|Convert#Reference|Reference}} types.
 +
 
 +
=== {{l|Image:type_integer_icon.png|22px}} Integer ===
 +
 
 +
Integer parameters can be converted to {{l|Convert#Add|Add}}, {{l|Convert#Linear|Linear}}, {{l|Convert#Random|Random}}, {{l|Convert#Range|Range}}, {{l|Convert#Scale|Scale}}, {{l|Convert#Step|Step}}, {{l|Convert#Subtract|Subtract}}, {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, {{l|Convert#Timed Swap|Timed Swap}}, and {{l|Convert#Reference|Reference}} types.
 +
 
 +
=== {{l|Image:type_list_icon.png|22px}} List ===
 +
 
 +
List parameters can be converted to {{l|Convert#Spline|Spline}}, {{l|Convert#Dynamic List|Dynamic List}}, {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, and {{l|Convert#Reference|Reference}} types.
 +
 
 +
=== {{l|Image:type_real_icon.png|22px}} Real ===
 +
 
 +
Real parameters can be converted to {{l|Convert#Add|Add}}, {{l|Convert#Spline Width|Spline Width}}, {{l|Convert#Cos|Cos}}, {{l|Convert#Dot Product|Dot Product}}, {{l|Convert#Exponential|Exponential}}, {{l|Convert#Linear|Linear}}, {{l|Convert#Logarithm|Logarithm}}, {{l|Convert#Power|Power}}, {{l|Convert#Random|Random}}, {{l|Convert#Range|Range}}, {{l|Convert#Reciprocal|Reciprocal}}, {{l|Convert#Scale|Scale}}, {{l|Convert#Sine|Sine}}, {{l|Convert#Step|Step}}, {{l|Convert#Subtract|Subtract}}, {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, {{l|Convert#Timed Swap|Timed Swap}}, {{l|Convert#Vector Length|Vector Length}}, {{l|Convert#Vector X|Vector X}}, {{l|Convert#Vector Y|Vector Y}}, and {{l|Convert#Reference|Reference}} types.
 +
 
 +
=== {{l|Image:type_segment_icon.png|22px}} Segment ===
 +
 
 +
Segment parameters can be converted to the {{l|Convert#Composite|Composite}}, {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, and {{l|Convert#Reference|Reference}} types.
 +
 
 +
=== {{l|Image:type_blinepoint_icon.png|22px}} Spline Point ===
 +
 
 +
Spline Point parameters can be converted to {{l|Convert#Composite|Composite}}, {{l|Convert#Reverse Tangent|Reverse Tangent}}, {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, and {{l|Convert#Reference|Reference}} types.
 +
 
 +
 
 +
=== {{l|Image:type_string_icon.png|22px}} String ===
 +
 
 +
String parameters can be converted to the {{l|Convert#Angle String|Angle String}}, {{l|Convert#Int String|Int String}}, {{l|Convert#Joined List|Joined List}}, {{l|Convert#Real String|Real String}}, {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, {{l|Convert#Time String|Time String}}, and {{l|Convert#Reference|Reference}} types.
 +
 
 +
=== {{l|Image:type_time_icon.png|22px}} Time ===
 +
 
 +
Time parameters can be converted to the {{l|Convert#Add|Add}}, {{l|Convert#Linear|Linear}}, {{l|Convert#Random|Random}}, {{l|Convert#Range|Range}}, {{l|Convert#Scale|Scale}}, {{l|Convert#Step|Step}}, {{l|Convert#Subtract|Subtract}}, {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, {{l|Convert#Timed Swap|Timed Swap}}, and {{l|Convert#Reference|Reference}} types.
 +
 
 +
=== {{l|Image:type_vector_icon.png|22px}} Vector ===
 +
 
 +
Vector parameters can be converted to {{l|Convert#Add|Add}}, {{l|Convert#Spline Tangent|Spline Tangent}}, {{l|Convert#Spline Vertex|Spline Vertex}}, {{l|Convert#Composite|Composite}}, {{l|Convert#Linear|Linear}}, {{l|Convert#Radial Composite|Radial Composite}}, {{l|Convert#Random|Random}}, {{l|Convert#Scale|Scale}}, {{l|Convert#Segment Tangent|Segment Tangent}}, {{l|Convert#Segment Vertex|Segment Vertex}}, {{l|Convert#Step|Step}}, {{l|Convert#Subtract|Subtract}}, {{l|Convert#Switch|Switch}}, {{l|Convert#Time Loop|Time Loop}}, {{l|Convert#Timed Swap|Timed Swap}}, and {{l|Convert#Reference|Reference}} types.
 +
 
 +
== Compatibility ==
 +
 
 +
When a new ValueNode type is added to Synfig, the .sif file format is extended to include a way of writing the new type. This extension won't be able to be read by any older version of Synfig. Here's a list of the ValueNode types that have been added, along with the subversion revision number in which they first appeared:
 +
 
 +
<blockquote>
 +
{| style="width:55%"
 +
| '''Version''' || '''Revision''' || '''Convert'''
 +
|-
 +
| <hr> || <hr> || <hr>
 +
|-
 +
| '''(1.0.2)''' || 15/08/09 || &nbsp;
 +
|-
 +
| &nbsp; || [https://github.com/synfig/synfig/pull/199 pull#199] || {{l|#Reverse|Reverse}}
 +
|-
 +
| '''(1.0)''' || 15/04/27 || &nbsp;
 +
|-
 +
| &nbsp; || [https://github.com/synfig/synfig/pull/105 pull#105] || {{l|#Dynamic|Dynamic}}
 +
|-
 +
| '''(0.63.06)''' ||  || &nbsp;
 +
|-
 +
| &nbsp; || ? || BLine Width renamed {{l|#Spline Width|Spline Width}}
 +
|-
 +
| &nbsp; || ? || BLine Vertex renamed {{l|#Spline Vertex|Spline Vertex}}
 +
|-
 +
| &nbsp; || ? || BLine Tangent renamed {{l|#Spline Tangent|Spline Tangent}}
 +
|-
 +
| <hr> || <hr> || <hr>
 +
|-
 +
| '''(0.61.09)''' ||  || &nbsp;
 +
|-
 +
| &nbsp; || 2034 || {{l|#Logarithm|Logarithm}}
 +
|-
 +
| &nbsp; || 2010 || {{l|#Int String|Int String}}
 +
|-
 +
| &nbsp; || 2010 || {{l|#Angle String|Angle String}}
 +
|-
 +
| &nbsp; || 2007 || {{l|#Joined List|Joined List}}
 +
|-
 +
| &nbsp; || 2003 || {{l|#Real String|Real String}}
 +
|-
 +
| &nbsp; || 2000 || {{l|#Time String|Time String}}
 +
|-
 +
| &nbsp; || 1891 || {{l|#Dot Product|Dot Product}}
 +
|-
 +
| &nbsp; || 1885 || {{l|#Gradient Color|Gradient Color}}
 +
|-
 +
| &nbsp; || 1882 || {{l|#Vector X|Vector X}}
 +
|-
 +
| &nbsp; || 1882 || {{l|#Vector Y|Vector Y}}
 +
|-
 +
| &nbsp; || 1881 || {{l|#Vector Length|Vector Length}}
 +
|-
 +
| &nbsp; || 1880 || {{l|#Vector Angle|Vector Angle}}
 +
|-
 +
| <hr> || <hr> || <hr>
 +
|-
 +
| '''(0.61.08)''' || 1839 || &nbsp;
 +
|-
 +
| &nbsp; || 1694 || {{l|#Spline Width|BLine Width}}
 +
|-
 +
| &nbsp; || 1690 || {{l|#Random|Random}} (for bools)
 +
|-
 +
| &nbsp; || 1691 || {{l|#Step|Step}}
 +
|-
 +
| &nbsp; || 1354 || {{l|#Subtract|Subtract}} (for gradients)
 +
|-
 +
| &nbsp; || 1354 || {{l|#Add|Add}} (for gradients)
 +
|-
 +
| &nbsp; || 1267 || {{l|#From Integer|From Integer}}
 +
|-
 +
| &nbsp; || 1267 || {{l|#Duplicate|Duplicate}}
 +
|-
 +
| &nbsp; || 1238 || {{l|#Reciprocal|Reciprocal}}
 +
|-
 +
| &nbsp; || 1226 || {{l|#Time Loop|Time Loop}}
 +
|-
 +
| &nbsp; || 1162 || {{l|#Reverse Tangent|Reverse Tangent}}
 +
|-
 +
| &nbsp; || 1132 || {{l|#aTan2|aTan2}}
 +
|-
 +
| &nbsp; || 1111 || {{l|#Cos|Cos}}
 +
|-
 +
| &nbsp; || 923 || {{l|#Switch|Switch}}
 +
|-
 +
| &nbsp; || 907 || {{l|#Random|Random}}
 +
|-
 +
| <hr> || <hr> || <hr>
 +
|-
 +
| '''(0.61.07)''' || 878 || &nbsp;
 +
|-
 +
| &nbsp; || 776 || {{l|#Range|Range}}
 +
|-
 +
| &nbsp; || 744 || {{l|#BLine Vertex|Spline Vertex}}
 +
|-
 +
| &nbsp; || 744 || {{l|#BLine Tangent|Spline Tangent}}
 +
|-
 +
| &nbsp; || 742 || {{l|#Add|Add}}
 +
|-
 +
| &nbsp; || 739 || {{l|#Exponential|Exponential}}
 +
|-
 +
| &nbsp; || 666 || {{l|#Repeat Gradient|Repeat Gradient}}
 +
|-
 +
| &nbsp; || 610 || {{l|#Timed Swap|Timed Swap}}
 +
|-
 +
| <hr> || <hr> || <hr>
 +
|-
 +
| '''(0.61.06)''' || 536 || &nbsp;
 +
|-|}
 +
</blockquote>

Latest revision as of 21:52, 13 September 2016

Languages Language: 

English • română 



  * This page need a better formating (for example sorting by categories : math/angle/boolean/...)
  * Some convert types are missing see here

Overview

Right-clicking on a value in the Parameters Panel brings up a context menu which has a sub-menu called "Convert".

The "Convert" menu allows you to specify that the parameter should be controlled automatically in various ways or used in mathematical formulas. Depending on the type of the parameter the Convert menu will contain different options.

To convert the parameter back to its original type, select "Disconnect" from its context menu.

You can have a look to the Parabolic Shot tutorial for a "real life" use of the Convert feature.

Converting animated values

When a parameter is animated it is (internally) converted to Animated Value node. Converting to another Convert Types replaces the link.
note end


Convert Types

Add

Converting a parameter to "Add" adds three sub-parameters, the first two of which are the same type as the parameter itself:

  • <param> "LHS"
  • <param> "RHS"
  • real "Scalar"

The "Add" conversion can be used with parameters of type angle, color, gradient, integer, real, time, and vector.

The resulting value is: 

  (LHS + RHS) * Scalar

And

Converting a bool parameter to "And" adds two sub-parameters:

  • bool "Link1"
  • bool "Link2"

The resulting value is true only if both Link1 and Link2 are true.


Angle String

Converting an string-valued parameter to "Angle String" adds four sub-parameters:

  • angle "Angle"
  • integer "Width"
  • integer "Precision"
  • bool "Zero Padded"

The resulting value a string containing the value of "Angle" (in degrees) formatted as a string with a minimum width "Width", with "Precision" decimal places. If "Zero Padded" is true, it will be left-padded with 0 characters.

aTan2

Converting an angle-valued parameter to "aTan2" adds two sub-parameters:

  • real "X"
  • real "Y".

The resulting value is: 

  atan2(y,x)

ie. atan(y/x) but without an error when x is 0. The value is the angle between the x axis and the vector (x,y).

Spline

Converting a list parameter to "Spline" doesn't seem to change anything. Perhaps that's the default type for lists of vertices, such as are found in outlines and regions?

Compare

Converting a bool parameter to "Compare" adds five sub-parameters:

  • real "LHS"
  • real "RHS"
  • bool "Greater than"
  • bool "Equal to"
  • bool "Less than"

The valuenode compares "LHS" and "RHS". The three boolean values determine which comparison returns true. For example, if LHS>RHS and "Greater than" is checked, the valuenode will evaluate to true.

Composite

Converting a Spline Point parameter to "Composite" adds six sub-parameters:

  • vector "Vertex"
  • real "Width"
  • real "Origin"
  • bool "Split Tangents"
  • vector "Tangent 1"
  • vector "Tangent 2"

Converting a color parameter to "Composite" adds four real-valued sub-parameters:

  • real "Red"
  • real "Green"
  • real "Blue"
  • real "Alpha"

Converting a segment parameter to "Composite" adds four vertex sub-parameters:

  • vertex "Vertex 1"
  • vertex "Tangent 1"
  • vertex "Vertex 2"
  • vertex "Tangent 2"

Converting a vector parameter to "Composite" adds two real-valued sub-parameters:

  • real "X-Axis"
  • real "Y-Axis"

The resulting value is a Spline Point, Color, Segment, or Vector made by combining the component parts.

Composite for Group Layer

The "Transformation" parameter of a Group Layer and Switch Group Layer is a composite parameter, it hold an Offset, Rotation, Skew and Scale subparameter for the group.

Cos

Converting a real-valued parameter to "Cos" adds two sub-parameters:

  • angle "Angle"
  • real "Amplitude".

The resulting value is: 

  "Amplitude" * cos("Angle")

Derivative

It allows to calculate the derivative (first or second order) of a given value node using the finite differences method. It has the following sub parameters:

  • real "Link" : Value Node whom is calculated the derivative (Real, Angle, Time, Vector)
  • real "Interval" : Size of the interval to calculate the finite differences (Real >0).
  • integer "Accuracy" : Accuracy order. (ROUGH, NORMAL, FINE & EXTREME)
  • integer "Order" : First or Second order derivative (FIRST, SECOND)

Dot Product

Converting a real or angle parameter to a "Dot Product" adds two sub-parameters:

  • vector "LHS"
  • vector "RHS"

If the converted value is an angle, the return value is the angle between the two vectors: 

return = acos((LHS · RHS) / (|LHS| * |RHS|))

If the converted value is a real, the result value is the dot product of the two vectors: 

return = LHS · RHS = |LHS| * |RHS| * cos(alpha)

(where alpha is the angle between "LHS" and "RHS").

Duplicate

This ValueNode type is only used by the Duplicate Layer. It never appears in the "Convert" menu. It is used to control the range of the Index in the Duplicate Layer (q.v.).

The "Duplicate" ValueNode type has 3 real-valued sub-parameters:

  • real "From"
  • real "To"
  • real "Step"

The value of the ValueNode varies from the value of "From" to the value of "To" in steps of size "Step". The sign of "Step" is ignored. If From<To the steps are positive, else they're negative.

Dynamic

Allows to link two vectors with a dynamic link. The ValueNode (vector type) that is converted to "Dynamic" will be linked to another vector value using a linear/rotational spring system with damping and friction.

File:Convert-Dynamics-Example1-project.sifz
File:Convert-Dynamics-Example2-project.sifz

Once you convert the Value to "Dynamic" it offers the following sub-parameters:

  • vector "Tip Static" This is the equilibrium position of the system without external forces relative to the Origin. See Origin. Since it is a vector its length is used for the linear spring equilibrium length and its angle form the x axis is used for the torsion spring equilibrium angle. The initial value of this subparameter is the current value of the Value that is being converted to Dynamic.
  • vector "Origin" This is the basement of the dynamic system. Defaults to (0.0, 0.0). If the user changes this value the final equilibrium calculated position of the value is modified too. Accelerations of the Origin are used to move the Tip due to the fictitious forces needed to apply under non inertial reference systems.
  • vector "Force" External force applied on the Tip of the dynamic system. Defaults to (0.0, 0.0).
  • real "Torque" External momentum applied tot he dynamic system at the Origin. Defaults to 0.0.
  • real "Damping" Damper coefficient of the linear link. Defaults to 0.4
  • real "Friction" Friction coefficient of the rotational link. Defaults to 0.4
  • real "Spring" Spring coefficient of the linear link. Defaults to 30.0
  • real "Torsion" Torsion coefficient of the rotational link. Defaults to 30.0
  • real "Mass" Mass of the dynamic system. Defaults to 0.3
  • real "Inertia" Moment of inertia of the dynamic system. Defaults to 0.3
  • bool "Spring rigid" When checked linear spring is rigid. Defaults to off
  • bool "Torsion rigid" When checked torsion spring is rigid. Defaults to off
  • bool "Origin drags tip" When checked result is origin + dynamic tip otherwise result is just dynamic tip. Defaults to off

Comments

Graphical representation of the dynamics system
The movement of the Origin produces two effects. It drags the resulting vector the same amount of the Origin along the time (that is the resulting vector is the sum of the Origin(t) + dynamic tip(t)) and its acceleration produces an inertial force contrary to the acceleration direction and magnitude.

The Torque only affects the angle of the resulting vector respect to the Origin. This means that the mass center of gravity is located at the origin (where the torque is applied) and so there is not centrifugal effects.

Since the Origin only can be translated and not rotated, there are not Coriolis forces.

The Force is applied on the tip position so it would produce effects on the angle and on the length of the tip. Force (F) is decomposed into two vectors one aligned with the Tip vector (Fr) and other perpendicular (Fa). The one aligned (Fr) is used on the linear damper spring equations. The one perpendicular (Fa) is used as additional torque by this expression Fr*R (where R is the variable length of the Tip vector)

If Mass (Inertia) reaches near to zero, then the movement for linear (rotational) link is disabled.

User is responsible of the meaning of the values of the parameters (i.e. negative mass, or negative friction or spring constant)

Origin is automatically connected to a subparameter of an internal Value Node in order to calculate the second derivative of the Origin (that is the acceleration of the Origin). Do not Disconnect Origin value node. Export it instead and link or connect other Value Nodes to the exported.

Dynamic List

Converting a list parameter to "Dynamic List" seems to replace each of the "Vertex NNN" sub-parameters with "Item NNN" parameters which can't be expanded, but can be Exported.

Exponential

Converting a real parameter to "Exponential" adds two sub-parameters:

  • real "Exponent"
  • real "Scale"

The resulting value is the result raising the mathematical constant 'e' to the power of "Exponent", and scaling the result by "Scale". That is, it returns: 

 Scale * e^Exponent

This is useful for tracking layers which have been zoomed, since the Zoom Layer scales by e^(zoom factor).

See this video for an example of the use of this convert type.

From Integer

This is currently disabled. It converts an integer to one of several types.

Gradient Color

Converting a color parameter to "Gradient Color" adds two sub-parameters:

  • gradient "Gradient"
  • real "Index"

The resulting value is a color taken from the Gradient Tool at the given index position. "Index" 0 corresponds to the left of the "Gradient"; "Index" 1 corresponds to the right of the "Gradient".

Gradient Rotate

Converting a gradient parameter to "Gradient Rotate" adds two sub-parameters:

  • gradient "Gradient"
  • real "Offset"

The resulting value is a gradient based on the "Gradient" parameter, but shifted left (for negative values) or right, according to the value of the "Offset" parameter. An offset of 1.0 will shift the gradient by its entire visible width. Values shifted off the left or right edge aren't lost - they aren't visible in the gradient as it's displayed in the parameters dialog, but they will still be used when rendering (depending on parameters such as "Loop" and "Zigzag", which can cause gradients to be looped between their their left and right edges, rather than using the non-displayed parts).

Int String

Converting an string-valued parameter to "Int String" adds three sub-parameters:

  • integer "Int"
  • integer "Width"
  • bool "Zero Padded"

The resulting value a string containing "Int" formatted as a string with a minimum width "Width". If "Zero Padded" is true, it will be left-padded with "0" characters.

Joined List

Converting a string parameter to be "Joined List" adds four sub-parameters:

  • list "Strings"
  • string "Before"
  • string "Separator"
  • string "After"

The result is a string containing the value of "Before", followed by all the strings in the "Strings" list, with the value of "Separator" between each pair, followed by the value of "After".

Linear

Converting an angle parameter to be "Linear" adds two angle sub-parameters:

  • angle "Rate"
  • angle "Offset"

Converting a color parameter to be "Linear" adds two angle sub-parameters:

  • color "Rate"
  • color "Offset"

Converting an integer parameter to be "Linear" adds two angle sub-parameters:

  • integer "Rate"
  • integer "Offset"

Converting a real parameter to be "Linear" adds two real-valued sub-parameters:

  • real "Rate"
  • real "Offset"

Converting a time parameter to be "Linear" adds two time sub-parameters:

  • time "Rate"
  • time "Offset"

Converting a vector parameter to be "Linear" adds two vector sub-parameters:

  • vector "Slope"
  • vector "Offset"

The parameter's value will change linearly over time, starting with the value specified by "Offset" at time zero, and increasing by the value specified by "Rate" (or "Slope", in the case of vector parameters) every second.

The resulting value for vector parameters is: 

  Offset + Slope*time

and for the other 5 types of parameter it is: 

  Offset + Rate*time

Logarithm

Converting a real-valued parameter to "Logarithm" adds three sub-parameters:

  • real "Link"
  • real "Epsilon".
  • real "Infinite".

The resulting value is: 

 Log(Link) (if Link >= Epsilon)
 -Infinite (if Link < Epsilon)

The "Epsilon" and "Infinite" parameters are only needed to prevent logarithm of negative or zero numbers. For regular operation the resulting value is simply the natural logarithm of "Link". In fact a logarithm of a negative number cannot be calculated in the space of Real numbers. This convert type returns -Infinite for simplicity.

Not

Converting a bool parameter to "Not" adds one sub-parameter:

  • bool "Link"

The resulting value is the opposite of "Link".

Or

Converting a bool parameter to "Or" adds two sub-parameters:

  • bool "Link1"
  • bool "Link2"

The resulting value is true if either "Link1", "Link2", or both are true.

Power

Converting a real-valued parameter to "Power" adds three sub-parameters:

  • real "Base"
  • real "Power"
  • real "Epsilon".
  • real "Infinite".

The resulting value is Base^Power if the operation is defined. The undefined cases will also return a value (to avoid errors): 

  0^0 = 1
  0^-x = +/- infinite
  If a negative base is raised to a noninteger power, the power is rounded (typecast) to an integer

The "Epsilon" and "Infinite" parameters are only needed to prevent division by zero.

Reverse

It operates on every type I could figure out how to reverse: lists, strings, spline points and segments, gradients, width points, and dash items.

From the Parameters Panel, select what you want to reverse, right click and select "Convert → Reverse"

When reversing a list, it also reverses the individual elements of that list, meaning that, for instance, a spline will look exactly the same after being reversed.

Radial Composite

Converting a color to "Radial Composite" adds four sub-parameters:

  • real "Luma"
  • real "Saturation"
  • angle "Hue"
  • real "Alpha"

Converting a vector to "Radial Composite" adds two sub-parameters:

  • real "Radius"
  • angle "Theta"

For color parameters, the resulting value is the color with the given "Luma", "Saturation", "Hue", and "Alpha" amounts.

For vector parameters, the resulting value is the point reached by traveling a distance "Radius" from the origin, in the distance given by the angle "Theta".

Random

Converting a parameter to "Random" adds five sub-parameters, the first of which is the same type as the converted parameter:

  • <param> "Link"
  • real "Radius"
  • integer "Seed"
  • real "Animation Speed"
  • integer "Interpolation"
  • real "Loop Time"

"Random" can be used on angles, colors, integers, reals, times, and vectors.

It is used to cause a parameter's value to vary randomly over time, around a central value:

  • "Link" provides the central value.
  • "Radius" defines the maximum random difference.
  • "Seed" seeds the random number generator
  • "Animation Speed" defines how often a new random value is chosen (in choices per second)
  • "Interpolation" determines how the value is interpolated from one random choice to the next. Possible values are:
    • 0 - no interpolation; the value jumps from one value to the next
    • 1 - linear interpolation
    • 2 - cosine
    • 3 - spline
    • 4 - cubic (the default); uses Catmull-Rom spline interpolation
  • "Loop Time" makes the random value repeat after the given time. The value ends up the same at the given time as at time=0 so it's possible to make random looping animations without a nasty jump when the time wraps back to zero.

The "Interpolation" sub-parameter should really be a drop-down menu, rather than an integer field, but that isn't yet implemented.

Range

Converting a parameter to "Range" adds three sub-parameters, all the same type as the parameter itself:

  • <param> "Min"
  • <param> "Max"
  • <param> "Link"

"Range" can be used on angles, integers, reals, and times.

It is used to limit the value of the linked parameter to be between "Min" and "Max".

The resulting value is: 

  Min (if Link < Min)
  Max (if Link > Max)
  Link (otherwise)

Real String

Converting a string parameter to "Real String" adds four sub-parameters:

  • real "Real"
  • int "Width"
  • int "Precision"
  • bool "Zero Padded"

The result is a string formatted to contain the given value "Real". "Width" specifies the minimum field width, "Precision" specifies the number of decimal places and "Zero Padded" specifies whether to pad with zeros on the left hand side.

For example, with Real=3.1415, Width=6, Precision=2, and ZeroPadded=true, we get: 

 "003.14"

(6 characters long, 2 decimal places, and padded with zeros on the left).

Reciprocal

Converting a real-valued parameter to "Reciprocal" adds three sub-parameters:

  • real "Link"
  • real "Epsilon".
  • real "Infinite".

The resulting value is: 

  1/Link (Link <= -epsilon or epsilon <= Link)
  Infinite (if 0 <= Link < epsilon)
  -Infinite (if -epsilon < Link < 0)

The "Epsilon" and "Infinite" parameters are only needed to prevent division by zero. For regular operation the resulting value is simply the reciprocal of "Link".

Reference

Converting a parameter to "Reference" adds a single sub-parameter called "Link". The "Link" parameter is the same type as the parameter being converted.

It doesn't seem to do anything at all, other than adding an extra parameter. Whatever value is put into "Link" becomes the value of the parameter being converted.

The only use for this conversion type I can think of is the following:

  • you know that point A should follow point B, so you export point B and connect point A to it
  • you're not yet sure exactly how point B should move, so you experiment with different conversion types for point B
  • changing the conversion type for point B breaks the connection you made in the first step
  • converting point B to be a reference, and then experimenting with different conversions in its "Link" parameter allows point A to connect to point B and for the connection to remain in place while you experiment in the "Link" parameter

The resulting value is: 

  Link

Repeat Gradient

Converting a gradient parameter to "Repeat Gradient" adds seven sub-parameters:

  • gradient "Gradient"
  • integer "Count"
  • real "Width"
  • bool "Specify Start"
  • bool "Specify End"
  • color "Start Color"
  • color "End Color"

The resulting value is a gradient containing "Count" equally spaced, equally wide copies of "Gradient". Each copy has "Gradient" going forwards and then backwards. "Width" specifies relative width of the forward copy, with a width of 0 or less meaning only the backward copy is used, and a width of 1 or more meaning only the forward copy is used. A value of 0.5 will result in the forward and reverse copies of "Gradient" being the same width.

If "Specify Start" is checked then "Start Color" will be inserted at the beginning of the new gradient, otherwise the beginning of "Gradient" will be used as the beginning of the new gradient.

If "Specify End" is checked then "End Color" will be appended to the end of the new gradient, otherwise the end of "Gradient" will be used as the end of the new gradient.

Here's an example of a repeated gradient - the radiating green/yellow lines are a repeated gradient, applied to a perpendicular curve gradient. This gradient was repeated with a width of 0.5, meaning it is used backwards and forwards the same amount:

Repeat-gradient-valuenode-gradient.png

and here's the resulting image, along with the .sif file:

Repeat-gradient-valuenode.png 
 You can donwload the project Media:Repeat-gradient-valuenode.sif

Reverse Tangent

Converting a Spline Point parameter to "Reverse Tangent" adds two sub-parameters: one called "Reference" of type Spline Point, and a boolean parameter called "Reverse".

  • Spline Point "Reference"
  • bool "Reverse"

"Reverse Tangent" can only be used on Spline Points.

The resulting value is the same as the "Reference" Spline Point, but with its tangents switched over. This is useful when attempting to link the vertices of a region to the vertices of an outline when the region and the outline were drawn in opposite directions, and so tangent1 of an outline vertex needs to be linked to tangent2 of the region vertex, and vice versa.

Scale

Converting a parameter to "Scale" adds two sub-parameters: one called "Link", of the same type as the parameter itself, and a real-valued parameter called "Scalar".

  • <param> "Link"
  • real "Scalar"

"Scale" can be used on angles, colors, integers, reals, times, and vectors.

The resulting value is: 

  Link * Scalar

Segment Tangent

Converting a vector parameter to "Segment Tangent" adds two sub-parameters:

  • segment "Segment"
  • real "Amount"

"Amount" is a number between 0 and 1, defining the distance along the given "Segment". The resulting value for the whole parameter is the tangent to the segment, at the given point along the segment.

Segment Vertex

Converting a vector parameter to "Segment Vertex" adds two sub-parameters:

  • segment "Segment"
  • real "Amount"

"Amount" is a number between 0 and 1, defining the distance along the given "Segment". The resulting value is the vertex at the given point along the segment.

Sine

Converting a real-valued parameter to "Sine" adds two sub-parameters:

  • angle "Angle"
  • real "Amplitude".

The resulting value is: 

  Amplitude * sin(Angle)

Spline Tangent

Converting a angle, {{l|Convert#Real|real}, or vector parameter to "Spline Tangent" adds six sub-parameters:

  • spline "Spline"
  • bool "Loop"
  • real "Amount"
  • angle "Offset"
  • real "Scale"
  • bool "Fixed Length"

"Amount" is a number between 0 and 1, defining the distance along the given spline. The resulting value for the whole parameter is the tangent to the spline, at the given point along the spline, optionally rotated and scaled according to the "Offset", "Scale", and "Fixed Length" parameters.

"Offset" is an angle used to give the tangent an extra rotation before returning it. If "Fixed Length" is true, the tangent is then scaled to have a length equal to "Scale". Otherwise the tangent is multiplied by "Scale".

If a vector was converted the result is the tangent itself. If an angle was converted, the result is the angle of the tangent to the horizontal, and if a real was converted, the result is the length of the tangent.

This tutorial gives an example of the use of this convert type.

Spline Vertex

Converting a vector parameter to "Spline Vertex" adds three sub-parameters:

  • spline "Spline"
  • bool "Loop"
  • real "Amount"

"Amount" is a number between 0 and 1, defining the distance along the given spline. The resulting value for the whole parameter is a vector giving the position of the given point along the spline.

This tutorial gives an example of the use of this convert type.

Spline Width

Converting a real parameter to "Spline Width" adds three sub-parameters:

  • spline "Spline"
  • bool "Loop"
  • real "Amount"
  • real "Scale"

"Amount" is a number between 0 and 1, defining the distance along the given spline. The resulting value for the whole parameter is the width of the spline at the given point along it, multiplied by the "Scale" parameter.

Step

Converting an angle, color, integer, real, time, or vector parameter to be "Step" adds four sub-parameters:

  • <param> "Link"
  • time "Duration"
  • time "Start Time"
  • real "Intersection"

The parameter's value will change in steps. Each step is "Duration" seconds long. The steps start at times "Start Time", "Start Time"+"Duration", etc. The value of the valuenode is the value of "Link" at some time. "Intersection" determines which time is used. An "Intersection" of 0.0 means that the value of "Link" at the start of the step should be used. An "Intersection" of 0.5 (the default) means to use the value of "Link" at the middle of the step, etc.

The resulting value at time Failed to parse (MathML with SVG or PNG fallback (recommended for modern browsers and accessibility tools): Invalid response ("Math extension cannot connect to Restbase.") from server "https://api.formulasearchengine.com/v1/":): {\displaystyle T} is: 

  Failed to parse (MathML with SVG or PNG fallback (recommended for modern browsers and accessibility tools): Invalid response ("Math extension cannot connect to Restbase.") from server "https://api.formulasearchengine.com/v1/":): {\displaystyle Link \Bigg ( \Bigg ( Duration \cdot \left ( \left \lfloor \frac{T - Start\ Time}{Duration} \right \rfloor + Intersection \right ) \Bigg ) + Start \ Time \Bigg )}

Example

"Link" is a sine wave. "Duration" is 10f (the frame rate is 24 fps). "Start Time" is 1s.

So one step starts at 1s, and others start at 0s 14f, 0s 4f, 1s 10f, etc.

This is the (kind of) sine wave:

Convert Smooth-sine 0.63.06.png

And this is the effect of the Step valuenode on it, with an "Intersection" of 0.0. Notice that at time 0s, the step has a negative value -- that step runs from -6f to 4f, and so its value is the value of "Link" at time -6f. These images were created in The Gimp - it's not currently possible to view two curves at the same time in Synfig Studio.

Convert Stepped-sine 0.0 0.63.06.png

Here it is with an "Intersection" of 0.5:

Convert Stepped-sine 0.5 0.63.06.png

and here, with an "Intersection" of 1.0:

Convert Stepped-sine 1.0 0.63.06.png 
 You can download the project Media:Doc Convert Step.sifz

Stripes

Converting a gradient parameter to "Stripes" adds four sub-parameters:

  • color "Color 1"
  • color "Color 2"
  • integer "Stripe Count"
  • real "Width"

The resulting value is a gradient containing "Stripe Count" equally spaced, equally wide stripes of color "Color 2" with a background of "Color 1". "Width" specifies the width of the stripes, with a "Width" of 0 or less meaning they are invisible, and a "Width" of 1 or more meaning the whole gradient is of "Color 2".

Subtract

Converting a parameter to "Subtract" adds three sub-parameters, the first two of which are the same type as the parameter itself:

  • <param> "LHS"
  • <param> "RHS"
  • real "Scalar"

The "Subtract" conversion can be used with parameters of type angle, color, gradient, integer, real, time, and vector.

The resulting value is: 

  (LHS - RHS) * Scalar

Switch

Converting a parameter to "Switch" adds three sub-parameters:

  • <param> "Link Off"
  • <param> "Link On"
  • bool "Switch"

"Link Off" and "Link On" are the same type as the parameter being converted.

The resulting value is the value of "Link Off" when "Switch" is off, and "Link On" when "Switch" is on.

This conversion can be used on all value types.

Time Loop

Converting a parameter to "Time Loop" adds four sub-parameters: one called "Link", of the same type as the parameter itself, and three time parameters:

  • <param> "Link"
  • time "Link Time"
  • time "Local Time"
  • time "Duration"

It works similarly to the Time Loop Layer but affects only a single parameter.

For any integer value n, from "Local Time + abs(Duration)*n" to "Local Time + abs(Duration)*(n+1)", the resulting value of the parameter is the same as that of the "Link" parameter from "Link Time" to "Link Time + Duration".

In other words, "Duration" seconds of values of the parameter "Link" starting from time "Link Time" onwards are looped over and over, with the value of the "Link" parameter at time "Link Time" corresponding to the resulting value at time "Local Time".

As an example, suppose the "Link" parameter has a value of time the current time. At 0s the value is 0, at 10s the value is 20.

If we set:

  • Link Time = 5s
  • Local Time = 2s
  • Duration = 4s

then from 2s to 6s and from 6s to 10s, etc., the resulting value is the value of "Link" from 5s to 9s, as follows:

Then the resulting values will be:

  • 0s -> "Link" value at 7s = 14
  • 1s -> "Link" value at 8s = 16
  • 2s -> "Link" value at 5s = 10 (at "Link Time" = 2s, result is the value of "Link" at "Link Time" = 5s = 10)
  • 3s -> "Link" value at 6s = 12
  • 4s -> "Link" value at 7s = 14
  • 5s -> "Link" value at 8s = 16
  • 6s -> "Link" value at 5s = 10 ("Duration" = 4s later, the value is the same as at 2s)
  • 7s -> "Link" value at 6s = 12

If "Duration" is zero, the resulting value is whatever the value of the "Link" parameter is at time "Link Time".

If "Duration" is negative, the resulting value at "Local Time" still matches the value of "Link" at "Link Time", but the animation goes in the opposite direction. For example:

If we set:

  • Link Time = 5s
  • Local Time = 2s
  • Duration = -4s

then from 2s to 6s and from 6s to 10s, etc., the resulting value is the value of "Link" from 5s to 1s, as follows:

Then the resulting values will be:

  • 0s -> "Link" value at 3s = 6
  • 1s -> "Link" value at 2s = 4
  • 2s -> "Link" value at 5s = 10 (at "Link Time" = 2s, result is the value of "Link" at "Link Time" = 5s = 10)
  • 3s -> "Link" value at 4s = 8
  • 4s -> "Link" value at 3s = 6
  • 5s -> "Link" value at 2s = 4
  • 6s -> "Link" value at 5s = 10 (4s later, the value is the same as at "Link Time" = 2s)
  • 7s -> "Link" value at 4s = 8

This conversion can be used on all value types.

Time String

Converting a string parameter to "Time String" adds one sub-parameter called "Time", of type time:

  • time "Time"

The result is a string containing the given "Time".

Timed Swap

Converting a parameter to "Timed Swap" adds four sub-parameters:

  • <param> "Before"
  • <param> "After"
  • Type time icon.png time "Time"
  • Type time icon.png time "Lenght"

"Before" and "After" are the same type as the parameter being converted.

This conversion type linearly switches from "Before" to "After", taking "Lenght" seconds to do so, and completing the swap at "Time".

Note that this doesn't give us anything that we can't achieve using the "Linear" conversion type and a few waypoints.

"Timed Swap" can be used on angles, colors, integers, reals, times, and vectors.

The resulting value is: 

  if "current time" > "swap Time" then "After"
  else if "current time" < ("swap Time" - "Lenght") then "Before"
  else interpolate between "Before" and "After"

See Slideshow Tutorial for an example.

Two-Tone

Converting a gradient to "Two-Tone" adds two color-valued sub-parameters:

  • color "Color1"
  • color "Color2"

The resulting gradient has two Color Stop, one at each end, starting with "Color1" and ending with "Color2".

These color parameters can be animated, giving us the ability to have the gradient change color over time. It used to be used as a workaround for this bug.

Vector Angle

Converting an angle to "Vector Angle" adds a vector sub-parameter:

  • vector "Vector"

The resulting value is the angle between the "Vector" and the X axis.

Vector Length

Converting a real to "Vector Length" adds a vector sub-parameter:

  • vector "Vector"

The resulting value is the length of the "Vector".

Vector X

Converting a real to "Vector X" adds a vector sub-parameter:

  • vector "Vector"

The resulting value is the X component of the "Vector".

Vector Y

Converting a real to "Vector Y" adds a vector sub-parameter:

  • vector "Vector"

The resulting value is the Y component of the "Vector".

Which Value Types can use which Convert Types?

There are 13 different types of value in Synfig. Each of these types has a different set of convert types available to it, as follows:

Type angle icon.png Angle

Angle parameters can be converted to Add, aTan2, Spline Tangent, Dot Product, Linear, Random, Range, Scale, Step, Subtract, Switch, Time Loop, Timed Swap, Vector Angle, and Reference types.

Type bool icon.png Bool

Bool parameters can only be converted to the And, Greyed, Or, Not, Compare Random, Switch, Time Loop,and Reference types.

Type canvas icon 0.63.06.png Canvas

Canvas parameters can be converted to the Switch, Time Loop, and Reference type.

Type color icon.png Color

Color parameters can be converted to Add, Composite, Gradient Color, Linear, Radial Composite, Random, Scale, Step, Subtract, Switch, Time Loop, Timed Swap, and Reference types.

Type gradient icon.png Gradient

Gradient parameters can be converted to Add, Gradient Rotate, Repeat Gradient, Stripes, Subtract, Switch, Time Loop, Two-Tone, and Reference types.

Type integer icon.png Integer

Integer parameters can be converted to Add, Linear, Random, Range, Scale, Step, Subtract, Switch, Time Loop, Timed Swap, and Reference types.

Type list icon.png List

List parameters can be converted to Spline, Dynamic List, Switch, Time Loop, and Reference types.

Type real icon.png Real

Real parameters can be converted to Add, Spline Width, Cos, Dot Product, Exponential, Linear, Logarithm, Power, Random, Range, Reciprocal, Scale, Sine, Step, Subtract, Switch, Time Loop, Timed Swap, Vector Length, Vector X, Vector Y, and Reference types.

Type segment icon.png Segment

Segment parameters can be converted to the Composite, Switch, Time Loop, and Reference types.

Type blinepoint icon.png Spline Point

Spline Point parameters can be converted to Composite, Reverse Tangent, Switch, Time Loop, and Reference types.


Type string icon.png String

String parameters can be converted to the Angle String, Int String, Joined List, Real String, Switch, Time Loop, Time String, and Reference types.

Type time icon.png Time

Time parameters can be converted to the Add, Linear, Random, Range, Scale, Step, Subtract, Switch, Time Loop, Timed Swap, and Reference types.

Type vector icon.png Vector

Vector parameters can be converted to Add, Spline Tangent, Spline Vertex, Composite, Linear, Radial Composite, Random, Scale, Segment Tangent, Segment Vertex, Step, Subtract, Switch, Time Loop, Timed Swap, and Reference types.

Compatibility

When a new ValueNode type is added to Synfig, the .sif file format is extended to include a way of writing the new type. This extension won't be able to be read by any older version of Synfig. Here's a list of the ValueNode types that have been added, along with the subversion revision number in which they first appeared:

Version Revision Convert
(1.0.2) 15/08/09  
  pull#199 Reverse
(1.0) 15/04/27  
  pull#105 Dynamic
(0.63.06)  
   ? BLine Width renamed Spline Width
   ? BLine Vertex renamed Spline Vertex
   ? BLine Tangent renamed Spline Tangent
(0.61.09)  
  2034 Logarithm
  2010 Int String
  2010 Angle String
  2007 Joined List
  2003 Real String
  2000 Time String
  1891 Dot Product
  1885 Gradient Color
  1882 Vector X
  1882 Vector Y
  1881 Vector Length
  1880 Vector Angle
(0.61.08) 1839  
  1694 BLine Width
  1690 Random (for bools)
  1691 Step
  1354 Subtract (for gradients)
  1354 Add (for gradients)
  1267 From Integer
  1267 Duplicate
  1238 Reciprocal
  1226 Time Loop
  1162 Reverse Tangent
  1132 aTan2
  1111 Cos
  923 Switch
  907 Random
(0.61.07) 878  
  776 Range
  744 Spline Vertex
  744 Spline Tangent
  742 Add
  739 Exponential
  666 Repeat Gradient
  610 Timed Swap
(0.61.06) 536  


Languages Language: 

English • română

Retrieved from "https://wiki.synfig.org/index.php?title=Convert&oldid=22179"