Difference between revisions of "Dev:Types"

From Synfig Studio :: Documentation
Jump to: navigation, search
m (fixed the external link syntax)
m (use 14px instead of 16px for type icon size)
Line 9: Line 9:
 
|-
 
|-
 
||01
 
||01
−
||{{l|Image:Type_bool_icon.png|16px}}
+
||{{l|Image:Type_bool_icon.png|14px}}
 
||'''Bool'''
 
||'''Bool'''
 
||a boolean value; true or false.  Represented in Studio as a checkbox.
 
||a boolean value; true or false.  Represented in Studio as a checkbox.
Line 15: Line 15:
 
|-style="background:#eeeeee"
 
|-style="background:#eeeeee"
 
||02
 
||02
−
||{{l|Image:Type_integer_icon.png|16px}}
+
||{{l|Image:Type_integer_icon.png|14px}}
 
||'''Integer'''
 
||'''Integer'''
 
||an integer value; a whole number.  -3 or 0 or 2 are examples.
 
||an integer value; a whole number.  -3 or 0 or 2 are examples.
Line 21: Line 21:
 
|-
 
|-
 
||03
 
||03
−
||{{l|Image:Type_real_icon.png|16px}}
+
||{{l|Image:Type_real_icon.png|14px}}
 
||'''Real'''
 
||'''Real'''
 
