IlvChartInteractorManager Class Reference

Manager class for IlvChartInteractor instances. More...

#include <ilviews/charts/chartint.h>

Inheritance diagram for IlvChartInteractorManager:

List of all members.

Public Member Functions
	IlvChartInteractorManager ()
	Constructor.
virtual	~IlvChartInteractorManager ()
	Destructor.
void	addInteractor (const char *name, IlUInt position=IlvLastPositionIndex)
	Adds an interactor to this object.
void	addInteractor (IlvChartInteractor *interactor, IlUInt position=IlvLastPositionIndex)
	Adds an interactor to this object.
virtual IlvAbstractChartCursor *	getAbscissaCursor ()
	Returns the abscissa cursor.
IlUInt	getCardinal () const
	Returns the number of interactors managed by this object.
IlvChartInteractor *	getInteractor (IlUInt index) const
	Returns the interactor at the index index that is managed by this object.
IlUInt	getOrdinateAxisIndex () const
	Returns the index of the ordinate axis to which interactions apply.
virtual IlvAbstractChartCursor *	getOrdinateCursor ()
	Returns the ordinate cursor.
IlvCoordinateInfo *	getOrdinateInfo () const
	Returns the ordinate coordinate information to which interactions apply.
IlBoolean	isShowingAbscissaCursor () const
	Returns the show state of the abscissa cursor.
IlBoolean	isShowingOrdinateCursor () const
	Returns the show state of the ordinate cursor.
void	moveCursors (IlBoolean abscissa, IlBoolean ordinate, const IlvPoint &point, const IlvTransformer *t, IlBoolean reDraw=IlTrue)
	Moves the cursors to a given view position.
void	removeCursors ()
	Removes and deletes the abscissa and ordinate cursors.
IlBoolean	removeInteractor (const char *name)
	Removes an interactor from this object.
IlBoolean	removeInteractor (IlvChartInteractor *interactor)
	Removes an interactor from this object.
void	removeInteractors ()
	Removes and unlocks all managed interactors.
void	restoreCursorsVisibility (const IlvPoint &point, const IlvTransformer *t)
	Restores the visibility state of the cursors.
void	saveCursorsVisibility ()
	Stores the visibility state of the cursors.
void	setAbscissaCursorVisible (IlBoolean visible)
	Sets the visibility state of the abscissa cursor.
void	setCursorsVisible (IlBoolean abscissa, IlBoolean ordinate, IlBoolean visible)
	Sets the visibility state of the cursors.
void	setOrdinateAxisIndex (IlUInt index)
	Sets the index of the ordinate axis to which interactions apply.
void	setOrdinateCursorVisible (IlBoolean visible)
	Sets the visibility state of the ordinate cursor.
void	showAbscissaCursor (IlBoolean show)
	Sets the show state of the abscissa cursor.
void	showOrdinateCursor (IlBoolean show)
	Sets the show state of the ordinate cursor.
Static Public Member Functions
static IlvChartInteractorManager *	Get (const IlvChartGraphic *chart)
	Returns the interactor manager instance attached to a chart.
static IlvChartInteractorManager *	Remove (IlvChartGraphic *chart)
	Removes the IlvChartInteractorManager attached to a chart.
static IlvChartInteractorManager *	Set (IlvChartGraphic *chart, IlvChartInteractorManager *interMgr)
	Attaches an IlvChartInteractorManager instance to a chart.

---

Detailed Description

Manager class for IlvChartInteractor instances.

Library: ilvcharts

This class manages a set of IlvChartInteractor instances. A chart object can be attached to an instance of this class and can register interactors that will handle events.

---

Constructor & Destructor Documentation

IlvChartInteractorManager::IlvChartInteractorManager

(

)

Constructor.

Initializes a new IlvChartInteractorManager object.

virtual IlvChartInteractorManager::~IlvChartInteractorManager

(

)

[virtual]

Destructor.

The destructor removes all managed interactors and unlocks them. It also removes and deletes the cursors.

See also:

removeInteractors, removeCursors.

---

Member Function Documentation

void IlvChartInteractorManager::addInteractor	(	const char *	name,
		IlUInt	position = IlvLastPositionIndex
	)

