rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvMoveInteractor Class Reference

Manager interactor class. More...

#include <ilviews/graphics/inter.h>

Inheritance diagram for IlvMoveInteractor:
IlvInteractor

List of all members.

Public Member Functions

virtual void doIt (IlvGraphic *object, const IlvPoint &deltaMove, const IlvTransformer *t=0)
 Finalizes the interaction by moving the object.
virtual void drawGhost (IlvView *view, IlvGraphic *ghost, const IlvPoint &deltaMove, const IlvTransformer *t)
 Visual feedback during the interaction.
virtual void endOperation ()
 Performs the actions needed when the interaction ends.
virtual IlBoolean handleEvent (IlvGraphic *obj, IlvEvent &event, const IlvTransformer *t)
 Handles events received by the interactor.
virtual void validate (IlvGraphic *object, IlvPoint &p, const IlvTransformer *t=0)
 Lets you modify intermediate positions during the interaction.

Detailed Description

Manager interactor class.

Library: views

The IlvMoveInteractor class lets the user move an object by dragging it.

The registered name of this interactor is "Move".

See also:
IlvReshapeInteractor, IlvMoveReshapeInteractor.

Member Function Documentation

virtual void IlvMoveInteractor::doIt ( IlvGraphic object,
const IlvPoint deltaMove,
const IlvTransformer t = 0 
) [virtual]

Finalizes the interaction by moving the object.

Called to move the object to a new position. After moving the object, this method calls the object's callback corresponding to the Move symbol.

Parameters:
object The graphic object.
deltaMove The difference between the new and the initial location of the object in the object coordinate system.
t The transformer applied to the view.
See also:
IlvGraphic::setCallback
virtual void IlvMoveInteractor::drawGhost ( IlvView view,
IlvGraphic ghost,
const IlvPoint deltaMove,
const IlvTransformer t 
) [virtual]

Visual feedback during the interaction.

Called to draw a preview image of the resulting user action. It is generally invoked by handleEvent as a response to user events.

Parameters:
view The view where the object is displayed.
ghost The graphic object used as ghost image.
deltaMove The difference between the current and the initial location of the object in view coordinates.
t The transformer applied to the view.
virtual void IlvMoveInteractor::endOperation (  )  [virtual]

Performs the actions needed when the interaction ends.

The default implementation resets the interactor flags and remove it from its parent, if it exists.

See also:
IlvStackInteractorInterface::removeFromParent

Reimplemented from IlvInteractor.

virtual IlBoolean IlvMoveInteractor::handleEvent ( IlvGraphic g,
IlvEvent event,
const IlvTransformer t 
) [virtual]

Handles events received by the interactor.

This method is the entry point of all events dispatched to this interactor.

Parameters:
g The graphic object that receives the event.
event The received event.
t The transformer applied to the view in which the event occurred.
Returns:
IlTrue if the event was successfully handled and IlFalse otherwise.

Implements IlvInteractor.

virtual void IlvMoveInteractor::validate ( IlvGraphic object,
IlvPoint p,
const IlvTransformer t = 0 
) [virtual]

Lets you modify intermediate positions during the interaction.

Called for each mouse movement so that the user can modify the object position. When the mouse button is released, doIt is called.

Parameters:
object The considered graphic object.
p The current position, in the object coordinate system.
t The transformer applied to the view.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.