suzanne.soy/FreeCAD-Doc
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity
master
FreeCAD-Doc/localwiki/Draft_Text.html
Kurt Kremitzki c04807e21f Initial commit
2018-07-08 12:11:49 -05:00

100 lines
7.9 KiB
HTML
Raw Permalink Blame History

<html><head><title>Draft Text</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>Draft Text</h1></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><div class="mw-parser-output"><table class="fcinfobox wikitable ct" >
<tr>
<td class="ctTitle">
<h3><span class="mw-headline" id="Draft_Text"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Draft_Text.png" class="image"><img alt="Draft Text.png" src="32px-Draft_Text.png" width="32" height="32" srcset="/wiki/images/thumb/9/9f/Draft_Text.png/48px-Draft_Text.png 1.5x, /wiki/images/9/9f/Draft_Text.png 2x" /></a> Draft Text</span></h3>
</td></tr>
<tr>
<th class="ctOdd">Menu location
</th></tr>
<tr>
<td class="ctEven">Draft → Text
</td></tr>
<tr>
<th class="ctOdd">Workbenches
</th></tr>
<tr>
<td class="ctEven"><a href="Draft_Module.html" title="Draft Module">Draft</a>, <a href="Arch_Module.html" title="Arch Module">Arch</a>
</td></tr>
<tr>
<th class="ctOdd">Default shortcut
</th></tr>
<tr>
<td class="ctEven">T E
</td></tr>
<tr>
<th class="ctOdd">See also
</th></tr>
<tr>
<td class="ctEven">None
</td></tr>
<tr>
<td class="ctToc"><br /><div id="toc" class="toc"><div class="toctitle"><h2>Contents</h2></div>
<ul>
<li class="toclevel-1"><a href="#Draft_Text"><span class="tocnumber">1</span> <span class="toctext">Draft Text</span></a></li>
<li class="toclevel-1 tocsection-1"><a href="#Description"><span class="tocnumber">2</span> <span class="toctext">Description</span></a></li>
<li class="toclevel-1 tocsection-2"><a href="#How_to_use"><span class="tocnumber">3</span> <span class="toctext">How to use</span></a></li>
<li class="toclevel-1 tocsection-3"><a href="#Options"><span class="tocnumber">4</span> <span class="toctext">Options</span></a></li>
<li class="toclevel-1 tocsection-4"><a href="#Properties"><span class="tocnumber">5</span> <span class="toctext">Properties</span></a></li>
<li class="toclevel-1 tocsection-5"><a href="#Scripting"><span class="tocnumber">6</span> <span class="toctext">Scripting</span></a></li>
</ul>
</div>
</td></tr></table>
<p><br />
</p>
<h2><span class="mw-headline" id="Description">Description</span></h2>
<p>The Text tool inserts a piece of text at a given point in the current document. It takes the <a href="Draft_Linestyle.html" title="Draft Linestyle">text size and color</a> previously set on the Tasks tab.
</p><p><a href="https://www.freecadweb.org/wiki/index.php?title=File:Draft_Text_example.jpg" class="image"><img alt="Draft Text example.jpg" src="400px-Draft_Text_example.jpg" width="400" height="214" srcset="/wiki/images/thumb/4/4f/Draft_Text_example.jpg/600px-Draft_Text_example.jpg 1.5x, /wiki/images/4/4f/Draft_Text_example.jpg 2x" /></a>
</p>
<h2><span class="mw-headline" id="How_to_use">How to use</span></h2>
<ol><li> Press the <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Draft_Text.png" class="image"><img alt="Draft Text.png" src="16px-Draft_Text.png" width="16" height="16" srcset="/wiki/images/thumb/9/9f/Draft_Text.png/24px-Draft_Text.png 1.5x, 32px-Draft_Text.png 2x" /></a> <a class="mw-selflink selflink">Draft Text</a></span> button, or press <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">T</span> then <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">E</span> keys</li>
<li> Click a point on the 3D view, or type a <a href="Draft_Coordinates.html" title="Draft Coordinates">coordinate</a></li>
<li> Enter the desired text, pressing <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">ENTER</span> between each line</li>
<li> Press <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">ENTER</span> twice to finish the operation.</li></ol>
<h2><span class="mw-headline" id="Options">Options</span></h2>
<ul><li> Pressing <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">CTRL</span> will <a href="Draft_Snap.html" title="Draft Snap">snap</a> your point to available snap locations.</li>
<li> To enter coordinates manually, simply enter the numbers, then press <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">ENTER</span> between each X, Y and Z component.</li>
<li> Pressing <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">ESC</span> will cancel the operation.</li>
<li> When editing the text, pressing <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">ENTER</span> or <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">DOWN ARROW</span> allow you to enter or edit a next line of text.</li>
<li> Pressing <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">UP ARROW</span> allows you to edit a previous line of text.</li>
<li> Pressing <span style="background: #DDDDDD; border: 1px solid #888888; padding: 0px 5px 1px 5px;">ENTER</span> <b>twice</b> (thus leaving the last line empty) adds the text to the document and closes the editor.</li></ul>
<h2><span class="mw-headline" id="Properties">Properties</span></h2>
<ul><li> <span style="font-size: 0.6em;padding-right:10px;">DATA</span><b>Position</b>: The base point of the text block</li>
<li> <span style="font-size: 0.6em;padding-right:10px;">DATA</span><b>Label Text</b>: The contents of the text block</li>
<li> <span style="font-size: 0.6em;padding-right:10px;">VIEW</span><b>Display Mode</b>: Specifies if the text is aligned to the scene axes or always faces the camera</li>
<li> <span style="font-size: 0.6em;padding-right:10px;">VIEW</span><b>Font Size</b>: The size of the letters</li>
<li> <span style="font-size: 0.6em;padding-right:10px;">VIEW</span><b>Justification</b>: Specifies if the text is aligned to the left, right or center of the base point.</li>
<li> <span style="font-size: 0.6em;padding-right:10px;">VIEW</span><b>Line Spacing</b>: Specifies the space between lines of text</li>
<li> <span style="font-size: 0.6em;padding-right:10px;">VIEW</span><b>Rotation</b>: Specifies a rotation to be applied to the text</li>
<li> <span style="font-size: 0.6em;padding-right:10px;">VIEW</span><b>Rotation Axis</b>: Specifies the axis to use for the rotation</li>
<li> <span style="font-size: 0.6em;padding-right:10px;">VIEW</span><b>Font Name</b>: The font to use to draw the text. It can be a font name, such as "Arial", a default style such as "sans", "serif" or "mono", or a family such as "Arial,Helvetica,sans" or a name with a style such as "Arial:Bold". If the given font is not found on the system, a generic one is used instead.</li></ul>
<h2><span class="mw-headline" id="Scripting">Scripting</span></h2>
<p>The Text tool can by used in <a href="Macros.html" title="Macros">macros</a> and from the python console by using the following function:
</p>
<pre>makeText (string or list, [Vector], [screenmode]) </pre>
<ul><li> Creates a Text object, at the given point if a vector is provided, containing the string or the strings given in the list, one string by line.</li>
<li> The current Draft color and text height and font specified in preferences are used. </li>
<li> If screenmode is True, the text always faces the view direction, otherwise it lies on the XY plane. </li>
<li> Returns the newly created object.</li></ul>
<p>Example:
</p>
<pre>import FreeCAD,Draft
Draft.makeText("This is a sample text",FreeCAD.Vector(1,1,0)) </pre>
<div style="clear:both"></div>
</div>
</div>
</div><div class="printfooter">
Online version: "<a dir="ltr" href="https://www.freecadweb.org/wiki/index.php?title=Draft_Text&amp;oldid=140113">http://www.freecadweb.org/wiki/index.php?title=Draft_Text&amp;oldid=140113</a>"</div>
<div id="catlinks" class="catlinks" data-mw="interface"></div><div class="visualClear"></div>
</div>
</div>
<div id="mw-navigation">
<h2>Navigation menu</h2>
</body></html>
Reference in New Issue View Git Blame Copy Permalink