Adds an interactor to this object.

Adds the shared interactor registered as name to this manager instance. The interactor is locked.

Parameters:

	name	The name of the interactor to add.
	position	The insertion rank. The rank in the manager is used to decide the priority in event dispatching.

See also:

IlvChartInteractorDispatcher.

void IlvChartInteractorManager::addInteractor	(	IlvChartInteractor *	interactor,
		IlUInt	position = IlvLastPositionIndex
	)

Adds an interactor to this object.

The interactor is locked.

Parameters:

	interactor	The interactor to add.
	position	The insertion rank. The rank in the manager serves as the priority order during the event dispatching.

See also:

IlvChartInteractorDispatcher.

static IlvChartInteractorManager* IlvChartInteractorManager::Get

(

const IlvChartGraphic *

chart

)

[static]

Returns the interactor manager instance attached to a chart.

Parameters:

chart

The chart object to which this interactor manager is attached.

Returns:

The interactor manager attached to chart.

virtual IlvAbstractChartCursor* IlvChartInteractorManager::getAbscissaCursor

(

)

[virtual]

Returns the abscissa cursor.

This method creates the cursor if it does not exist yet or if it has been deleted.

Returns:

The abscissa cursor.

IlUInt IlvChartInteractorManager::getCardinal

(

)

const

Returns the number of interactors managed by this object.

Returns:

The number of interactors managed by this object.

IlvChartInteractor* IlvChartInteractorManager::getInteractor

(

IlUInt

index

)

const

Returns the interactor at the index index that is managed by this object.

Parameters:

index

The index in the interactor manager.

Returns:

The corresponding interactor.

IlUInt IlvChartInteractorManager::getOrdinateAxisIndex

(

)

const

Returns the index of the ordinate axis to which interactions apply.

This method returns the index of the ordinate axis that must be considered by the managed interactors. The latter will use this information for such operations as projection, translation, zooming, and so on.

Returns:

The index of the handled ordinate axis.

virtual IlvAbstractChartCursor* IlvChartInteractorManager::getOrdinateCursor

(

)

[virtual]

Returns the ordinate cursor.

This method creates the cursor if it does not exist yet or if it has been deleted.

Returns:

The ordinate cursor.

IlvCoordinateInfo* IlvChartInteractorManager::getOrdinateInfo

(

)

const

Returns the ordinate coordinate information to which interactions apply.

This method returns the coordinate information of the ordinate axis defined by the IlvChartInteractorManager::setOrdinateAxisIndex method or 0 if the index is invalid.

Returns:

The corresponding coordinate information.

IlBoolean IlvChartInteractorManager::isShowingAbscissaCursor

(

)

const

Returns the show state of the abscissa cursor.

Returns:

IlTrue if the abscissa cursor is used and IlFalse otherwise.

IlBoolean IlvChartInteractorManager::isShowingOrdinateCursor

(

)

const

Returns the show state of the ordinate cursor.

Returns:

IlTrue if the ordinate cursor is used and IlFalse otherwise.

void IlvChartInteractorManager::moveCursors	(	IlBoolean	abscissa,
		IlBoolean	ordinate,
		const IlvPoint &	point,
		const IlvTransformer *	t,
		IlBoolean	reDraw = IlTrue
	)

Moves the cursors to a given view position.

Parameters:

	abscissa	A Boolean value indicating whether the abscissa cursor must be moved.
	ordinate	A Boolean value indicating whether the ordinate cursor must be moved.
	point	The new position of the cursors in view coordinates.
	t	The transformer applied to the current view.
	reDraw	A Boolean value indicating whether the cursors should be redrawn after the move operation.

static IlvChartInteractorManager* IlvChartInteractorManager::Remove

(

IlvChartGraphic *

chart

)

[static]

Removes the IlvChartInteractorManager attached to a chart.

If the chart is associated with an IlvChartInteractorDispatcher interactor, the latter is removed.

Parameters:

chart

The considered chart.

Returns:

The IlvChartInteractorManager instance removed from chart.

IlBoolean IlvChartInteractorManager::removeInteractor

(

const char *

name

)

