FBProgress Class Reference

FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress FBProgress
Inheritance diagram for FBProgress:
Inheritance graph
[legend]

List of all members.


Detailed Description

Progress bar.

See samples: 3ds Max Biped Template.py, MirrorPoseOverTime.py, FBProgress.py.


Public Member Functions

  FBProgress ()
  Constructor.
  ProgressBegin ()
  Start progress, must be called before set Text & Percent property.
  ProgressDone ()
  End progress, must be called to reset progress bar UI to normal status after finishing the task.
bool  UserRequestCancell ()
  Return true if User is pressing and holding "ESC" key to request the cancellation.

Public Attributes

str  Caption
  Read Write Property: Caption to be displayed for progress bar.
int  Percent
  Read Write Property: Percent completed for the operation. Must be used called in between ProgressBegin()/ProgressDone()
str  Text
  Read Write Property: Text to display on progress bar. Must be used in between ProgressBegin()/ProgressDone()

Constructor & Destructor Documentation

FBProgress (  ) 

Constructor.


Member Function Documentation

ProgressBegin (  ) 

Start progress, must be called before set Text & Percent property.

ProgressDone (  ) 

End progress, must be called to reset progress bar UI to normal status after finishing the task.

bool UserRequestCancell (  ) 

Return true if User is pressing and holding "ESC" key to request the cancellation.

Must be called in between ProgressBegin()/ProgressDone().


Member Data Documentation

str Caption

Read Write Property: Caption to be displayed for progress bar.

Reimplemented from FBVisualComponent.

int Percent

Read Write Property: Percent completed for the operation. Must be used called in between ProgressBegin()/ProgressDone()

str Text

Read Write Property: Text to display on progress bar. Must be used in between ProgressBegin()/ProgressDone()


Generated on Tue Feb 9 19:34:32 2010 for Python Reference Guide by  doxygen 1.5.3