crystalspace.jbind.impl.csgfx.shadervar
Class csShaderVariableProxyList

java.lang.Object
  extended bycrystalspace.jbind.impl.csNativeObject
      extended bycrystalspace.jbind.impl.csgfx.shadervar.csShaderVariableProxyList
All Implemented Interfaces:
iPointer

public class csShaderVariableProxyList
extends csNativeObject

Sorted list of shadervariables

Author:
Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/pubapi/classcsShaderVariableProxyList.php

Field Summary
 
Fields inherited from class crystalspace.jbind.impl.csNativeObject
ImplFactory, nPointer
 
Constructor Summary
csShaderVariableProxyList()
          Initialize object to have initial capacity of 'icapacity' elements, and to increase storage by 'ithreshold' each time the upper bound is exceeded.
csShaderVariableProxyList(csShaderVariableProxyList copy)
          Copy constructor.
csShaderVariableProxyList(int icapacity)
          Initialize object to have initial capacity of 'icapacity' elements, and to increase storage by 'ithreshold' each time the upper bound is exceeded.
csShaderVariableProxyList(int icapacity, int ithreshold)
          Initialize object to have initial capacity of 'icapacity' elements, and to increase storage by 'ithreshold' each time the upper bound is exceeded.
csShaderVariableProxyList(iPointer nPointer)
           
 
Method Summary
 int capacity()
          Query vector capacity.
 boolean delete(csShaderVariableProxy item)
          Delete the given element from vector.
 void deleteAll()
          Clear entire vector.
 boolean deleteIndex(int n)
          Delete element number 'n' from vector.
 void deleteRange(int start, int end)
          Delete a given range (inclusive).
 void empty()
          Remove all elements.
 int find(csShaderVariableProxy which)
          Find a element in array and return its index (or -1 if not found).
 int findKey(iPointer key)
          Find an element based on some key.
 int findSortedKey(iPointer key)
          Find an element based on some key, using a csShaderVariableProxyListCompareKeyFunction.
 int findSortedKey(iPointer key, int candidate)
          Find an element based on some key, using a csShaderVariableProxyListCompareKeyFunction.
 csShaderVariableProxy get(int n)
          Get an element.
 csShaderVariableProxy getExtend(int n)
          Get an item from the array.
 boolean insert(int n, csShaderVariableProxy item)
          Insert element 'item' before element 'n'.
 int insertSorted(csShaderVariableProxy item)
          Insert an element at a sorted position, using a csShaderVariableProxyListCompareFunction.
 int insertSorted(csShaderVariableProxy item, int equal_index)
          Insert an element at a sorted position, using a csShaderVariableProxyListCompareFunction.
protected  boolean isNativePointerValidSafe(long pointer)
           
 csShaderVariableProxy item(int n)
          Get an element.
 int length()
          Return the number of elements in the Array.
protected  void nDelete(long pointer)
           
 csShaderVariableProxy pop()
          Pop an element from tail end of array.
 void prepareFill()
          prepareFill
 int push(csShaderVariableProxy what)
          Push an element onto the tail end of the array.
 void put(int n, csShaderVariableProxy what)
          Put an element at some position.
 csShaderVariableProxyList section(int low, int high)
          Get the portion of the array between low and high inclusive.
 csShaderVariableProxyList set(csShaderVariableProxyList other)
          Assignment operator.
 void setCapacity(int n)
          Set vector capacity to approximately 'n' elements.
 void setLength(int n)
          Set vector length to n.
 void setLength(int n, csShaderVariableProxy what)
          Set the actual number of items in this array.
 void shrinkBestFit()
          Make the array just as big as it needs to be.
 void sort()
          Sort array.
 csShaderVariableProxy top()
          Return the top element but do not remove it.
 void transferTo(csShaderVariableProxyList destination)
          Transfer the entire contents of one array to the other.
 void truncate(int n)
          Truncate array to specified number of elements.
 
Methods inherited from class crystalspace.jbind.impl.csNativeObject
changePointer, equals, finalize, getPointer, getPointer, getPointerArray, hashCode, isMemoryOwner, isNativePointerValid, newNativeObject, setMemoryOwner, toString
 
Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

csShaderVariableProxyList

public csShaderVariableProxyList(iPointer nPointer)
Parameters:
nPointer -

csShaderVariableProxyList

public csShaderVariableProxyList()
Initialize object to have initial capacity of 'icapacity' elements, and to increase storage by 'ithreshold' each time the upper bound is exceeded.


csShaderVariableProxyList

