IlvMapImage Class Reference

This class defines an image. More...

Inheritance diagram for IlvMapImage:

List of all members.

Public Member Functions
	IlvMapImage (const IlvMapImage &source)
	Copies an exiting IlvMapImage.
	IlvMapImage ()
	Constructor.
virtual IlBoolean	contains (const IlvCoordinate &coordinate) const
	Returns IlTrue if coordinate is contained in the object.
virtual IlvMapGeometry *	copy () const
	Returns a copy of the object.
IlvBitmapData *	getBitmapData () const
	Returns the bitmap data.
virtual IlvClassInfo *	getClassInfo () const
	Returns the IlvClassInfo of the instance.
const IlvCoordinate &	getLowerRightCorner () const
	Returns the lower right corner.
virtual const IlvMapCurve *	getStroke () const
	Returns the stroke of the area.
virtual const IlvMapGeometry *	getSubElement (IlUInt index) const
	Returns the sub element of index index if the geometry is a collection.
virtual IlUInt	getSubElementCount () const
	Returns the number of elements contained in the geometry if the geometry is a collection.
const IlvCoordinate &	getUpperLeftCorner () const
	Returns the upper left corner.
virtual IlBoolean	isCollection () const
	Returns IlTrue if the geometry is a collection of other geometries.
void	setBitmapData (IlvBitmapData *bitmapData)
	Sets the bitmap data.
void	setLowerRightCorner (const IlvCoordinate &lr)
	Sets the lower right corner.
void	setUpperLeftCorner (const IlvCoordinate &ul)
	Sets the upper left corner.

---

Detailed Description

This class defines an image.

The instances of this class can be rendered by an IlvDefaultFeatureRenderer or by an IlvDefaultImageRenderer. Library: ilvmaps

---

Constructor & Destructor Documentation

IlvMapImage::IlvMapImage

(

)

Constructor.

Creates an instance of IlvMapImage.

IlvMapImage::IlvMapImage

(

const IlvMapImage &

source

)

Copies an exiting IlvMapImage.

Parameters:

source

The object to be copied.

---

Member Function Documentation

virtual IlBoolean IlvMapImage::contains

(

const IlvCoordinate &

coordinate

)

const [virtual]

Returns IlTrue if coordinate is contained in the object.

Parameters:

coordinate

The point to be checked.

Returns:

IlTrue if coordinate is contained in the object.

Implements IlvMapArea.

virtual IlvMapGeometry* IlvMapImage::copy

(

)

const [virtual]

Returns a copy of the object.

Returns:

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapArea.

IlvBitmapData* IlvMapImage::getBitmapData

(

)

const

Returns the bitmap data.

Returns:

The IlvBitmapData object.

virtual IlvClassInfo* IlvMapImage::getClassInfo

(

)

const [virtual]

Returns the IlvClassInfo of the instance.

Returns:

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapArea.

const IlvCoordinate& IlvMapImage::getLowerRightCorner

(

)

const

Returns the lower right corner.

Returns:

The lower right corner.

virtual const IlvMapCurve* IlvMapImage::getStroke

(

)

const [virtual]

Returns the stroke of the area.

Returns:

An IlvCurve object that should not be deleted nor modified.

Implements IlvMapArea.

virtual const IlvMapGeometry* IlvMapImage::getSubElement

(

IlUInt

index

)

const [virtual]

Returns the sub element of index index if the geometry is a collection.

Otherwise, it returns a null pointer.

Returns:

The sub element of index index if the geometry is a collection.

Implements IlvMapGeometry.

virtual IlUInt IlvMapImage::getSubElementCount

(

)

const [virtual]

Returns the number of elements contained in the geometry if the geometry is a collection.

Otherwise, it returns 0.

Returns:

The number of elements contained in the geometry if the geometry is a collection. Otherwise, it returns 0.

Implements IlvMapGeometry.

const IlvCoordinate& IlvMapImage::getUpperLeftCorner

(

)

const

Returns the upper left corner.

Returns:

The upper left corner.

virtual IlBoolean IlvMapImage::isCollection

(

)

const [virtual]

Returns IlTrue if the geometry is a collection of other geometries.

The composite geometries predefined in Rogue Wave Views Maps are: IlvMapGeometryCollection, IlvMapMultiPoint, IlvMapSegmentString and its subclasses, IlvMapMultiCurve and IlvMapMultiArea.

Returns:

IlTrue if the geometry is a collection of other geometries.

Implements IlvMapGeometry.

void IlvMapImage::setBitmapData

(

IlvBitmapData *

bitmapData

)

Sets the bitmap data.

Parameters:

bitmapData

The bitmap data to be set. This geometry sets a lock on the specified bitmap data. This lock is removed once this geometry is deleted.

void IlvMapImage::setLowerRightCorner

(

const IlvCoordinate &

lr

)

Sets the lower right corner.

Parameters:

lr

The lower right corner.

void IlvMapImage::setUpperLeftCorner

(

const IlvCoordinate &

ul

)

Sets the upper left corner.

Parameters:

ul

The upper left corner.