Jholsenback: 1 revision: Reference Migration Initial Load

2012-03-15T19:08:57Z

1 revision: Reference Migration Initial Load

Jholsenback: link repair

2012-03-15T14:38:04Z

link repair

New page

[[Category:Include Files]]
This include contains macros for manipulating and generating text strings.
{{#indexentry:CRGBStr}}
<code>CRGBStr(C, MinLen, Padding)</code> and <code>CRGBFTStr(C, MinLen, Padding)</code>: These macros convert a color to a string. The format of the output string is "rgb < R, G, B>" or "rgbft < R, G, B, F, T>", depending on the macro being called.
Parameters:
<ul>
<li><code>C</code> = The color to be turned into a string.</li>
<li><code>MinLen</code> = The minimum length of the individual components, analogous to the second parameter of str().</li>
<li><code>Padding</code> = The padding to use for the components, see the third parameter of the str() function for details.</li>
</ul>

{{#indexentry:Str, strings.inc}}
<code>Str(A)</code>: This macro creates a string containing a float with the systems default precision. It is a shortcut for using the str() function.
Parameters:<ul>
<li><code>A</code> = The float to be converted to a string.</li>
</ul>
{{#indexentry:Vstr, strings.inc}}

{{#indexentry:VStr2D, short form}}
<code>VStr2D(V), VStr(V)</code>: These macros create strings containing vectors using POV syntax (<X,Y,Z>) with the default system precision. VStr2D() works with 2D vectors, VStr() with 3D vectors. They are shortcuts for using the <code>vstr()</code> function.
Parameters:
<ul>
<li><code>V</code> = The vector to be converted to a string.</li>
</ul>

{{#indexentry:Vstr2D, long form}}
<code>Vstr2D(V,L,P), Vstr(V,L,P)</code>: These macros create strings containing vectors using POV syntax (<X,Y,Z>) with user specified precision. Vstr2D() works with 2D vectors, Vstr() with 3D vectors. They are shortcuts for using the vstr() function. The function of L and P is the same as in <code>vstr</code> specified in [[Reference:Strings#String Functions|String Functions]].
Parameters:
<ul>
<li><code>V</code> = The vector to be converted to a string.</li>
<li><code>L</code> = Minimum length of the string and the type of left padding used if the string's representation is shorter than the minimum.</li>
<li><code>P</code> = Number of digits after the decimal point.</li>
</ul>

{{#indexentry:Triangle_Str}}
<code>Triangle_Str(A, B, C)</code> and <code>Smooth_Triangle_Str(A, NA, B, NB, C, NC)</code>: These macros take vertex and normal information and return a string representing a triangle in POV-Ray syntax. They are mainly useful for generating mesh files.
Parameters:
<ul>
<li><code>A, B, C</code> = Triangle vertex points.</li>
<li><code>NA, NB, NC</code> = Triangle vertex normals (Smooth_Triangle_Str() only).</li>
</ul>

{{#indexentry:Parse_String}}
<code>Parse_String(String)</code>: This macro takes a string, writes it to a file, and then includes that file. This has the effect of parsing that string: "<code>Parse_String("MyColor")</code>" will be seen by POV-Ray as "<code>MyColor</code>".
Parameters:
<ul>
<li><code>String</code> = The string to be parsed.</li>
</ul>

← Older revision	Revision as of 19:08, 15 March 2012
(No difference)

Reference:Strings.inc - Revision history

Jholsenback: 1 revision: Reference Migration Initial Load

Jholsenback: link repair