Difference between revisions of "Tool Options Panel"

From Synfig Studio :: Documentation
Jump to: navigation, search
(Update options strings : remove Splines in Create [outline|advanced|Region|...] Spline + Update options Link Origins (Circle/Star Layer) + Order options as UI + Fill Polygon tool options)
m (intro section, minor rewrite intro)
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<!-- Page info -->
 
<!-- Page info -->
 
{{Title|Tool Options Panel}}
 
{{Title|Tool Options Panel}}
 +
{{TOCright}}
 
{{Category|Panels}}
 
{{Category|Panels}}
 
{{NewTerminology}}
 
{{NewTerminology}}
 
<!-- Page info end -->
 
<!-- Page info end -->
 +
=Introduction=
 +
The {{Literal|Tool Options Panel}} displays the options you have available to apply to the {{l|Toolbox|current tool}} you're using. For the tools that can create multiple layers at the same time the panel contextually display the available options for the selected type of layers.
  
The {{Literal|Tool Options Panel}} displays the options you have available to apply to the current tool you're using. The icon selected of the panel is the current active tool is being used.  
+
The icon for the Tool Options Panel always changes to what tool you're currently using.
  
 
The values of the {{Literal|Tool Options Panel}} parameters are stored between tool usages and between SynfigStudio sessions, so you can reuse them as may times as you like.
 
The values of the {{Literal|Tool Options Panel}} parameters are stored between tool usages and between SynfigStudio sessions, so you can reuse them as may times as you like.
  
 
This is the list of available options for each tool:
 
This is the list of available options for each tool:
*[[File:Tool Normal.png|30px]] {{l|Transform tool}}
+
==[[File:Tool Normal.png|30px]] {{l|Transform tool}}==
**None
+
<!-- Use of Template|TransformToolOptions -->
*[[File:Tool smooth move.png|30px]]{{l|Smooth Move Tool}}
+
{{TransformToolOptions}}
**Radius (real number)
+
 
*[[File:Tool scale.png|30px]] {{l|Scale Tool}}
+
==[[File:Tool smooth move.png|30px]]{{l|Smooth Move Tool}}==
**Lock Aspect Ratio (boolean)
+
<!-- Use of Template|SmoothMoveToolOptions -->
*[[File:Tool rotate.png|30px]] {{l|Rotate Tool}}
+
{{SmoothMoveToolOptions}}
**Allow Scale (boolean)
+
 
*[[File:Tool mirror.png|30px]] {{l|Mirror Tool}}
+
==[[File:Tool scale.png|30px]] {{l|Scale Tool}}==
**Horizontal (boolean exclusive)
+
<!-- Use of Template|ScaleToolOptions -->
**Vertical (boolean exclusive)
+
{{ScaleToolOptions}}
*[[File:Tool circle icon.png|30px]] {{l|Circle Tool}}
+
 
**New Layer's name (text)
+
==[[File:Tool rotate.png|30px]] {{l|Rotate Tool}}==
**Create Circle Layer (boolean)
+
<!-- Use of Template|RotateToolOptions -->
**Create Outline (boolean)
+
{{RotateToolOptions}}
**Create Advanced Outline (boolean)
+
 
**Create Region (boolean)
+
==[[File:Tool mirror.png|30px]] {{l|Mirror Tool}}==
**Create Plant (boolean)
+
<!-- Use of Template|MirrorToolOptions -->
**Create Curve Gradient (boolean)
+
{{MirrorToolOptions}}
**Link Origins (boolean)
+
 
**Spline Origins at Center (boolean)
+
==[[File:Tool circle icon.png|30px]] {{l|Circle Tool}}==
**Invert (boolean)
+
<!-- Use of Template|CircleToolOptions -->
**Falloff (drop down list)
+
{{CircleToolOptions}}
**Feather (real)
+
 
**Spline points (integer)
+
==[[File:Tool rectangle icon.png|30px]] {{l|Rectangle Tool}}==
**Point Angle Offset (angle)
+
<!-- Use of Template|RectangleToolOptions -->
*[[File:Rectangle_icon.png|30px]] {{l|Rectangle Tool}}
+
{{RectangleToolOptions}}
**New Layer's name (text)
+
 
