common
Class ColorArray

Object
  common:Array
      common:ColorArray

class 
Array:ColorArray

Generic Color dynamic array object wrapper.

This is a generic dynamic array wrapper class for Color data. See the Array base class for more information.

Ultra Fractal Source

Toggle UF Source Code Display

 class ColorArray(Array) {
   ; Generic Color dynamic array object wrapper.
   ; <p>
   ; This is a generic dynamic array wrapper class for
   ; Color data. See the Array base class for more
   ; information.
   
 public:
   ; Constructor
   ;
   ; @param plength initial length of the array
   func ColorArray(int plength)
     setLength(m_Elements, plength)
   endfunc
 
   ; Length wrapper
   ;
   ; @return the number of elements in the array
   int func GetArrayLength()
     return length(m_Elements)
   endfunc
   
   ; setLength wrapper
   ; <p>
   ; This is analagous to UF's native setLength() function
   ; for dynamic arrays.
   ;
   ; @param plength new length of the array
   func SetArrayLength(int plength)
     setLength(m_Elements, plength)
   endfunc
 
   ; Copy (must be implemented in each type)
   ;
   ; @param dest ColorArray object to copy all values into; previous contents of dest will be discarded.
   func Copy(ColorArray &dest)
     int l = this.GetArrayLength()
     if (dest == 0)
       dest = new ColorArray(l)
     else
       dest.SetArrayLength(l)
     endif
     int j = 0
     while (j < l)
       dest.m_Elements[j] = m_Elements[j]
       j = j + 1
     endwhile
   endfunc
 
   ; Array elements (for direct access)
   color m_Elements[]
   
 default:
 }
 

Constructor Summary

ColorArray()

ColorArray(int plength)
Constructor

Method Summary

void	Copy(ColorArray dest) Copy (must be implemented in each type)
int	GetArrayLength() Length wrapper
void	SetArrayLength(int plength) setLength wrapper

Methods inherited from class Object

Constructor Detail

ColorArray

public ColorArray(int plength)

Constructor

Parameters:

plength - initial length of the array

ColorArray

public ColorArray()

Method Detail

GetArrayLength

public int GetArrayLength()

Length wrapper

Overrides:

GetArrayLength in class Array

Returns:

the number of elements in the array

SetArrayLength

public void SetArrayLength(int plength)

setLength wrapper

This is analagous to UF's native setLength() function for dynamic arrays.

Overrides:

SetArrayLength in class Array

Parameters:

plength - new length of the array

Copy

public void Copy(ColorArray dest)

Copy (must be implemented in each type)

Parameters:

dest - ColorArray object to copy all values into; previous contents of dest will be discarded.