DigitalSpaces::DICEGUIProgressBar Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>


Public Member Functions
float	getProgress ()
	return the current progress value
float	getStep ()
	return the current step size
void	setProgress (float progress)
	set the current progress.
void	setStepSize (float step_val)
	set the size of the 'step' in percentage points (default is 0.01f or 1%).
void	step ()
	cause the progress to step
void	adjustProgress (float delta)
	Modify the progress level by a specified delta.

Member Function Documentation

float DigitalSpaces::DICEGUIProgressBar::getProgress ( )

return the current progress value

float DigitalSpaces::DICEGUIProgressBar::getStep ( )

return the current step size

void DigitalSpaces::DICEGUIProgressBar::setProgress ( float progress )

set the current progress.

Parameters:

progress

The level of progress to set. If this value is >1.0f (100%) progress will be limited to 1.0f.

void DigitalSpaces::DICEGUIProgressBar::setStepSize ( float step_val )

set the size of the 'step' in percentage points (default is 0.01f or 1%).

Parameters:

step

Amount to increase the progress by each time the step method is called.

void DigitalSpaces::DICEGUIProgressBar::step ( )

cause the progress to step

The amount the progress bar will step can be changed by calling the setStepSize method. The default step size is 0.01f which is equal to 1%.

void DigitalSpaces::DICEGUIProgressBar::adjustProgress ( float delta )

Modify the progress level by a specified delta.

Parameters:

delta

amount to adjust the progress by. Whatever this value is, the progress of the bar will be kept within the range: 0.0f <= progress <= 1.0f.

The documentation for this struct was generated from the following file: