rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvIconPointRenderer Class Reference

This renderer translates a map feature whose geometry is an IlvMapPoint into an IlvIcon. More...

#include <ilviews/maps/rendering/iconptrdr.h>

Inheritance diagram for IlvIconPointRenderer:
IlvFeatureRenderer

List of all members.

Public Member Functions

 IlvIconPointRenderer (const IlvIconPointRenderer &source)
 Creates an IlvIconPointRenderer by copying an existing one.
 IlvIconPointRenderer (IlvDisplay *display)
 Creates an instance of the renderer.
virtual IlvFeatureRenderercopy () const
 Copies the object.
IlvBitmapgetBitmap () const
 Returns the bitmap used by the renderer.
virtual IlvGraphicmakeGraphic (const IlvMapFeature &feature, const IlvMapInfo &targetMapInfo, IlvMapsError &status) const
 Translates an IlvMapFeature into a graphic object.
void setBitmap (IlvBitmap *bitmap)
 Sets the bitmap used by this renderer.
IlvMapsError setBitmapFileName (const char *fileName)
 Sets the bitmap used by this renderer by specifying a file name.
virtual void write (IlvOutputFile &) const
 Writes the renderer to an IlvOutputStream.

Static Public Member Functions

static IlvBitmapGetDefaultBitmap (IlvDisplay *display)
 Returns the default bitmap used by the renderer if no bitmap has been specified.

Detailed Description

This renderer translates a map feature whose geometry is an IlvMapPoint into an IlvIcon.

Library: ilvmaps


Constructor & Destructor Documentation

IlvIconPointRenderer::IlvIconPointRenderer ( IlvDisplay display  ) 

Creates an instance of the renderer.

Parameters:
display The IlvDisplay used to create the graphic objects.
IlvIconPointRenderer::IlvIconPointRenderer ( const IlvIconPointRenderer source  ) 

Creates an IlvIconPointRenderer by copying an existing one.

Parameters:
source The object to be copied.

Member Function Documentation

virtual IlvFeatureRenderer* IlvIconPointRenderer::copy (  )  const [virtual]

Copies the object.

Returns:
A copy of this IlvFeatureRenderer.

Implements IlvFeatureRenderer.

IlvBitmap* IlvIconPointRenderer::getBitmap (  )  const

Returns the bitmap used by the renderer.

Returns:
An IlvBitmap object that should not be deleted. However, it can be locked if an other object has to use it.
See also:
IlvResource::lock, IlvResource::unLock.
static IlvBitmap* IlvIconPointRenderer::GetDefaultBitmap ( IlvDisplay display  )  [static]

Returns the default bitmap used by the renderer if no bitmap has been specified.

Returns:
An IlvBitmap object that should not be deleted. However, it can be locked if an other object has to use it.
See also:
IlvResource::lock, IlvResource::unLock.
virtual IlvGraphic* IlvIconPointRenderer::makeGraphic ( const IlvMapFeature feature,
const IlvMapInfo targetMapInfo,
IlvMapsError &  status 
) const [virtual]

Translates an IlvMapFeature into a graphic object.

If the targetMapInfo has a non-null projection, or a projection that is not an instance of IlvUnknownProjection, the graphic object is projected to the projection system of targetMapInfo. Otherwise, only the map adapter of targetMapInfo is used to convert the feature coordinate into the manager coordinate system.

Parameters:
feature The map feature to be translated.
targetMapInfo This parameter specifies the projection in which the graphic object must be returned. If this projection is not defined (targetMapInfo.getProjection() is NULL), the graphic object is returned to the projection of the map feature (only the map adapter is used)
status Is set to an error code if the renderer cannot process the map feature (most of the time, because the renderer does not support the feature geometry, but it can also indicate that a projection error occurred).
Returns:
An IlvGraphic or a null pointer if a severe error occurred.

Implements IlvFeatureRenderer.

void IlvIconPointRenderer::setBitmap ( IlvBitmap bitmap  ) 

Sets the bitmap used by this renderer.

Parameters:
bitmap The bitmap to be set.
IlvMapsError IlvIconPointRenderer::setBitmapFileName ( const char *  fileName  ) 

Sets the bitmap used by this renderer by specifying a file name.

Parameters:
fileName The name of the file containing the bitmap.
Returns:
An IlvMapError code if fileName is not a valid bitmap file name.
virtual void IlvIconPointRenderer::write ( IlvOutputFile file  )  const [virtual]

Writes the renderer to an IlvOutputStream.

This function must be reimplemented by the subclasses of IlvFeatureRenderer, but it should not be called directly by the application. For more information about subclassing an IlvFeatureRenderer, refer to the User Manual of Rogue Wave Views Maps.

Parameters:
file The output file.
See also:
save

Implements IlvFeatureRenderer.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

© 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.