crystalspace.jbind.interfaces.iengine.region
Interface iRegionList

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csRegionList

public interface iRegionList

extends iBase

A list of region objects.

Author:

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

Method Summary

int	add(iRegion obj) Add a region.
int	find(iRegion obj) Find a region and return its index.
iRegion	findByName(java.lang.String Name) Find a region by name.
iRegion	get(int n) Return a region by index.
int	getCount() Return the number of regions in this list.
boolean	remove(int n) Remove the nth region.
boolean	remove(iRegion obj) Remove a region.
void	removeAll() Remove all regions.

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getName, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Method Detail

add

public int add(iRegion obj)

Add a region.

Parameters:

obj -

Returns:

find

public int find(iRegion obj)

Find a region and return its index.

Parameters:

obj -

Returns:

findByName

public iRegion findByName(java.lang.String Name)

Find a region by name.

Parameters:

Name -

Returns:

get

public iRegion get(int n)

Return a region by index.

Parameters:

n -

Returns:

getCount

public int getCount()

Return the number of regions in this list.

Returns:

remove

public boolean remove(int n)

Remove the nth region.

Parameters:

n -

Returns:

remove

public boolean remove(iRegion obj)

Remove a region.

Parameters:

obj -

Returns:

removeAll

public void removeAll()

Remove all regions.