iptPointerManager

Create pointer manager in figure

Syntax

iptPointerManager(hFigure)

iptPointerManager(hFigure,'disable')

iptPointerManager(hFigure,'enable')

Description

iptPointerManager(hFigure) creates a pointer manager in the specified figure, hFigure. If the figure contains a pointer behavior structure, then the pointer manager controls the pointer behavior for graphics objects in the figure.

Use iptSetPointerBehavior to associate a pointer behavior structure with a particular object and to define specific actions that occur when the mouse pointer moves over and then leaves the object.

iptPointerManager(hFigure,'disable') disables the figure's pointer manager.

iptPointerManager(hFigure,'enable') enables and updates the figure's pointer manager.

Examples

Create Pointer Manager in Figure with Line Object

Plot a line. Create a pointer manager in the figure. Then, associate a pointer behavior structure with the line object in the figure that changes the mouse pointer into a fleur whenever the pointer is over it.

 h = plot(1:10);
 iptPointerManager(gcf);
 enterFcn = @(hFigure,currentPoint)set(hFigure,'Pointer','fleur');
 iptSetPointerBehavior(h,enterFcn);

Input Arguments

hFigure — Figure

figure

Figure, specified as a figure object.

More About

Pointer Behavior Structure

A pointer behavior structure has three fields that specify the behavior of the pointer when the mouse moves over and then exits an object in the figure.

To define the specific actions of the pointer, set the value of these fields to function handles. If you set a field to [], then no action is taken. When the pointer manager calls the function handles, it passes two arguments: the figure object and the current position of the pointer.

Field	When Called
enterFcn	Called when the mouse pointer moves over the object.
traverseFcn	Called once when the mouse pointer moves over the object, and called again each time the mouse moves within the object.
exitFcn	Called when the mouse pointer leaves the object.

Tips

• If a figure already contains a pointer manager, then iptPointerManager(hFigure) does not create a new pointer manager. The syntax has the same behavior as iptPointerManager(hFigure,'enable').

• iptPointerManager considers not just the object the pointer is over, but all objects in the figure. iptPointerManager searches the graphics objects hierarchy to find the first object that contains a pointer behavior structure. The iptPointerManager then executes that object's pointer behavior function. For more information, see Graphics Object Hierarchy.

  For example, you could set the pointer to be a fleur and associate that pointer with the axes. Then, when you slide the pointer into the figure window, it will initially be the default pointer, then change to a fleur when you cross into the axes, and remain a fleur when you slide over the objects parented to the axes.

• If you specify a pointer behavior using iptSetPointerBehavior and then change the figure pointer without using iptSetPointerBehavior, then the iptPointerManager may not update to reflect the new behavior. Some ways to change the figure pointer without using iptSetPointerBehavior include using ROI objects such as Polygon, another graphics object, another custom UI, or code that modifies the pointer from within a callback.

Version History

Introduced in R2006a