|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is a general interface for a progress meter. The engine needs an implementation of this to be able to report progress on calculating lighting and other stuff.
Method Summary | |
void |
abort()
Abort the meter. |
void |
Finalize()
Finalize the meter (i.e. we completed the task sooner than expected);. |
int |
getCurrent()
Get the current value of the meter ( <= total);. |
int |
getGranularity()
Get the refresh granularity. |
int |
getTotal()
Get the total element count represented by the meter. |
void |
reset()
Reset the meter to 0%. |
void |
restart()
Reset the meter and print the initial tick mark ("0%");. |
void |
setGranularity(int i)
Set the refresh granularity. |
void |
setProgressDescription(java.lang.String id,
java.lang.String description)
Set the id and description of what we are currently monitoring. |
void |
setTotal(int n)
Set the total element count represented by the meter and perform a reset. |
void |
step()
Increment the meter by one unit. |
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 |
public void abort()
public void Finalize()
public int getCurrent()
public int getGranularity()
public int getTotal()
public void reset()
public void restart()
public void setGranularity(int i)
i
- public void setProgressDescription(java.lang.String id, java.lang.String description)
id
- description
- public void setTotal(int n)
n
- public void step()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |