IlvManagerLayer Class Reference

Manager layer class. More...

#include <ilviews/manager/layer.h>

Inheritance diagram for IlvManagerLayer:

List of all members.

Public Member Functions
	IlvManagerLayer (IlUShort maxInList, IlUShort maxInNode=30)
	Constructor.
virtual	~IlvManagerLayer ()
	Destructor.
void	addVisibilityFilter (IlvLayerVisibilityFilter *filter)
	Adds a visibility filter to the layer.
IlBoolean	filterVisibility (const IlvMgrView *mgrview) const
	Calls the visibility filters of the layer.
IlvIntensity	getAlpha () const
	Returns the alpha value of the layer.
IlvAntialiasingMode	getAntialiasingMode () const
	Retrieves the anti-aliasing mode of the layer.
IlUShort	getIndex () const
	Returns the index of the layer in the manager.
IlvManager *	getManager () const
	Returns the manager associated with the layer.
const char *	getName () const
	Returns the name of the manager layer.
IlBoolean	isSelectable () const
	Indicates whether the layer is selectable.
IlBoolean	isVisible () const
	Indicates whether the layer is visible for the manager.
IlBoolean	removeVisibilityFilter (IlvLayerVisibilityFilter *filt)
	Removes a visibility filter from the layer.
void	setAlpha (IlvIntensity alpha)
	Sets the alpha value of the layer.
void	setAntialiasingMode (IlvAntialiasingMode mode)
	Sets the anti-aliasing mode of the layer.
virtual void	setName (const char *name)
	Sets the name of the manager layer.
Friends
class	IlvManager

---

Detailed Description

Manager layer class.

Library: ilvmgr

An IlvManagerLayer handles the complete information that is stored by a layer of a manager. You can access an instance of IlvManagerLayer by calling the three methods of the class IlvManager:

• IlvManagerLayer* getManagerLayer(int idx) where idx is the index of the manager layer you want to retrieve.
• IlvManagerLayer* getManagerLayer(const char* name) where name is the name of the manager layer you want to retrieve.
• IlvManagerLayer* getManagerLayer(const IlvGraphic* obj) where object is a pointer of an object located in the manager layer you want to retrieve.

---

Constructor & Destructor Documentation

IlvManagerLayer::IlvManagerLayer	(	IlUShort	maxInList,
		IlUShort	maxInNode = 30
	)

Constructor.

Initializes an instance of IlvManagerLayer. The layer is by default visible and selectable.

Parameters:

	maxInList	See the documentation of the IlvIndexedSet constructor.
	maxInNode	See the documentation of the IlvIndexedSet constructor.

virtual IlvManagerLayer::~IlvManagerLayer

(

)

[virtual]

Destructor.

Deletes the visibility filters associated with this layer.

---

Member Function Documentation

void IlvManagerLayer::addVisibilityFilter

(

IlvLayerVisibilityFilter *

filter

)

Adds a visibility filter to the layer.

Parameters:

filter

The visibility filter.

IlBoolean IlvManagerLayer::filterVisibility

(

const IlvMgrView *

mgrview

)

const

Calls the visibility filters of the layer.

Called by the manager to determine if the layer must be displayed. The method walks through the list of filters and calls the member function IlvLayerVisibilityFilter::isVisible. If a filter returns IlFalse, the layer is assumed to be invisible and the function returns at once.

Returns:

IlTrue if every call to IlvLayerVisibilityFilter::isVisible returns IlTrue. Otherwise, IlFalse is returned.

Parameters:

mgrview

Specifies the manager view given in parameter to each filter, the other parameter being the layer itself.

IlvIntensity IlvManagerLayer::getAlpha

(

)

const

Returns the alpha value of the layer.

Returns:

The alpha value of the layer.

IlvAntialiasingMode IlvManagerLayer::getAntialiasingMode

(

)

const

Retrieves the anti-aliasing mode of the layer.

Returns:

The anti-aliasing mode of the layer.

IlUShort IlvManagerLayer::getIndex

(

)

const

Returns the index of the layer in the manager.

Returns:

The index of the layer in the manager.

IlvManager* IlvManagerLayer::getManager

(

)

const

Returns the manager associated with the layer.

Returns:

The manager associated with the layer.

const char* IlvManagerLayer::getName

(

)

const

Returns the name of the manager layer.

Returns:

The name of the manager layer. The returned string must not be modified or deleted.

IlBoolean IlvManagerLayer::isSelectable

(

)

const

Indicates whether the layer is selectable.

Returns:

IlTrue if the layer is selectable, that is, graphic objects stored in the layer can be selected.

IlBoolean IlvManagerLayer::isVisible

(

)

const

Indicates whether the layer is visible for the manager.

Returns:

IlTrue if the layer is visible from the manager point of view and IlFalse if it is not. A visible layer may still be hidden in a given manager view.

IlBoolean IlvManagerLayer::removeVisibilityFilter

(

IlvLayerVisibilityFilter *

filt

)

Removes a visibility filter from the layer.

Parameters:

filter

The visibility filter.

void IlvManagerLayer::setAlpha

(

IlvIntensity

alpha

)

Sets the alpha value of the layer.

Parameters:

alpha

The new alpha value of the layer. A value of 0 means that the layer is completely transparent. A value of IlvFullIntensity means that the layer is opaque.

void IlvManagerLayer::setAntialiasingMode

(

IlvAntialiasingMode

mode

)

Sets the anti-aliasing mode of the layer.

Parameters:

mode

The new anti-aliasing mode.

virtual void IlvManagerLayer::setName

(

const char *

name

)

[virtual]

Sets the name of the manager layer.

It is a good habit not to have multiple layers with the same name in the same manager, although the API lets you do that.

Parameters:

name

The new name of the layer. The string is copied.