Jholsenback: 1 revision: Reference Migration Initial Load

2012-03-15T19:05:04Z

1 revision: Reference Migration Initial Load

Jholsenback: link repair

2012-03-15T14:46:21Z

link repair

New page

[[Category:Include Files]]
{{#indexentry:include files, arrays.inc}}
This file contains macros for manipulating arrays.

{{#indexentry:include files, ARRAYS_WriteDF3}}
<code>ARRAYS_WriteDF3(Array, FileName, BitDepth)</code>: Write an array to a df3 file.
Parameters:
<ul>
<li><code>Array</code> = The array that contains the data.</li>
<li><code>FileName</code> = The name of the file to be written.</li>
<li><code>BitDepth</code> = The size of the binary word.</li>
</ul>

Note: See the [[Reference:File I/O Directives#The write Directive|#write]] directive for more information.

{{#indexentry:include files, Rand_Array_Item}}
<code>Rand_Array_Item(Array, Stream)</code>: Randomly Picks an item from a 1D array.
Parameters:
<ul>
<li><code>Array</code> = The array from which to choose the item.</li>
<li><code>Stream</code> = A random number stream.</li>
</ul>

{{#indexentry:include files, Resize_Array}}
<code>Resize_Array(Array, NewSize)</code>: Resize a 1D array, retaining its contents.
Parameters:
<ul>
<li><code>Array</code> = The array to be resized.</li>
<li><code>NewSize</code> = The desired new size of the array.</li>
</ul>

{{#indexentry:include files, Reverse_Array}}
<code>Reverse_Array(Array)</code>: Reverses the order of items in a 1D array.
Parameters:
<ul>
<li><code>Array</code> = The array to be reversed.</li>
</ul>

{{#indexentry:include files, Sort_Compare}}
<code>Sort_Compare(Array, IdxA, IdxB)</code>: This macro is used by the <code>Sort_Array()</code>
and <code>Sort_Partial_Array()</code> macros. The given macro works for 1D arrays of floats, but
you can redefine it in your scene file for more complex situations, arrays of vectors or
multidimensional arrays for example. Just make sure your macro returns true if the item at IdxA <
the item at IdxB, and otherwise returns false.
Parameters:
<ul>
<li><code>Array</code> = The array containing the data being sorted.</li>
<li><code>IdxA, IdxB</code> = The array offsets of the data elements being compared.</li>
</ul>

{{#indexentry:include files, Sort_Swap_Data}}
<code>Sort_Swap_Data(Array, IdxA, IdxB)</code>: This macro is used by the <code>Sort_Array()</code>
and <code>Sort_Partial_Array()</code> macros. The given macro works for 1D arrays only,
but you can redefine it in your scene file to handle multidimensional arrays if needed.
The only requirement is that your macro swaps the data at IdxA with that at IdxB.
Parameters:
<ul>
<li><code>Array</code> = The array containing the data being sorted.</li>
<li><code>IdxA, IdxB</code> = The array offsets of the data elements being swapped.</li>
</ul>

{{#indexentry:include files, Sort_Array}}
<code>Sort_Array(Array)</code>: This macro sorts a 1D array of floats, though you can
redefine the <code>Sort_Compare()</code> and <code>Sort_Swap_Data()</code> macros to
handle multidimensional arrays and other data types.
Parameters:
<ul>
<li><code>Array</code> = The array to be sorted.</li>
</ul>

{{#indexentry:include files, Sort_Partial_Array}}
<code>Sort_Partial_Array(Array, FirstInd, LastInd)</code>: This macro is like
<code>Sort_Array()</code>, but sorts a specific range of an array instead of the whole array.
Parameters:
<ul>
<li><code>Array</code> = The array to be sorted.</li>
<li><code>FirstInd, LastInd</code> = The start and end indices of the range being sorted.</li>
</ul>

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

Reference:Arrays.inc - Revision history

Jholsenback: 1 revision: Reference Migration Initial Load

Jholsenback: link repair