**Create Rectangle Layer (boolean)
+
==[[File:Tool star icon.png|30px]] {{l|Star Tool}}==
**Create Outline (boolean)
+
<!-- Use of Template|StarToolOptions -->
**Create Advanced Outline (boolean)
+
{{StarToolOptions}}
**Create Region (boolean)
+
 
**Create Plant (boolean)
+
==[[File:Tool polygon icon.png|30px]] {{l|Polygon Tool}}==
**Create Curve Gradient (boolean)
+
<!-- Use of Template|PolygonToolOptions -->
**Link Spline Origins (boolean)
+
{{PolygonToolOptions}}
**Invert (boolean)
+
 
**Expansion (real)
+
==[[File:Tool gradient icon.png|30px]] {{l|Gradient Tool}}==
**Feather (real)
+
<!-- Use of Template|GradientToolOptions -->
*[[File:Tool star icon.png|30px]] {{l|Star Tool}}
+
{{GradientToolOptions}}
**New Layer's name (text)
+
 
**Create Star Layer (boolean)
+
==[[File:Tool bline icon.png|30px]]{{l|Spline Tool}}==
**Create Outline (boolean)
+
<!-- Use of Template:SplineToolOptions -->
**Create Advanced Outline (boolean)
+
{{SplineToolOptions}}
**Create Region (boolean)
+
 
**Create Plant (boolean)
+
==[[File:Tool draw icon.png|30px]] {{l|Draw Tool}}==
**Create Curve Gradient (boolean)
+
<!-- Use of Template|DrawMoveToolOptions -->
**Link Origins (boolean)
+
{{DrawToolOptions}}
**Spline Origins at Center (boolean)
+
 
**Invert (boolean)
+
==[[File:Tool cutout icon.png|30px]] {{l|Cutout Tool}}==
**Regular Polygon (boolean)
+
<!-- Use of Template|CutoutToolOptions -->
**Feather (real)
+
{{CutoutToolOptions}}
**Number of points (integer)
+
 
**Inner Tangent (real)
+
==[[File:Tool width icon.png|30px]] {{l|Width Tool}}==
**Outer Tangent (real)
+
<!-- Use of Template|WidthToolOptions -->
**Inner Width (real)
+
{{WidthToolOptions}}
**Outer Width (real)
+
 
**Radius Ratio (real)
+
==[[File:Tool fill icon.png|30px]] {{l|Fill Tool}}==
**Angle Offset (real)
+
<!-- Use of Template|FillToolOptions -->
*[[File:Tool polygon icon.png|30px]] {{l|Polygon Tool}}
+
{{FillToolOptions}}
**New Layer's name (text)
+
 
**Create Star Layer (boolean)
+
==[[File:Tool eyedrop icon.png|30px]] {{l|Eyedrop Tool}}==
**Create Outline (boolean)
+
<!-- Use of Template|EyedropToolOptions -->
**Create Advanced Outline (boolean)
+
{{EyedropToolOptions}}
**Create Region (boolean)
+
 
**Create Plant (boolean)
+
==[[File:Tool text icon.png|30px]] {{l|Text Tool}}==
**Create Curve Gradient (boolean)
+
<!-- Use of Template|TextToolOptions -->
**Link Origins (boolean)
+
{{TextToolOptions}}
**Spline Origins at Center (boolean)
+
 
**Invert (boolean)
+
==[[File:Tool sketch icon.png|30px]] {{l|Sketch Tool}}==
**Feather (real)
+
<!-- Use of Template|SketchToolOptions -->
**Make Polygon (action button)
+
{{SketchToolOptions}}
**Clear current Polygon (action button)
+
 
*[[File:Tool gradient icon.png|30px]] {{l|Gradient Tool}}
+
==[[File:Tool brush icon.png|30px]] {{l|Brush Tool}}==
**New Layer's name (text)
+
<!-- Use of Template|BrushToolOptions -->
**Gradient Type (drop down list)
+
{{BrushToolOptions}}
*[[File:Tool bline icon.png|30px]]{{l|Spline Tool}}
+
 
