rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvFeatureRenderer Class Reference

Subclasses of this abstract class are used to translate an IlvMapFeature into a graphic object. More...

#include <ilviews/maps/renderer.h>

Inheritance diagram for IlvFeatureRenderer:
IlvDefaultAreaRenderer IlvDefaultCurveRenderer IlvDefaultFeatureRenderer IlvDefaultImageRenderer IlvDefaultPointRenderer IlvDefaultRasterRenderer IlvDefaultTextRenderer IlvIconPointRenderer

List of all members.

Public Member Functions

virtual IlvFeatureRenderercopy () const =0
 Copies the object.
IlvDisplaygetDisplay () const
 Returns the renderer display.
IlBoolean isPersistent () const
 Checks if the renderer can be saved.
virtual IlvGraphicmakeGraphic (const IlvMapFeature &feature, const IlvMapInfo &targetMapInfo, IlvMapsError &status) const =0
 Translates an IlvMapFeature into a graphic object.
void save (IlvOutputFile &file) const
 Saves the object to an IlvOutputFile.
virtual void write (IlvOutputFile &file) const =0
 Writes the renderer to an IlvOutputStream.

Static Public Member Functions

static IlvFeatureRendererLoad (IlvInputFile &file)
 Loads a renderer from an IlvInputFile.

Protected Member Functions

 IlvFeatureRenderer (IlvDisplay *display, IlBoolean persistent=IlTrue)
 Constructor.

Detailed Description

Subclasses of this abstract class are used to translate an IlvMapFeature into a graphic object.

Library: ilvmaps

See also:
IlvDefaultFeatureRenderer

Constructor & Destructor Documentation

IlvFeatureRenderer::IlvFeatureRenderer ( IlvDisplay display,
IlBoolean  persistent = IlTrue 
) [protected]

Constructor.

The constructor of this abstract class is protected.

Parameters:
display The display for which the graphic objects will be created.
persistent Specifies if the renderer can be saved by the objects that use it.

Member Function Documentation

virtual IlvFeatureRenderer* IlvFeatureRenderer::copy (  )  const [pure virtual]
IlvDisplay* IlvFeatureRenderer::getDisplay (  )  const

Returns the renderer display.

Returns:
The renderer display that is used to create the graphic objects.
IlBoolean IlvFeatureRenderer::isPersistent (  )  const

Checks if the renderer can be saved.

Returns:
IlTrue if the renderer can be saved by the objects that use it.
static IlvFeatureRenderer* IlvFeatureRenderer::Load ( IlvInputFile file  )  [static]

Loads a renderer from an IlvInputFile.

Parameters:
file The input file.
Returns:
An IlvFeatureRenderer or a null pointer if the load operation fails.
virtual IlvGraphic* IlvFeatureRenderer::makeGraphic ( const IlvMapFeature feature,
const IlvMapInfo targetMapInfo,
IlvMapsError &  status 
) const [pure 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.

Implemented in IlvDefaultFeatureRenderer, IlvDefaultAreaRenderer, IlvDefaultCurveRenderer, IlvIconPointRenderer, IlvDefaultImageRenderer, IlvDefaultPointRenderer, IlvDefaultRasterRenderer, and IlvDefaultTextRenderer.

void IlvFeatureRenderer::save ( IlvOutputFile file  )  const

Saves the object to an IlvOutputFile.

Parameters:
file The output file.
See also:
Load
virtual void IlvFeatureRenderer::write ( IlvOutputFile file  )  const [pure 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

Implemented in IlvDefaultAreaRenderer, IlvDefaultCurveRenderer, IlvIconPointRenderer, IlvDefaultImageRenderer, IlvDefaultPointRenderer, IlvDefaultRasterRenderer, and IlvDefaultTextRenderer.


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