Rogue Wave Views
Manager Package API Reference Guide
Product Documentation:

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

Manager interactor class. More...

#include <ilviews/manager/mkpolyin.h>

Inheritance diagram for IlvMakePolylineInteractor:
IlvMakePolyPointsInteractor IlvManagerViewInteractor IlvValueInterface IlvMakeArrowPolylineInteractor IlvMakePolygonInteractor IlvMakeOutlinePolygonInteractor

Public Member Functions

 IlvMakePolylineInteractor (IlvManager *manager, IlvView *view)
 Initializes a new instance of the IlvMakePolylineInteractor class. More...
 
virtual void doIt (IlUInt count, IlvPoint *points)
 Finalizes the interaction by creating an IlvPolyline object. More...
 
virtual void drawGhost ()
 Provides the visual feedback during interaction. More...
 
- Public Member Functions inherited from IlvMakePolyPointsInteractor
 IlvMakePolyPointsInteractor (IlvManager *manager, IlvView *view)
 Initializes a new IlvMakePolyPointsInteractor instance. More...
 
void abort ()
 Aborts the interaction. More...
 
virtual IlBoolean accept (IlvPoint &p)
 Lets the interactor accept or refuse a new point location. More...
 
IlUInt count ()
 Returns the number of elements in the current array of points. More...
 
virtual void drawHull ()
 Draws markers on each of the points that constitute this polygon. More...
 
IlUShort getThreshold () const
 Returns the threshold. More...
 
virtual IlBoolean handleEvent (IlvEvent &event)
 Handles events for the manager view. More...
 
void init ()
 Initialization, when the interactor is attached to a view. More...
 
IlvPointpoints ()
 Returns the current array of points. More...
 
virtual void react (IlvPoint &p, IlUShort modifiers=0)
 Called after a new point has been added to the array of points. More...
 
void setThreshold (IlUShort val)
 Sets the threshold. 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...
 

Additional Inherited Members

- Protected Member Functions inherited from IlvMakePolyPointsInteractor
virtual void commit (IlBoolean removeExtraPoints)
 Called by handleEvent when the polypoint is terminated. More...
 
IlvPointtransformPoints () const
 Returns the array of points in the coordinate system of the view. More...
 

Detailed Description

Manager interactor class.

Library: ilvmgr
Use this class to create an IlvPolyline object in a view controlled by a manager. The virtual member function handleEvent() monitors mouse events. To draw a polyline, the user:

  1. Clicks the left mouse button to set the point.
  2. Presses the space bar, the enter key or double-clicks to finish.
See also
IlvPolyline, IlvPolySelectInteractor, IlvMakeArrowPolylineInteractor, IlvMakePolygonInteractor, IlvMakeOutlinePolylineInteractor, IlvMakeSplineInteractor.

Constructor & Destructor Documentation

§ IlvMakePolylineInteractor()

IlvMakePolylineInteractor::IlvMakePolylineInteractor ( IlvManager manager,
IlvView view 
)

Initializes a new instance of the IlvMakePolylineInteractor class.

Parameters
managerThe manager.
viewThe manager view.

Member Function Documentation

§ doIt()

virtual void IlvMakePolylineInteractor::doIt ( IlUInt  count,
IlvPoint points 
)
virtual

Finalizes the interaction by creating an IlvPolyline object.

Creates an IlvPolyline in the manager from the array of points provided during the interaction.

Parameters
countThe number of points in the array.
pointsThe array of points, in the object coordinate system.

Implements IlvMakePolyPointsInteractor.

Reimplemented in IlvMakeOutlinePolygonInteractor, IlvMakePolygonInteractor, and IlvMakeArrowPolylineInteractor.

§ drawGhost()

virtual void IlvMakePolylineInteractor::drawGhost ( )
virtual

Provides the visual feedback during interaction.

Draws a polyline in XOR mode.

Implements IlvMakePolyPointsInteractor.

Reimplemented in IlvMakePolygonInteractor, and IlvMakeArrowPolylineInteractor.


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