Difference between revisions of "Canvas MetaData Panel"

From Synfig Studio :: Documentation
Jump to: navigation, search
m (new default key)
m (Rephrase sentence)
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
 
{{l|Image:meta_data_icon.png|64px}}
 
{{l|Image:meta_data_icon.png|64px}}
  
[[File:Canvas MetaData Panel-0.65.png|frame|none|Canvas MetaData Panel, scene_# and scene_name keys are personal]]
+
The {{Literal|Metadata panel}} shows all the useful existing keys:
  
{{Literal|Metadata panel}} shows you all the useful existing keys.
+
[[File:Canvas MetaData Panel-0.65.png|frame|none|Canvas MetaData Panel, scene_# and scene_name keys are personal]]
A few number of keys are created and stored for each new {{l|Canvas|canvas}} like {{literal|grid_snap}} or {{literal|guide_show}}.
+
  
* The {{literal|grid_color}} key expect three values for red, green and blue between the range [0,1] separated by a space (for example {{literal|0,5 0,5 1}} will set a light blue).
+
Part of the keys is created and stored for each new {{l|Canvas|Canvas}} like {{literal|grid_snap}} or {{literal|guide_show}}.
* The {{literal|guide_snap}} key stores whether snapping to guides is enabled or not. It stores {{literal|0}} if snapping to guides is disabled or {{literal|1}} if snapping to guides is enabled.
+
  
* {{literal|jack_offset}} : Jack synchronization offset time (in frame???)
+
A description of the keys is given below:
* {{literal|background_size}} : Checker background size,  x y (in pixel at zoom 1)
+
* {{literal|grid_color}}: sets the Color of the Grid. It's defined by three values for Red, Green and Blue in the range [0,1] separated by a space (e.g. {{literal|0,5 0,5 1}}).
* {{literal|background_first_color}}, Checker background first color, expect three values red[0,1] green[0,1] blue[0,1] for example {{literal|0,5 0,5 0,5}}
+
* {{literal|guide_snap}}: sets if Snapping to Guides is enabled ({{literal|1}}) or not ({{literal|0}}).
* {{literal|background_second_color}}, Checker background second color, expect three values red[0,1] green[0,1] blue[0,1] for example {{literal|0,1 0,1 0,1}}
+
* {{literal|jack_offset}}: sets the Jack synchronization offset time.
 +
* {{literal|background_size}}: sets the Checkerboard Background {{literal|x}} and {{literal|y}} size in pixels.
 +
* {{literal|background_first_color}}: sets the Checkerboard Background first color. It's defined by three values for Red, Green and Blue in the range [0,1] separated by a space (e.g. {{literal|0,5 0,5 0,5}}).
 +
* {{literal|background_second_color}}: sets the Checkerboard Background second color. It's defined by three values for Red, Green and Blue in the range [0,1] separated by a space (e.g. {{literal|0,1 0,1 0,1}}).
  
The units used in the {{Literal|Metadata panel}} for {{literal|guide_x}}, {{literal|guide_y}} and {{literal|grid_size}} keys, are {{l|Unit System|Synfig units}}.
+
The unit used in the {{Literal|Metadata panel}} for {{literal|guide_x}}, {{literal|guide_y}} and {{literal|grid_size}} keys, are {{l|Unit System|Synfig units}}.
  
You can add more personal keys but not useful for the program functionality. For example you can add the scene number or the author there, but they just will be stored in the file but not used by the application.
+
You can add other personal keys. For example, you can add the scene number or the author. Those personal keys will only be stored in the file without any explicit usage by Synfig.
  
 
===Usage===
 
===Usage===

Latest revision as of 03:23, 25 April 2020

Languages Language: 

English • français


Meta data icon.png

The "Metadata panel" shows all the useful existing keys:

Canvas MetaData Panel, scene_# and scene_name keys are personal

Part of the keys is created and stored for each new Canvas like "grid_snap" or "guide_show".

A description of the keys is given below:

  • "grid_color": sets the Color of the Grid. It's defined by three values for Red, Green and Blue in the range [0,1] separated by a space (e.g. "0,5 0,5 1").
  • "guide_snap": sets if Snapping to Guides is enabled ("1") or not ("0").
  • "jack_offset": sets the Jack synchronization offset time.
  • "background_size": sets the Checkerboard Background "x" and "y" size in pixels.
  • "background_first_color": sets the Checkerboard Background first color. It's defined by three values for Red, Green and Blue in the range [0,1] separated by a space (e.g. "0,5 0,5 0,5").
  • "background_second_color": sets the Checkerboard Background second color. It's defined by three values for Red, Green and Blue in the range [0,1] separated by a space (e.g. "0,1 0,1 0,1").

The unit used in the "Metadata panel" for "guide_x", "guide_y" and "grid_size" keys, are Synfig units.

You can add other personal keys. For example, you can add the scene number or the author. Those personal keys will only be stored in the file without any explicit usage by Synfig.

Usage

Grid

Guide


Languages Language: 

English • français