Drag[en]gine Script Module DragonScript Script API  1.0
InfoMousePointer Class Reference
Inheritance diagram for InfoMousePointer:
DefaultMousePointer MousePointer

Public Member Functions

InfoMousePointer destructor ()
 
Point getAlignedWidgetPosition ()
 
Image getImage ()
 
Point getOffsetImage ()
 
Widget getWidget ()
 
int getWidgetAlignment ()
 
bool getWidgetOverPointer ()
 
int getWidgetPadding ()
 
InfoMousePointer new ()
 
InfoMousePointer new (Image image)
 
InfoMousePointer new (Image image, Point offset)
 
InfoMousePointer new (Image image, Point offset, float transparency)
 
void setImage (Image image)
 
void setOffsetImage (Point offset)
 
void setWidget (Widget widget)
 
void setWidgetAlignment (int alignment)
 
void setWidgetOverPointer (bool widgetOverPointer)
 
void setWidgetPadding (int padding)
 
void updateGeometry ()
 
void updateOrder ()
 
- Public Member Functions inherited from DefaultMousePointer
Canvas getCanvas ()
 
CanvasView getCanvasView ()
 
Point getOffset ()
 
Point getPosition ()
 
Point getSize ()
 
float getTransparency ()
 
DefaultMousePointer new (Point size)
 
DefaultMousePointer new (Point size, Point offset)
 
DefaultMousePointer new (Point size, Point offset, float transparency)
 
void setOffset (Point offset)
 
void setPosition (Point position)
 
void setSize (Point size)
 
void setTransparency (float transparency)
 

Public Attributes

final int BOTTOM_INSIDE = 0h100
 
final int BOTTOM_OUTSIDE = 0h200
 
final int CENTER = 0h4
 
final int LEFT_INSIDE = 0h2
 
final int LEFT_OUTSIDE = 0h1
 
final int MIDDLE = 0h80
 
final int RIGHT_INSIDE = 0h8
 
final int RIGHT_OUTSIDE = 0h10
 
final int TOP_INSIDE = 0h40
 
final int TOP_OUTSIDE = 0h20
 

Detailed Description

Mouse pointer with support to display additional information. The information is provided by rendering a widget at a user defined position relative to the mouse pointer. The position of the widget is applied considered relative to the mouse pointer. The user is responsible to set the appropriate position and size of the widget. WIth a null widget the InfoMousePointer behaves like a SimpleMousePointer.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ destructor()

InfoMousePointer destructor ( )

Clean up mouse pointer. Calls dispose on the widget if not null.

§ getAlignedWidgetPosition()

Point getAlignedWidgetPosition ( )

Get aligned widget position using the set alignment.

§ getImage()

Image getImage ( )

Retrieves the image.

§ getOffsetImage()

Point getOffsetImage ( )

Offset image.

§ getWidget()

Widget getWidget ( )

Retrieves the widget or null if not used.

§ getWidgetAlignment()

int getWidgetAlignment ( )

Retrieves the alignment of the widget.

§ getWidgetOverPointer()

bool getWidgetOverPointer ( )

Determines if the widget is drawn over the mouse pointer if overlapping.

§ getWidgetPadding()

int getWidgetPadding ( )

Retrieves the padding between the widget and the mouse pointer in pixels.

§ new() [1/4]

Creates a new mouse pointer.

§ new() [2/4]

InfoMousePointer new ( Image  image)

Creates a new mouse pointer.

§ new() [3/4]

InfoMousePointer new ( Image  image,
Point  offset 
)

Creates a new mouse pointer.

§ new() [4/4]

InfoMousePointer new ( Image  image,
Point  offset,
float  transparency 
)

Creates a new mouse pointer.

§ setImage()

void setImage ( Image  image)

Sets the image.

§ setOffsetImage()

void setOffsetImage ( Point  offset)

Set offset image.

§ setWidget()

void setWidget ( Widget  widget)

Sets the widget or null if not used. If a previous widget is set dispose is called on it. The new widget is set visible if not already.

§ setWidgetAlignment()

void setWidgetAlignment ( int  alignment)

Sets the alignment of the widget. Use a combination of of LEFT_OUTSIDE, LEFT_INSIDE, CENTER, RIGHT_INSIDE or RIGHT_OUTSIDE with TOP_OUTSIDE, TOP_INSIDE, MIDDLE, BOTTOM_INSIDE or BOTTOM_OUTSIDE. Not using an alignment of the respective group keeps the widget in this axis at the user defined position.

§ setWidgetOverPointer()

void setWidgetOverPointer ( bool  widgetOverPointer)

Sets if the widget is drawn over the mouse pointer if overlapping.

§ setWidgetPadding()

void setWidgetPadding ( int  padding)

Sets the padding between the widget and the mouse pointer in pixels.

§ updateGeometry()

void updateGeometry ( )

Update canvas positon and size.

§ updateOrder()

void updateOrder ( )

Update order of canvas.

Member Data Documentation

§ BOTTOM_INSIDE

final int BOTTOM_INSIDE = 0h100

Align widget at the bottom inside of the mouse pointer image.

§ BOTTOM_OUTSIDE

final int BOTTOM_OUTSIDE = 0h200

Align widget at the bottom outside of the mouse pointer image.

§ CENTER

final int CENTER = 0h4

Align widget at the center of the mouse pointer image.

§ LEFT_INSIDE

final int LEFT_INSIDE = 0h2

Align widget at the left inside of the mouse pointer image.

§ LEFT_OUTSIDE

final int LEFT_OUTSIDE = 0h1

Align widget at the left outside of the mouse pointer image.

§ MIDDLE

final int MIDDLE = 0h80

Align widget at the middled of the mouse pointer image.

§ RIGHT_INSIDE

final int RIGHT_INSIDE = 0h8

Align widget at the right inside of the mouse pointer image.

§ RIGHT_OUTSIDE

final int RIGHT_OUTSIDE = 0h10

Align widget at the right outside of the mouse pointer image.

§ TOP_INSIDE

final int TOP_INSIDE = 0h40

Align widget at the top inside side of the mouse pointer image.

§ TOP_OUTSIDE

final int TOP_OUTSIDE = 0h20

Align widget at the top outside side of the mouse pointer image.


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