**New Layer's name (text)
+
==[[File:Tool zoom icon.png|30px]] {{l|Zoom Tool}}==
**Create Outline (boolean)
+
<!-- Use of Template|ZoomToolOptions -->
**Create Advanced Outline (boolean)
+
{{ZoomToolOptions}}
**Create Region (boolean)
+
**Create Plant (boolean)
+
**Create Curve Gradient (boolean)
+
**Link Origins (boolean)
+
**Auto Export (boolean)
+
**Feather (real)
+
*[[File:Tool draw icon.png|30px]] {{l|Draw Tool}}
+
**New Layer's name (text)
+
**Create Outline (boolean)
+
**Create Advanced Outline (boolean)
+
**Create Region (boolean)
+
**Auto Loop (boolean)
+
**Auto Extend (boolean)
+
**Auto Link (boolean)
+
**Auto Export (boolean)
+
**Pressure Width (boolean)
+
**Local Error (boolean)
+
**Min Pressure (boolean) & (real)
+
**Spline Smoothness (real)
+
**Max Width Error (real)
+
**Feather (real)
+
**Fill Last Stroke (action button)
+
*[[File:Tool width icon.png|30px]] {{l|Width Tool}}
+
**Growth (real)
+
**Radius (real)
+
**Relative Growth (boolean)
+
*[[File:Tool fill icon.png|30px]] {{l|Fill Tool}}
+
**None
+
*[[File:Tool eyedrop icon.png|30px]] {{l|Eyedrop Tool}}
+
**None
+
*[[File:Tool text icon.png|30px]] {{l|Text Tool}}
+
**New Layer's name (text)
+
**Multiline Editor (boolean)
+
**Size (2D vector)
+
**Orientation (2D vector)
+
**Family (text)
+
*[[File:Tool sketch icon.png|30px]] {{l|Sketch Tool}}
+
**Show Sketch (boolean)
+
**Undo Last Stroke (action button)
+
**Clear Sketch (action button)
+
**Save Sketch As... (action button)
+
**Open a Sketch (action button)
+
*[[File:Tool zoom icon.png|30px]] {{l|Zoom Tool}}
+
**None
+

Latest revision as of 10:08, 4 April 2016

Languages Language: 

English • français



Introduction

The "Tool Options Panel" displays the options you have available to apply to the current tool you're using. For the tools that can create multiple layers at the same time the panel contextually display the available options for the selected type of layers.

The icon for the Tool Options Panel always changes to what tool you're currently using.

The values of the "Tool Options Panel" parameters are stored between tool usages and between SynfigStudio sessions, so you can reuse them as may times as you like.

This is the list of available options for each tool:

Tool normal.png Transform Tool

  • None

Tool smooth move.pngSmooth Move Tool

  • Radius (real number)

Tool scale.png Scale Tool

Scale Tool Options.png

The Tool Options Panel allows you to specify:

  • Lock Aspect Ratio : Prevent from changing the ratio x:y of the bounding box of the selected Handles.


Tool rotate.png Rotate Tool

Rotate Tool Options.png
  • Allow Scale : Allow the selected Handles to be scaled and rotated at the same time.


Tool mirror.png Mirror Tool

Mirror Tool Options.png
  • Horizontal : Horizontal axis mirror.
  • Vertical : Vertical axis mirror.


Tool circle icon.png Circle Tool

Circle Tool Options.png

The Tool Options Panel allows you to specify:

  • Name : Used for the new layer; any number in this field will automatically increment with each layer created
  • Layer Type : Whether create Star Layer and/or Outline, Advanced Outline, Region, Plant and Curve Gradient layers (Splines)
  • Blend Method : The blending method used to composite on the layers below
  • Opacity : Sets the Amount for new layers. Defaults to 1.00 (Completely opaque)
  • Brush Size : Sets the Outline width or the size of the gradient (only for Outline, Advanced Outline and Curve Gradient)
  • Spline Points : Specify the number of Spline Points that will be used in the new Splines (for other than Circle Layer)
  • Offset : Offset of the tangent of the Spline Points (for other than Circle Layer)
  • Invert : Whether invert the create(d) layer(s). Is related to his Invert.
  • Feather : Width of the area to be dissolved at the edge (not for Plant and Curve Gradient)
  • Falloff : Determines the falloff function for the feather (only for Circle Layer)
  • Link Origins : Whether Link the Offset of Splines
  • Spline Origins at Center : Set the origin of the layer at the center of the circle, else the center is set at the Canvas center


