IlvMapImage Class Reference

This class defines an image. More...

#include <ilviews/maps/geometry/geoimage.h>

Inheritance diagram for IlvMapImage:

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

Additional Inherited Members
Static Public Member Functions inherited from IlvMapGeometry
static IlvClassInfo *	ClassInfo ()
	Returns the class info. More...
Protected Member Functions inherited from IlvMapArea
	IlvMapArea ()
	Initializes a new empty IlvMapArea instance.
Protected Member Functions inherited from IlvMapGeometry
	IlvMapGeometry ()
	Constructor. More...

Detailed Description

This class defines an image.

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

Constructor & Destructor Documentation

IlvMapImage()

IlvMapImage::IlvMapImage

(

const IlvMapImage &

source

)

Initializes a new instance of IlvMapImage as a copy of another instance.

Parameters

source

The object to be copied.

Member Function Documentation

contains()

virtual IlBoolean IlvMapImage::contains ( const IlvCoordinate &  coordinate ) const

virtual

Returns IlTrue if some coordinate is contained in the object.

Parameters

coordinate

The point to be checked.

Returns

IlTrue if coordinate is contained in the object.

Implements IlvMapArea.

copy()

virtual IlvMapGeometry* IlvMapImage::copy ( ) const

virtual

Returns a copy of the object.

Returns

An IlvMapGeometry that must be deleted by the user.

Implements IlvMapArea.

getBitmapData()

IlvBitmapData* IlvMapImage::getBitmapData

(

)

const

Returns the bitmap data.

Returns

The IlvBitmapData object.

getClassInfo()

virtual IlvClassInfo* IlvMapImage::getClassInfo ( ) const

virtual

Returns the IlvClassInfo of the instance.

Returns

An IlvClassInfo that should not be modified nor deleted.

Implements IlvMapArea.

getLowerRightCorner()

const IlvCoordinate& IlvMapImage::getLowerRightCorner

(

)

const

Returns the lower right corner.

Returns

The lower right corner.

getStroke()

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.

getSubElement()

virtual const IlvMapGeometry* IlvMapImage::getSubElement ( IlUInt  index ) const

virtual

Returns a sub element of a collection geometry.

Parameters

index

The index of the sub-geometry to be retrieved.

Returns

The sub element of index index if the geometry is a collection or 0 if it is not.

Implements IlvMapGeometry.

getSubElementCount()

virtual IlUInt IlvMapImage::getSubElementCount ( ) const

virtual

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

Returns

The number of elements contained in the geometry if the geometry is a collection. If it is not, this method returns 0.

Implements IlvMapGeometry.

getUpperLeftCorner()

const IlvCoordinate& IlvMapImage::getUpperLeftCorner

(

)

const

Returns the upper left corner.

Returns

The upper left corner.

isCollection()

virtual IlBoolean IlvMapImage::isCollection ( ) const

virtual

Checks if this 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.

setBitmapData()

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.

setLowerRightCorner()

void IlvMapImage::setLowerRightCorner

(

const IlvCoordinate &

lr

)

Sets the lower right corner.

Parameters

lr	The new lower right corner coordinates.

setUpperLeftCorner()

void IlvMapImage::setUpperLeftCorner

(

const IlvCoordinate &

ul

)

Sets the upper left corner.

Parameters

ul	The new upper left corner coordinates.