Difference between revisions of "Dev:Types"
From Synfig Studio :: Documentation
m |
m (Add type icons) |
||
Line 3: | Line 3: | ||
Each {{l|ValueNode}} (and hence each {{l|Parameter}}) in Synfig has one of 13 types: | Each {{l|ValueNode}} (and hence each {{l|Parameter}}) in Synfig has one of 13 types: | ||
− | # '''Bool''' -- a boolean value; true or false. Represented in Studio as a checkbox | + | # {{l|Image:Type_bool_icon.png|14px}} '''Bool''' -- a boolean value; true or false. Represented in Studio as a checkbox |
− | # '''Integer''' -- an integer value; a whole number. -3 or 0 or 2 are examples. | + | # {{l|Image:Type_integer_icon.png|14px}} '''Integer''' -- an integer value; a whole number. -3 or 0 or 2 are examples. |
− | # '''Real''' -- a [http://en.wikipedia.org/wiki/Real_number real number}}. -3.0, 0.0, 2.0 and 3.1415 are examples. | + | # {{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. |
− | # '''Angle''' -- a real number that is interpreted as an angle | + | # {{l|Image:Type_angle_icon.png|14px}} '''Angle''' -- a real number that is interpreted as an angle |
− | # '''Time''' -- a time, displayed in days, hours, minutes, seconds and frames | + | # {{l|Image:Type_time_icon.png|14px}} '''Time''' -- a time, displayed in days, hours, minutes, seconds and frames |
− | # '''Vector''' -- a 2d vector. usually represented as two Reals representing X and Y values | + | # {{l|Image:Type_vector_icon.png|14px}} '''Vector''' -- a 2d vector. usually represented as two Reals representing X and Y values |
− | # '''Color''' -- a color. Usually represented as Red/Green/Blue/Alpha values | + | # {{l|Image:Type_color_icon.png|14px}} '''Color''' -- a color. Usually represented as Red/Green/Blue/Alpha values |
− | # '''Segment''' -- a single bezier curve segment. Defined by 4 Vectors, representing 2 Vertices and 2 Tangents | + | # {{l|Image:Type_segment_icon.png|14px}} '''Segment''' -- a single bezier curve segment. Defined by 4 Vectors, representing 2 Vertices and 2 Tangents |
− | # '''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) | + | # {{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) |
− | # '''List''' -- A list. For example, an outline's Vertices parameter is simply a list of SplinePoint valuenodes. | + | # {{l|Image:Type_list_icon.png|14px}} '''List''' -- A list. For example, an outline's Vertices parameter is simply a list of SplinePoint valuenodes. |
− | # '''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. | + | # {{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. |
− | # '''String''' -- a string of characters, for example "Hello Mum!" | + | # {{l|Image:Type_string_icon.png|14px}} '''String ''' -- a string of characters, for example "Hello Mum!" |
− | # '''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. | + | # '{{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. |
Revision as of 15:56, 24 July 2013
ValueNode Types
Each ValueNode (and hence each Parameter) in Synfig has one of 13 types:
- Bool -- a boolean value; true or false. Represented in Studio as a checkbox
- Integer -- an integer value; a whole number. -3 or 0 or 2 are examples.
- Real -- a [http://en.wikipedia.org/wiki/Real_number real number}}. -3.0, 0.0, 2.0 and 3.1415 are examples.
- Angle -- a real number that is interpreted as an angle
- Time -- a time, displayed in days, hours, minutes, seconds and frames
- Vector -- a 2d vector. usually represented as two Reals representing X and Y values
- Color -- a color. Usually represented as Red/Green/Blue/Alpha values
- Segment -- a single bezier curve segment. Defined by 4 Vectors, representing 2 Vertices and 2 Tangents
- 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)
- List -- A list. For example, an outline's Vertices parameter is simply a list of SplinePoint valuenodes.
- 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.
- String -- a string of characters, for example "Hello Mum!"
- ' 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.