Tool rectangle icon.png Rectangle Tool

Rectangle Tool Options.png

The Tool Options Panel allows you to specify:


Tool star icon.png Star Tool

Star Tool Options.png

The Tool Options Panel allows you to specify:

  • Name : The name used for the new layer; any number in this field will automatically increment with each layer created
  • Layer Type  : Whether create Star Layer and/or Outline, Region, Plant and Curve Gradient layers (Splines)
  • Blend Method : How to combine the new layer with the background.
  • Opacity : Sets the Amount for new layers. Defaults to 1.00 (Completely opaque)
  • Brush Size : Sets the Outline width or the size of the gradient (only for Outline, Advanced Outline and Curve Gradient)
  • Star Points : The number of peaks of the star.
  • Offset : The rotation offset of the created star.
  • Radius Ratio : The ratio between the peaks and the troughs of the star
  • Regular Polygon : Whether create a regular polygon instead of a star.
  • For Splines only, the tangent lengths for outer and inner vertices. Outer is limited to [-3,10] and inner is limited to [-3,3]. (If you find useful open those limitations please write it in the talk page)
    • Inner Width
    • Inner Tangent
    • Outer Width
    • Outer Tangent
  • Invert : Whether invert the create(d) layer(s)
  • Feather : Width of the area to be dissolved at the edge (not for Plant and Curve Gradient)
  • Link Origins : Whether Link the Origin of Splines
  • Spline Origins at Center : Set the Origin of the layer at the center of the star, else the center is set at the Canvas center


Tool polygon icon.png Polygon Tool

Polygon Tool Options.png

The Tool Options Panel allows you to specify:


Tool gradient icon.png Gradient Tool

Gradient Tool Options.png

When you select the Gradient Tool, the Tool Options Panel will show the options for the Gradient Tool.

These allow you to:

  • Name : Set a name for the layer you are about to create. The name of the layer can always be changed later via the Layers Panel or the Parameters Panel if necessary, but the type of gradient needs to be chosen now.
  • Layer Type : Choose the type of gradient to create (Linear, Radial, Conical, Spiral).
  • Blend Method : The blending method used to composite on the layers below
  • Opacity : Sets the Amount for new layers. Defaults to 1.00 (Completely opaque)

For help with editing gradient colors see the section on Gradient Editor Dialog.

Tool bline icon.pngSpline Tool

Spline Tool Options.png

