Rogue Wave Views
Manager Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvMakeArcInteractor Class Reference

Manager interactor class. More...

#include <ilviews/manager/mkarcin.h>

Inheritance diagram for IlvMakeArcInteractor:
IlvManagerViewInteractor IlvValueInterface IlvMakeFilledArcInteractor

Public Member Functions

 IlvMakeArcInteractor (IlvManager *manager, IlvView *view)
 Constructor. More...
 
void abort ()
 Aborts the interaction. More...
 
virtual void doIt (IlvRect &rect, IlFloat start, IlFloat range)
 Finalizes the interaction by creating an IlvArc object. More...
 
void drawGhost ()
 Visual feedback during the interaction. More...
 
IlFloat firstAngle ()
 Returns the arc start angle. More...
 
void getRectangle (IlvRect &rect)
 Get the rectangle defining the full ellipse. More...
 
virtual IlBoolean handleEvent (IlvEvent &event)
 Handles events for the manager view. More...
 
IlFloat secondAngle ()
 Returns the arc range. More...
 
- Public Member Functions inherited from IlvManagerViewInteractor
 IlvManagerViewInteractor (IlvManager *manager, IlvView *view)
 Initializes a new IlvManagerViewInteractor. More...
 
virtual void ensureVisible (const IlvPoint &point)
 Ensures the visibility of a given location. More...
 
IlvDisplaygetDisplay () const
 Returns the display of the manager view. More...
 
IlvManagergetManager () const
 Returns the manager. More...
 
IlvTransformergetTransformer () const
 Returns the transformer used with the manager view. More...
 
IlvViewgetView () const
 Returns the manager view. More...
 
virtual void handleExpose (IlvRegion *clip=0)
 Called when the manager view receives an expose event. More...
 
virtual void init ()
 Initialization, when the interactor is attached to a view. More...
 

Detailed Description

Manager interactor class.

Library: ilvmgr

Use this class to create arc objects in a view controlled by a manager. To create an arc, the user:

  1. Creates a rectangular area bounding the entire arc to be created.

  2. Specifies the starting and ending angle of the arc by manipulating two square handles.

To create IlvFilledArc objects, use the IlvMakeFilledArcInteractor interactor.

See also
IlvArc, IlvFilledArc, IlvMakeFilledArcInteractor.

Constructor & Destructor Documentation

IlvMakeArcInteractor::IlvMakeArcInteractor ( IlvManager manager,
IlvView view 
)

Constructor.

Initializes a new instance of the IlvMakeArcInteractor class.

Parameters
managerThe manager.
viewThe manager view.

Member Function Documentation

void IlvMakeArcInteractor::abort ( )
virtual

Aborts the interaction.

Called by the manager when the user changes the current interactor. It resets the interactor to a state in which it appears to have never been launched. A common implementation is to erase the ghost image. Call this member function to inhibit the interactor action in particular circumstances.

Reimplemented from IlvManagerViewInteractor.

virtual void IlvMakeArcInteractor::doIt ( IlvRect rect,
IlFloat  start,
IlFloat  range 
)
virtual

Finalizes the interaction by creating an IlvArc object.

Creates a new IlvArc object in the manager from the parameters provided during the interaction.

Parameters
rectThe rectangle containing the full ellipse.
startThe arc start angle in degrees.
rangeThe arc range in degrees.

Reimplemented in IlvMakeFilledArcInteractor.

void IlvMakeArcInteractor::drawGhost ( )
virtual

Visual feedback during the interaction.

Called to draw a preview image of the resulting user action (the ghost image of the interactor). This function is generally invoked by IlvManagerViewInteractor::handleEvent() as a response to user events.

Reimplemented from IlvManagerViewInteractor.

IlFloat IlvMakeArcInteractor::firstAngle ( )

Returns the arc start angle.

Returns
The value of the start angle.
void IlvMakeArcInteractor::getRectangle ( IlvRect rect)

Get the rectangle defining the full ellipse.

Parameters
rectUsed to return the rectangle specifying the arc.
virtual IlBoolean IlvMakeArcInteractor::handleEvent ( IlvEvent event)
virtual

Handles events for the manager view.

Called by the manager for which the interactor was created with every event it receives in the interactor view.

Returns
IlTrue if the event is consumed, IlFalse otherwise.

Implements IlvManagerViewInteractor.

IlFloat IlvMakeArcInteractor::secondAngle ( )

Returns the arc range.

Returns
The value of the angle that defines the arc range. It is the difference in degrees between the value returned by firstAngle, and the second selected angle.

© Copyright 2016, 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.