||a [http://en.wikipedia.org/wiki/Real_number real number]. -3.0, 0.0, 2.0 and 3.1415 are examples.
 
||a [http://en.wikipedia.org/wiki/Real_number real number]. -3.0, 0.0, 2.0 and 3.1415 are examples.
Line 27: Line 27:
 
|-style="background:#eeeeee"
 
|-style="background:#eeeeee"
 
||04
 
||04
−
||{{l|Image:Type_angle_icon.png|16px}}
+
||{{l|Image:Type_angle_icon.png|14px}}
 
||'''Angle'''
 
||'''Angle'''
 
||a real number that is interpreted as an angle.
 
||a real number that is interpreted as an angle.
Line 33: Line 33:
 
|-
 
|-
 
||05
 
||05
−
||{{l|Image:Type_time_icon.png|16px}}
+
||{{l|Image:Type_time_icon.png|14px}}
 
||'''Time'''
 
||'''Time'''
 
||a time, displayed in days, hours, minutes, seconds and frames.
 
||a time, displayed in days, hours, minutes, seconds and frames.
Line 39: Line 39:
 
|-style="background:#eeeeee"
 
|-style="background:#eeeeee"
 
||06
 
||06
−
||{{l|Image:Type_vector_icon.png|16px}}
+
||{{l|Image:Type_vector_icon.png|14px}}
 
||'''Vector'''  
 
||'''Vector'''  
 
||a 2d vector.  usually represented as two Reals representing X and Y values.
 
||a 2d vector.  usually represented as two Reals representing X and Y values.
Line 45: Line 45:
 
|-style
 
|-style
 
||07
 
||07
−
||{{l|Image:Type_color_icon.png|16px}}
+
||{{l|Image:Type_color_icon.png|14px}}
 
||'''Color'''
 
||'''Color'''
 
||a color.  Usually represented as Red/Green/Blue/Alpha values.
 
||a color.  Usually represented as Red/Green/Blue/Alpha values.
Line 51: Line 51:
 
|-style="background:#eeeeee"
 
|-style="background:#eeeeee"
 
||08
 
||08
−
||{{l|Image:Type_segment_icon.png|16px}}
+
||{{l|Image:Type_segment_icon.png|14px}}
 
||'''Segment'''
 
||'''Segment'''
 
||a single bezier curve segment.  Defined by 4 Vectors, representing 2 Vertices and 2 Tangents.
 
||a single bezier curve segment.  Defined by 4 Vectors, representing 2 Vertices and 2 Tangents.
Line 57: Line 57:
 
|-
 
|-
 
||09
 
||09
−
||{{l|Image:Type_blinepoint_icon.png|16px}}
+
||{{l|Image:Type_blinepoint_icon.png|14px}}
 
||'''SplinePoint'''
 
||'''SplinePoint'''
 
||a point in a Spline.  Defined by 6 parameters (a Vector defining its location, a Real defining its width, another Real defining its origin, a Bool defining whether its tangents are split or not, and two Vectors defining the direction of its tangents (only the first of which is used if the tangents aren't split).
 
||a point in a Spline.  Defined by 6 parameters (a Vector defining its location, a Real defining its width, another Real defining its origin, a Bool defining whether its tangents are split or not, and two Vectors defining the direction of its tangents (only the first of which is used if the tangents aren't split).
Line 63: Line 63:
 
|-style="background:#eeeeee"
 
|-style="background:#eeeeee"
 
||10
 
||10
−
||{{l|Image:Type_list_icon.png|16px}}
+
||{{l|Image:Type_list_icon.png|14px}}
 
||'''List'''  
 
||'''List'''  
 
||A list.  For example, an outline's Vertices parameter is simply a list of SplinePoint valuenodes.
 
||A list.  For example, an outline's Vertices parameter is simply a list of SplinePoint valuenodes.
Line 69: Line 69:
 
|-
 
|-
 
||11
 
||11
−
||{{l|Image:Type_canvas_icon_0.63.06.png|16px}}
+
||{{l|Image:Type_canvas_icon_0.63.06.png|14px}}
 
||'''Canvas'''  
 
||'''Canvas'''  
 
||A collection of layers.  When you group layers, you're creating a new {{l|Group Layer}} called, by default "Group".  The group layer has a parameter called 'Canvas' with type 'Canvas' and its value is the group of layers you've grouped.
 
||A collection of layers.  When you group layers, you're creating a new {{l|Group Layer}} called, by default "Group".  The group layer has a parameter called 'Canvas' with type 'Canvas' and its value is the group of layers you've grouped.
Line 75: Line 75:
 
|-style="background:#eeeeee"
 
|-style="background:#eeeeee"
 
||12
 
||12
−
||{{l|Image:Type_string_icon.png|16px}}  
+
||{{l|Image:Type_string_icon.png|14px}}  
 
||'''String '''
 
||'''String '''
 
||a string of characters, for example "Hello Mum!"
 
||a string of characters, for example "Hello Mum!"
Line 81: Line 81:
 
|-
 
|-
 
||13
 
||13
−
||{{l|Image:Type_gradient_icon.png|16px}}
+
||{{l|Image:Type_gradient_icon.png|14px}}
 
||'''Gradient '''
 
||'''Gradient '''
 
||a range of colors (a mapping from a real parameter to a color).  Can be defined in many ways, but is usually editing using the gradient editor.
 
||a range of colors (a mapping from a real parameter to a color).  Can be defined in many ways, but is usually editing using the gradient editor.

Revision as of 17:11, 25 July 2013

ValueNode Types

Each ValueNode (and hence each Parameter) in Synfig has one of 13 types:

Type Description
01 Type bool icon.png Bool a boolean value; true or false. Represented in Studio as a checkbox.
02 Type integer icon.png Integer an integer value; a whole number. -3 or 0 or 2 are examples.
03 Type real icon.png Real a real number. -3.0, 0.0, 2.0 and 3.1415 are examples.
04 Type angle icon.png Angle a real number that is interpreted as an angle.
05 Type time icon.png Time a time, displayed in days, hours, minutes, seconds and frames.
06 Type vector icon.png Vector a 2d vector. usually represented as two Reals representing X and Y values.
07 Type color icon.png Color a color. Usually represented as Red/Green/Blue/Alpha values.
08 Type segment icon.png Segment a single bezier curve segment. Defined by 4 Vectors, representing 2 Vertices and 2 Tangents.
09 Type blinepoint icon.png SplinePoint a point in a Spline. Defined by 6 parameters (a Vector defining its location, a Real defining its width, another Real defining its origin, a Bool defining whether its tangents are split or not, and two Vectors defining the direction of its tangents (only the first of which is used if the tangents aren't split).
10 Type list icon.png List A list. For example, an outline's Vertices parameter is simply a list of SplinePoint valuenodes.
11 Type canvas icon 0.63.06.png Canvas A collection of layers. When you group layers, you're creating a new Group Layer called, by default "Group". The group layer has a parameter called 'Canvas' with type 'Canvas' and its value is the group of layers you've grouped.
12 Type string icon.png String a string of characters, for example "Hello Mum!"
13 Type gradient icon.png Gradient a range of colors (a mapping from a real parameter to a color). Can be defined in many ways, but is usually editing using the gradient editor.
Retrieved from "https://wiki.synfig.org/index.php?title=Dev:Types&oldid=18456"