This tool has the following options:

  • Name: Sets the name of the Spline that you will create, in this case "Spline070". If the ending part of the string contains an integer number, this input text box will parse it and increase that number for the next created Spline. Otherwise, it will add a three digit number while creating the next one.
  • Layer Type: Sets whether to create Region, Outline, Advanced Outline, Plant and/or Curve Gradient Layers.
  • Blend Method: Sets the blending method used to composite on the layers below.
  • Opacity: Sets the Amount for new layers. Defaults to 1.00 (Completely opaque).
  • Brush Size: Sets the size of the line for Outline Layer and/or Advanced Outline Layer.
  • Feather: Sets the feather parameter of the Region or Outline Layer created.
  • Link Origin: If checked, links the Origin for the Plant, Region or Outline if two of them (or all them) are checked.
  • Auto Export: If checked, exports automatically the Vertices parameter (that's a Spline type parameter)


Tool draw icon.png Draw Tool

Draw Tool Options.png

The Tool Options Panel allows you to specify:

  • Name : Used for the new layer; any number in this field will automatically increment with each layer created
  • Layer Type : Whether create Outline and/or Advanced Outline, Region layers (Splines)
  • Blend Method : The blending method used to composite on the layers below
  • Opacity : Sets the Amount for new layers. Defaults to 1.00 (Completely opaque)
  • Brush Size : Sets the Outline width or the size of the gradient (only for Outline, Advanced Outline and Curve Gradient)
  • Pressure Sensitive
    • Min Pressure : The value of this option clamps the lower end of the Pressure sensitivity to a specific value, essentially determining how thin the thinnest possible segment is relative to the Brush Size parameter in the Toolbox.
  • Smoothness : Determines how much tablet jitter is removed, and as a result, how many vertices the resulting splines are composed of. Could by Local or Global
    • Local : Adjust the Spline between the Splines points.
    • Global : Adjust the Spline globally.
  • Width Max Error : for advanced outline layer.
  • Round End : The ends of the spline will be rounded, only for Outline, Advanced Outline layers.
  • Auto Loop : When the stroke of the "Draw Tool" ends near the beginning of the stroke, automatically connect the last Handle to the first.
  • Auto Extend : When the stroke begins and/or end at or near an endpoint Handle of another outline, the resulting outline is simply appended to the existing Outline Layer
  • Auto Link : When the stroke begins and/or ends at or near a vertex Handle in another outline, and the outline isn't being extended by the "Auto Extend" option above, the first and/or last vertex of the resulting outline is linked to the Handle on the existing Outline Layer.
  • Feather : Set the Feather Parameter on the layer
  • Auto Export : Automatically Export the Spline list points into the Values Base Nodes of the Library Panel


Tool cutout icon.png Cutout Tool

CutoutToolOptions.png
  • Smoothness : Adjust the Spline defining the Mask. Could be Local or Global
    • Local : Adjust the Spline between the Splines points.
    • Global : Adjust the Spline Globally.
  • Feather : Width of the area that is going to be dissolved at the edge of the mask.


Tool width icon.png Width Tool

WidthToolOptions.png
  • Growth - Defines how much a single mouse move will affect the line width. It must be non-zero for this tool to have an effect on the spline.
  • Radius - Defines the size of area around current cursor position in which a vertex will be affected. It is allows you to achieve a noticeable effect without having to follow the line precisely with the mouse. The Width Tool works fine on splines with lots of segments (such as those created with the Draw Tool), you will see it works on more than just the first vertex. It is a full circular area, other points may get in the way though.
  • Relative Growth - Doesn't really work very well unless the "Radius" parameter is set to some huge value (like a million).


Tool fill icon.png Fill Tool

  • None

Tool eyedrop icon.png Eyedrop Tool

  • None

Tool text icon.png Text Tool

The Tool Options Panel allows you to specify:

  • the Name used for the new layer; any number in this field will automatically increment with each layer created
  • "Multiline Editor" - whether to use a single or multi-line editor for entering the text. If a single line is used then the ↵ Enter key will submit the value. In the multi-line editor, you'll need to click the "OK" button with the mouse to confirm the text or hit Ctrl⇆ Tab to give focus to "OK" button.
  • "Size" X Y - the horizontal and vertical size of the text
  • "Orientation" X Y - the orientation of the text. The default (0.5, 0.5) means that the text will be centered around the point you clicked on. (0, 0) means that the top left corner of a box containing the text will be placed where you clicked. (1, 1) means that the bottom right corner of the text's bounding box will be placed where you clicked
  • "Family" - the font family to be used

Tool sketch icon.png Sketch Tool

Sketch Tool Options.png

The Sketch Tool has the following in its Tool Options Panel :

  • Show Sketch: a checkbox for toggling the visibility of the sketch overlay On and Off.
  • Undo Last Stroke: cancels the most recent edit to the sketch overlay. Can be repeatedly clicked to cancel more edits.
  • Clear Sketch: clears the current workarea's sketch overlay.
  • Save Sketch As...: writes the sketch overlay from the current workarea to a .sketch file.
  • Open a Sketch: loads a previously saved .sketch file, overwriting any previously drawn or opened sketch in the current workarea.

Sketch uses the color of the default "foreground color" in the Toolbox.

Tool brush icon.png Brush Tool

Brush Tool Options.png
  • Eraser check box. When checked, the brush acts as a rubber.
  • Display the set of configured brushes (MyPaint brushes format). By default, Synfig is installed with a selected set of brushes from "Concept Design (C_D)" pack by Ramon Miranda.
    From the Preferences Dialog, you can configure the "Brush Presets Path" to use other brushes package (for example the ones listed by MyPaint)

The "Brush Tool" uses the color of the Outline Color and the Brush Size set in the Toolbox to paint.

Tool zoom icon.png Zoom Tool

  • None


Languages Language: 

English • français