Hydrogen.Array Class Reference

Additional static functions used to extend existing Array support inside of Unity. More...

Static Public Member Functions
static bool	Add< T > (ref T[] array, T newObject, bool forceUnique)
	Add a unique item to an array. More...
static bool	Add< T > (ref T[] array, T newObject)
	Add an item to an array. More...
static bool	AddAt< T > (ref T[] array, int position, T newObject, bool forceUnique)
	Add a unique item to an array. More...
static bool	Contains< T > (ref T[] array, T targetObject)
	Determine if the specified array contains the targetObject. More...
static bool	Remove< T > (ref T[] array, T oldObject)
	Removes all references for an object from array. More...
static bool	RemoveAt< T > (ref T[] array, int index)
	Removes an object in an array at the provided index. More...

Detailed Description

Additional static functions used to extend existing Array support inside of Unity.

Definition at line 36 of file Array.cs.

Member Function Documentation

static bool Hydrogen.Array.Add< T > ( ref T[]  array, T  newObject, bool  forceUnique  )

static

Add a unique item to an array.

Returns

true, if something was added, false otherwise.

Parameters

array	The source array
newObject	Object to be added.
forceUnique	Should it check to see if there is an existing reference in the array?

Template Parameters

T	Object Type.

Definition at line 46 of file Array.cs.

                {
                        return AddAt (ref array, array.Length, newObject, forceUnique);
                }

static bool Hydrogen.Array.Add< T > ( ref T[]  array, T  newObject  )

static

Add an item to an array.

Returns

Was anything added?

Parameters

array	The source array
newObject	Object to be added.

Template Parameters

T	Object Type.

Definition at line 58 of file Array.cs.

                {
                        return AddAt (ref array, array.Length, newObject, false);
                }

static bool Hydrogen.Array.AddAt< T > ( ref T[]  array, int  position, T  newObject, bool  forceUnique  )

static

Add a unique item to an array.

Returns

true, if something was added, false otherwise.

Parameters

array	The source array.
position	The position (index) where to insert the object.
newObject	Object to be added.
forceUnique	Should it check to see if there is an existing reference in the array?

Template Parameters

T	Object Type.

Definition at line 72 of file Array.cs.

                {
                        // First Addition - Just Quick Add
                        if (array.Length == 0) {
                                array = new T[1];
                                array [0] = newObject;
                                return true;
                        }

                        // Check if we already have this target and unique is required  
                        if (forceUnique) {
                                if (array.Any (t => t.Equals (newObject))) {
                                        return false;
                                }
                        }

                        // Create new array
                        var newArray = new T[array.Length + 1];

                        for (var x = 0; x <= array.Length; x++) {
                                if (x < position) {
                                        newArray [x] = array [x];
                                } else if (x == position) {
                                        newArray [x] = newObject;
                                } else if (x > position) {
                                        newArray [x] = array [x - 1];
                                }
                        }

                        // Assign array
                        array = newArray;

                        return true;
                }

static bool Hydrogen.Array.Contains< T > ( ref T[]  array, T  targetObject  )

static

Determine if the specified array contains the targetObject.

Returns

true, if something was found, false otherwise.

Parameters

array	The source array.
targetObject	Object to test for.

Template Parameters

T	Object Type

Definition at line 114 of file Array.cs.

                {
                        return array.Any (t => t.Equals (targetObject));
                }

static bool Hydrogen.Array.Remove< T > ( ref T[]  array, T  oldObject  )

static

Removes all references for an object from array.

Returns

true, if something was removed, false otherwise.

Parameters

array	The source array.
oldObject	Object to be removed.

Template Parameters

T	Object Type.

Definition at line 126 of file Array.cs.

                {

                        // Make sure we're not trying to remove nothing
                        if (oldObject.Equals (null)) {
                                return false;
                        }

                        var newArray = new T[array.Length - 1];
                        var counter = 0;
                        var found = false;

                        foreach (var singleObject in array) {
                                if (!singleObject.Equals (oldObject)) {
                                        newArray [counter] = singleObject;
                                        counter++;
                                } else {
                                        found = true;
                                }
                        }

                        if (found) {
                                array = newArray;
                        }

                        return found;
                }

static bool Hydrogen.Array.RemoveAt< T > ( ref T[]  array, int  index  )

static

Removes an object in an array at the provided index.

Returns

true, if something was removed, false otherwise.

Parameters

array	The source array.
index	The index of the item to be removed.

Template Parameters

T	Object Type.

Definition at line 161 of file Array.cs.

                {
                        // Failsafe
                        if (index >= array.Length || index < 0)
                                return false;

                        var newArray = new T[array.Length - 1];
                        var counter = 0;

                        for (int x = 0; x < array.Length; x++) {
                                if (x != index) {
                                        newArray [counter] = array [x];
                                        counter++;
                                }
                        }
                        array = newArray;
                        return true;
                }