Difference between revisions of "Dev:Types"
From Synfig Studio :: Documentation
m |
m |
||
| (15 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
=== ValueNode Types === | === ValueNode Types === | ||
| − | Each | + | Each {{l|ValueNode}} (and hence each {{l|Parameter}}) in Synfig has one of 13 types: |
| − | + | {|border="0" align="left" style="border-collapse" cellpadding="3" cellspacing="0" | |
| − | + | |-style="background:silver" | |
| − | + | |||||'''Type'''||'''Description''' | |
| − | + | ||
| − | + | |- | |
| − | + | ||01. | |
| − | + | ||{{l|Image:Type_bool_icon.png|14px}} | |
| − | + | ||'''Bool''' | |
| − | + | ||a boolean value; true or false. Represented in Studio as a checkbox. | |
| − | + | ||
| − | + | |-style="background:#eeeeee" | |
| − | + | ||02. | |
| − | + | ||{{l|Image:Type_integer_icon.png|14px}} | |
| + | ||'''Integer''' | ||
| + | ||an integer value; a whole number. -3 or 0 or 2 are examples. | ||
| + | |||
| + | |- | ||
| + | ||03. | ||
| + | ||{{l|Image:Type_real_icon.png|14px}} | ||
| + | ||'''Real''' | ||
| + | ||a [http://en.wikipedia.org/wiki/Real_number real number]. -3.0, 0.0, 2.0 and 3.1415 are examples. | ||
| + | |||
| + | |-style="background:#eeeeee" | ||
| + | ||04. | ||
| + | ||{{l|Image:Type_angle_icon.png|14px}} | ||
| + | ||'''Angle''' | ||
| + | ||a real number that is interpreted as an angle. | ||
| + | |||
| + | |- | ||
| + | ||05. | ||
| + | ||{{l|Image:Type_time_icon.png|14px}} | ||
| + | ||'''Time''' | ||
| + | ||a time, displayed in days, hours, minutes, seconds and frames. | ||
| + | |||
| + | |-style="background:#eeeeee" | ||
| + | ||06. | ||
| + | ||{{l|Image:Type_vector_icon.png|14px}} | ||
| + | ||'''Vector''' | ||
| + | ||a 2d vector. usually represented as two Reals representing X and Y values. | ||
| + | |||
| + | |-style | ||
| + | ||07. | ||
| + | ||{{l|Image:Type_color_icon.png|14px}} | ||
| + | ||'''Color''' | ||
| + | ||a color. Usually represented as Red/Green/Blue/Alpha values. | ||
| + | |||
| + | |-style="background:#eeeeee" | ||
| + | ||08. | ||
| + | ||{{l|Image:Type_segment_icon.png|14px}} | ||
| + | ||'''Segment''' | ||
| + | ||a single bezier curve segment. Defined by 4 Vectors, representing 2 Vertices and 2 Tangents. | ||
| + | |||
| + | |- | ||
| + | ||09. | ||
| + | ||{{l|Image:Type_blinepoint_icon.png|14px}} | ||
| + | ||'''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). | ||
| + | |||
| + | |-style="background:#eeeeee" | ||
| + | ||10. | ||
| + | ||{{l|Image:Type_list_icon.png|14px}} | ||
| + | ||'''List''' | ||
| + | ||A list. For example, an outline's Vertices parameter is simply a list of SplinePoint valuenodes. | ||
| + | |||
| + | |- | ||
| + | ||11. | ||
| + | ||{{l|Image:Type_canvas_icon_0.63.06.png|14px}} | ||
| + | ||'''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. | ||
| + | |||
| + | |-style="background:#eeeeee" | ||
| + | ||12. | ||
| + | ||{{l|Image:Type_string_icon.png|14px}} | ||
| + | ||'''String ''' | ||
| + | ||a string of characters, for example "Hello Mum!" | ||
| + | |||
| + | |- | ||
| + | ||13. | ||
| + | ||{{l|Image:Type_gradient_icon.png|14px}} | ||
| + | ||'''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. | ||
Latest revision as of 17:14, 25 July 2013
ValueNode Types
Each ValueNode (and hence each Parameter) in Synfig has one of 13 types:
| Type | Description | ||
| 01. | Bool | a boolean value; true or false. Represented in Studio as a checkbox. | |
| 02. | Integer | an integer value; a whole number. -3 or 0 or 2 are examples. | |
| 03. | Real | a real number. -3.0, 0.0, 2.0 and 3.1415 are examples. | |
| 04. | Angle | a real number that is interpreted as an angle. | |
| 05. | Time | a time, displayed in days, hours, minutes, seconds and frames. | |
| 06. | Vector | a 2d vector. usually represented as two Reals representing X and Y values. | |
| 07. | Color | a color. Usually represented as Red/Green/Blue/Alpha values. | |
| 08. | Segment | a single bezier curve segment. Defined by 4 Vectors, representing 2 Vertices and 2 Tangents. | |
| 09. | 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. | List | A list. For example, an outline's Vertices parameter is simply a list of SplinePoint valuenodes. | |
| 11. | 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. | String | a string of characters, for example "Hello Mum!" | |
| 13. | 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. |
