IlvLayoutGraphicFilter Class Reference

This class allows you to perform the layout on a subgraph that is, on a subset of the nodes and links of the original grapher (IlvGrapher). More...

#include <ilviews/layout/filter.h>

Inherits IlvLayoutValueInterface.

Inherited by IlvGraphFilterForLayersOnly, and IlvNullLayoutGraphicFilter.

Public Member Functions
	IlvLayoutGraphicFilter ()
	Creates a new IlvLayoutGraphicFilter. More...
virtual IlBoolean	accept (IlvGraphic *obj)
	Returns IlTrue if the graphic object obj is a node or a link that must be taken into account during the layout. More...
IlvGrapherAdapter *	getGrapherAdapter () const
	Returns the IlvGrapherAdapter with which the filter is associated.
void	setGrapherAdapter (IlvGrapherAdapter *)
	Allows the class IlvGrapherAdapter to register itself.

Detailed Description

This class allows you to perform the layout on a subgraph that is, on a subset of the nodes and links of the original grapher (IlvGrapher).

Library: ilvlayout

The accept method of the filter is called by the IlvGrapherAdapter to know, for any node and link, if the node or link must be taken into account or if it is completely ignored.

To install a filter on an IlvGrapherAdapter instance, use the method IlvGrapherAdapter.setFilter.

Note that all overridden implementations of the method accept must respect the following rules:

• A link cannot be accepted by the filter if any of its end nodes (origin or destination nodes) are not accepted.
• During a layout session, the filter must always return the same value for the same node or link.
• If the filter returns a different value for a given node or link than in the previous layout session, this means that the structure of the graph has been changed. Therefore, in this case you need to notify the IlvGrapherAdapter that its structure has been changed, using the method structureChanged.

See also

IlvGrapherAdapter::setFilter

Constructor & Destructor Documentation

IlvLayoutGraphicFilter::IlvLayoutGraphicFilter

(

)

Creates a new IlvLayoutGraphicFilter.

To install a filter on an IlvGrapherAdapter instance, use the method IlvGrapherAdapter::setFilter.

See also

IlvGrapherAdapter::setFilter

Member Function Documentation

virtual IlBoolean IlvLayoutGraphicFilter::accept ( IlvGraphic *  obj )

virtual

Returns IlTrue if the graphic object obj is a node or a link that must be taken into account during the layout.

If no layers are specified using the method addLayer on the adapter instance on which the filter is installed, or if all the layers are specified, the method returns IlTrue for any argument. Otherwise, it returns IlTrue only for objects on the specified layers.

This method can be overridden in order to specify other conditions for filtering the nodes and the links.

Note

Any overridden implementation of this method must respect the following rule: A link cannot be accepted if any of its end nodes (origin or destination nodes) are not accepted.