Marquee.Marquee Class Reference
Detailed Description
To use the Marquee class: 1) Set the draw root using setDrawRoot() 2) Call start() with the starting pixel co-ordinates 3) Call update() with the ending pixel co-ordinates 4) Call stop() to end the drawing This default behavior is to start the marquee at the co-ordinates given to start(), and to stop the marquee at the co-ordinates given to update().
The draw() method can be overridden should the marquee need to be drawn differently.
The drawn marquee consists of a line-stippled rectangle. More elements (such as a crosshair for example) can be added by overriding addDecorations().
#include <class_marquee_1_1_marquee.h>
Public Member Functions |
|
| __init__ () | |
| __del__ () | |
| getMarqueeGeometry () | |
| isActive () | |
| setDrawRoot () | |
| applyMarqueeStyle () | |
| Creates and assigns the material/style for
the marquee box. |
|
| addDecorations () | |
| Adds any extra marquee elements such as
crosshairs. |
|
| start () | |
| Starts the drawing of the marquee. |
|
| update () | |
| Updates the marquee. |
|
| draw () | |
| This implementation starts the marquee at
the co-ordinates given specified by start, and ends the marquee at
the co-ordinates specified by end. |
|
| stop () | |
| Stops the drawing of the marquee. |
|
| getStart () | |
| getEnd () | |
Member Function Documentation
| Marquee.Marquee.__init__ | ( | ) |
Reimplemented in Marquee.BoxDollyMarquee.
| Marquee.Marquee.__del__ | ( | ) |
| Marquee.Marquee.getMarqueeGeometry | ( | ) |
| Marquee.Marquee.isActive | ( | ) |
| Marquee.Marquee.setDrawRoot | ( | ) |
| Marquee.Marquee.applyMarqueeStyle | ( | ) |
Creates and assigns the material/style for the marquee box.
By default this will be line stipple. Override if a different style is desired.
Reimplemented in Marquee.BoxDollyMarquee.
| Marquee.Marquee.addDecorations | ( | ) |
Adds any extra marquee elements such as crosshairs.
This implementation does nothing. Override this method when more marquee elements need to be drawn. Attach the new elements to the root given.
Reimplemented in Marquee.BoxDollyMarquee.
| Marquee.Marquee.start | ( | ) |
Starts the drawing of the marquee.
The co-ordinates given should be the start (cursor) co-ordinates in pixels.
Reimplemented in Marquee.BoxDollyMarquee.
| Marquee.Marquee.update | ( | ) |
Updates the marquee.
The co-ordinates given should be the end (cursor) co-ordinates in pixels.
| Marquee.Marquee.draw | ( | ) |
This implementation starts the marquee at the co-ordinates given specified by start, and ends the marquee at the co-ordinates specified by end.
Override this method to draw the marquee at different start and end points, and to update the draw of any decorations.
Reimplemented in Marquee.BoxDollyMarquee.
| Marquee.Marquee.stop | ( | ) |
Stops the drawing of the marquee.
| Marquee.Marquee.getStart | ( | ) |
| Marquee.Marquee.getEnd | ( | ) |