Removes an interactor from this object.

Removes the shared interactor registered as name from this manager instance. The interactor is unlocked.

Parameters:

name

The name of the interactor to remove.

Returns:

A Boolean value indicating whether the interactor has been successfully removed.

See also:

IlvChartInteractor::Get.

IlBoolean IlvChartInteractorManager::removeInteractor

(

IlvChartInteractor *

interactor

)

Removes an interactor from this object.

Removes interactor from this manager instance. The interactor is unlocked.

Parameters:

interactor

The interactor to remove.

Returns:

A Boolean value indicating whether the interactor has been successfully removed.

void IlvChartInteractorManager::restoreCursorsVisibility	(	const IlvPoint &	point,
		const IlvTransformer *	t
	)

Restores the visibility state of the cursors.

This method takes into account the states saved by the most recent call to IlvChartInteractorManager::saveCursorsVisibility. It enables a given interactor to use its own cursor policy and then to reset the former cursors state when an event sequence ends.

Parameters:

	point	The new position in view coordinates of the cursors when the visibility states are restored.
	t	The transformer applied to the current view.

See also:

saveCursorsVisibility.

void IlvChartInteractorManager::saveCursorsVisibility

(

)

Stores the visibility state of the cursors.

Both cursors are shared by all the interactors maintained by this manager instance. This method enables a given interactor to use its own cursor policy and then to reset the cursors to their original state (shown or hidden) when an event sequence ends.

See also:

restoreCursorsVisibility.

static IlvChartInteractorManager* IlvChartInteractorManager::Set	(	IlvChartGraphic *	chart,
		IlvChartInteractorManager *	interMgr
	)			[static]

Attaches an IlvChartInteractorManager instance to a chart.

If the chart is not yet associated with an IlvChartInteractorDispatcher interactor, a default instance of this class is created and attached to the chart with the IlvGraphic::setInteractor(IlvInteractor*) method.

Parameters:

	chart	The chart object to which the interactor manager interMgr must be attached.
	interMgr	The interactor manager.

Returns:

The previous IlvChartInteractorManager instance attached to chart.

void IlvChartInteractorManager::setAbscissaCursorVisible

(

IlBoolean

visible

)

Sets the visibility state of the abscissa cursor.

This method is used to show or hide the abscissa cursor. An automatic redraw operation is performed if the visibility state has changed.

Parameters:

visible

The visibility state: either shown (IlTrue) or hidden (IlFalse).

void IlvChartInteractorManager::setCursorsVisible	(	IlBoolean	abscissa,
		IlBoolean	ordinate,
		IlBoolean	visible
	)

Sets the visibility state of the cursors.

This method is used to show or hide the cursors handled by this object. An automatic redraw operation is performed if the visibility state has changed.

Parameters:

	abscissa	A Boolean value indicating whether the visibility applies to the abscissa cursor.
	ordinate	A Boolean value indicating whether the visibility applies to the ordinate cursor.
	visible	The visibility state: either shown (IlTrue) or hidden (IlFalse).

void IlvChartInteractorManager::setOrdinateAxisIndex

(

IlUInt

index

)

Sets the index of the ordinate axis to which interactions apply.

This method sets the index of the ordinate axis that must be considered by the managed interactors. The latter will use this information for such operations as projection, translation, zooming, and so on.

Parameters:

index

The index of the ordinate axis to be considered.

void IlvChartInteractorManager::setOrdinateCursorVisible

(

IlBoolean

visible

)

Sets the visibility state of the ordinate cursor.

This method is used to show or hide the ordinate cursor. An automatic redraw operation is performed if the visibility state has changed.

Parameters:

visible

The visibility state: either shown (IlTrue) or hidden (IlFalse).

void IlvChartInteractorManager::showAbscissaCursor

(

IlBoolean

show

)

Sets the show state of the abscissa cursor.

Parameters:

show

A Boolean value indicating whether the abscissa cursor is used.

void IlvChartInteractorManager::showOrdinateCursor

(

IlBoolean

show

)

Sets the show state of the ordinate cursor.

Parameters:

show

A Boolean value indicating whether the ordinate cursor is used.