public csShaderVariableProxyList(int icapacity)
Initialize object to have initial capacity of 'icapacity' elements, and to increase storage by 'ithreshold' each time the upper bound is exceeded.

Parameters:
icapacity -

csShaderVariableProxyList

public csShaderVariableProxyList(int icapacity,
                                 int ithreshold)
Initialize object to have initial capacity of 'icapacity' elements, and to increase storage by 'ithreshold' each time the upper bound is exceeded.

Parameters:
icapacity -
ithreshold -

csShaderVariableProxyList

public csShaderVariableProxyList(csShaderVariableProxyList copy)
Copy constructor.

Method Detail

nDelete

protected void nDelete(long pointer)
Specified by:
nDelete in class csNativeObject
See Also:
csNativeObject.nDelete(long)

isNativePointerValidSafe

protected boolean isNativePointerValidSafe(long pointer)
Specified by:
isNativePointerValidSafe in class csNativeObject
See Also:
csNativeObject.isNativePointerValidSafe(long)

set

public csShaderVariableProxyList set(csShaderVariableProxyList other)
Assignment operator.

Parameters:
other -
Returns:

length

public int length()
Return the number of elements in the Array.

Returns:

capacity

public int capacity()
Query vector capacity. Note that you should rarely need to do this.

Returns:

transferTo

public void transferTo(csShaderVariableProxyList destination)
Transfer the entire contents of one array to the other.

Parameters:
destination -

setLength

public void setLength(int n,
                      csShaderVariableProxy what)
Set the actual number of items in this array.

Parameters:
n -
what -

setLength

public void setLength(int n)
Set vector length to n.

Parameters:
n -

get

public csShaderVariableProxy get(int n)
Get an element.

Parameters:
n -
Returns:

getExtend

public csShaderVariableProxy getExtend(int n)
Get an item from the array.

Parameters:
n -
Returns:

item

public csShaderVariableProxy item(int n)
Get an element.

Parameters:
n -
Returns:

put

public void put(int n,
                csShaderVariableProxy what)
Put an element at some position.

Parameters:
n -
what -

findKey

public int findKey(iPointer key)
Find an element based on some key.

Parameters:
key -
Returns:

push

public int push(csShaderVariableProxy what)
Push an element onto the tail end of the array. Returns index of element.

Parameters:
what -
Returns:

pop

public csShaderVariableProxy pop()
Pop an element from tail end of array.

Returns:

top

public csShaderVariableProxy top()
Return the top element but do not remove it.

Returns:

insert

public boolean insert(int n,
                      csShaderVariableProxy item)
Insert element 'item' before element 'n'.

Parameters:
n -
item -
Returns:

section

public csShaderVariableProxyList section(int low,
                                         int high)
Get the portion of the array between low and high inclusive.

Parameters:
low -
high -
Returns:

findSortedKey

public int findSortedKey(iPointer key)
Find an element based on some key, using a csShaderVariableProxyListCompareKeyFunction.

Parameters:
key -
Returns:

findSortedKey

public int findSortedKey(iPointer key,
                         int candidate)
Find an element based on some key, using a csShaderVariableProxyListCompareKeyFunction.

Parameters:
key -
candidate -
Returns:

insertSorted

public int insertSorted(csShaderVariableProxy item)
Insert an element at a sorted position, using a csShaderVariableProxyListCompareFunction.

Parameters:
item -
Returns:

insertSorted

public int insertSorted(csShaderVariableProxy item,
                        int equal_index)
Insert an element at a sorted position, using a csShaderVariableProxyListCompareFunction.

Parameters:
item -
equal_index -
Returns:

find

public int find(csShaderVariableProxy which)
Find a element in array and return its index (or -1 if not found).

Parameters:
which -
Returns:

sort

public void sort()
Sort array.


deleteAll

public void deleteAll()
Clear entire vector.


truncate

public void truncate(int n)
Truncate array to specified number of elements.

Parameters:
n -

empty

public void empty()
Remove all elements.


setCapacity

public void setCapacity(int n)
Set vector capacity to approximately 'n' elements.

Parameters:
n -

shrinkBestFit

public void shrinkBestFit()
Make the array just as big as it needs to be.


deleteIndex

public boolean deleteIndex(int n)
Delete element number 'n' from vector.

Parameters:
n -
Returns:

deleteRange

public void deleteRange(int start,
                        int end)
Delete a given range (inclusive).

Parameters:
start -
end -

delete

public boolean delete(csShaderVariableProxy item)
Delete the given element from vector.

Parameters:
item -
Returns:

prepareFill

public void prepareFill()
prepareFill