rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Manager Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Friends
IlvManagerLayer Class Reference

Manager layer class. More...

#include <ilviews/manager/layer.h>

Inheritance diagram for IlvManagerLayer:
IlvIndexedSet

Public Member Functions

 IlvManagerLayer (IlUShort maxInList, IlUShort maxInNode=IlvMaxObjectsInList)
 Constructor. More...
 
virtual ~IlvManagerLayer ()
 Destructor. More...
 
void addVisibilityFilter (IlvLayerVisibilityFilter *filter)
 Adds a visibility filter to the layer. More...
 
IlBoolean filterVisibility (const IlvMgrView *mgrview) const
 Calls the visibility filters of the layer. More...
 
IlvIntensity getAlpha () const
 Returns the alpha value of the layer. More...
 
IlvAntialiasingMode getAntialiasingMode () const
 Retrieves the anti-aliasing mode of the layer. More...
 
IlUShort getIndex () const
 Returns the index of the layer in the manager. More...
 
IlvManagergetManager () const
 Returns the manager associated with the layer. More...
 
const char * getName () const
 Returns the name of the manager layer. More...
 
IlBoolean isSelectable () const
 Indicates whether the layer is selectable. More...
 
IlBoolean isVisible () const
 Indicates whether the layer is visible for the manager. More...
 
IlBoolean removeVisibilityFilter (IlvLayerVisibilityFilter *filt)
 Removes a visibility filter from the layer. More...
 
void setAlpha (IlvIntensity alpha)
 Sets the alpha value of the layer. More...
 
void setAntialiasingMode (IlvAntialiasingMode mode)
 Sets the anti-aliasing mode of the layer. More...
 
virtual void setName (const char *name)
 Sets the name of the manager layer. More...
 
- Public Member Functions inherited from IlvIndexedSet
 IlvIndexedSet (IlUShort maxInList=30, IlUShort maxInNode=30)
 Constructor. More...
 
void addObject (const IlvGraphic *obj)
 Adds a graphic object to the set, subdividing it if necessary. More...
 
IlvGraphic *const * allContains (IlUInt &count, const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
 Returns all graphic objects containing a given point. More...
 
IlvGraphic *const * allInside (IlUInt &count, const IlvRect &rect, const IlvRect &trect, const IlvTransformer *t=0) const
 Returns all graphic objects located in a rectangle. More...
 
IlvGraphic *const * allIntersects (IlUInt &count, const IlvRect &rect, const IlvRect &trect, const IlvTransformer *t=0) const
 Returns all graphic objects intersecting a rectangle. More...
 
void allowSubdivision (IlBoolean b)
 Enable/disable automatic subdivision. More...
 
void apply (IlvApplyObject f, IlAny arg)
 Applies a user function to all objects of the set. More...
 
void apply (const IlSymbol *tag, IlvApplyObject f, IlAny arg)
 Apply a user function to tagged objects. More...
 
void applyDraw (IlvPort *dst, const IlvTransformer *t=0, const IlvRegion *region=0) const
 Draws all objects. More...
 
void applyInside (const IlvRect &rect, const IlvRect &trect, IlvApplyObject f, IlAny arg, const IlvTransformer *t=0)
 Apply a user function to objects located in a rectangle. More...
 
void applyInside (const IlvRect &rect, IlvApplyObject f, IlAny arg)
 Apply a user function to objects located in a rectangle. More...
 
void applyIntersects (const IlvRect &rect, const IlvRect &trect, IlvApplyObject f, IlAny arg, const IlvTransformer *t=0)
 Apply a user function to objects intersecting a rectangle. More...
 
void applyIntersects (const IlvRect &rect, IlvApplyObject f, IlAny arg)
 Apply a user function to objects intersecting a rectangle. More...
 
void applyToObject (IlvGraphic *obj, IlvApplyObject f, IlAny arg)
 Applies a user function to a graphic object. More...
 
IlvGraphicfirstIntersects (const IlvRegion &tr, const IlvTransformer *t=0) const
 Returns the first object intersecting a region. More...
 
IlUInt getCardinal () const
 Returns the number of objects in the set. More...
 
IlvGraphic *const * getObjects (IlUInt &count) const
 Returns the objects in the set. More...
 
IlBoolean isDivided () const
 Indicates whether the set is divided. More...
 
IlvGraphiclastContains (const IlvPoint &p, const IlvPoint &tp, const IlvTransformer *t=0) const
 Returns the object containing a given point. More...
 
void map (IlvApplyObject f, IlAny arg) const
 Applies a user function to all objects of the set. More...
 
void map (const IlSymbol *tag, IlvApplyObject f, IlAny arg) const
 Apply a user function to tagged objects. More...
 
void mapInside (const IlvRect &rect, const IlvRect &trect, IlvApplyObject f, IlAny arg, const IlvTransformer *t=0) const
 Apply a user function to objects located in a rectangle. More...
 
void mapInside (const IlvRect &rect, IlvApplyObject f, IlAny arg) const
 Apply a user function to objects located in a rectangle. More...
 
void mapIntersects (const IlvRect &rect, const IlvRect &trect, IlvApplyObject f, IlAny arg, const IlvTransformer *t=0) const
 Apply a user function to objects intersecting a rectangle. More...
 
void mapIntersects (const IlvRect &rect, IlvApplyObject f, IlAny arg) const
 Apply a user function to objects intersecting a rectangle. More...
 
IlBoolean removeObject (const IlvGraphic *obj)
 Removes a graphic object from the set. More...
 
void setMaxInNode (IlUShort m)
 Sets the subdividing threshold, or enable/disable automatic subdivision. More...
 
IlBoolean subDivide () const
 Indicates whether the set will subdivide itself or keep an ordered list. More...
 

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:

Constructor & Destructor Documentation

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

Constructor.

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

Parameters
maxInListSee the documentation of the IlvIndexedSet constructor.
maxInNodeSee 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
filterThe 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
mgrviewSpecifies 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
filterThe visibility filter.
void IlvManagerLayer::setAlpha ( IlvIntensity  alpha)

Sets the alpha value of the layer.

Parameters
alphaThe 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
modeThe 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
nameThe new name of the layer. The string is copied.

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