ilog.views.maps.geometry
Class IlvMapCircularRing

java.lang.Object
  ilog.views.maps.geometry.IlvMapCircularRing

All Implemented Interfaces:

IlvMapRingInterface

public class IlvMapCircularRing
extends Object
implements IlvMapRingInterface

This class defines a ring whose outline is an IlvMapCircle. The instances of this class can be rendered by an IlvDefaultFeatureRenderer or by an IlvDefaultAreaRenderer.

Since:

JViews 3.5

Constructor Summary

IlvMapCircularRing(IlvMapCircle outline)
Initializes an instance of the class with its outline.

Method Summary

boolean	contains(IlvCoordinate c) Returns true if coordinate is contained in the object.
IlvMapCircle	getCircle() Returns the IlvMapCircle that represents the outline of the object.
IlvMapCurve	getOutline() Returns an IlvMapCurve that represents the outline of this IlvMapCircularRing.
IlvMapCircle	setCircle(IlvMapCircle outline) Sets the IlvMapCircle that represents the outline of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvMapCircularRing

public IlvMapCircularRing(IlvMapCircle outline)

Initializes an instance of the class with its outline.

Parameters:

outline - The outline. This parameter should not be null. Since the outline parameter is no copied, this parameter should not be modified after being passed to the constructor.

Method Detail

getCircle

public IlvMapCircle getCircle()

Returns the IlvMapCircle that represents the outline of the object.

Returns:

The outline of the object.

setCircle

public IlvMapCircle setCircle(IlvMapCircle outline)

Sets the IlvMapCircle that represents the outline of the object.

Parameters:

outline - The new stroke. Since the outline parameter is not copied, this parameter should not be modified after being set.

Returns:

The previous outline.

getOutline

public IlvMapCurve getOutline()

Returns an IlvMapCurve that represents the outline of this IlvMapCircularRing. In this case, the stroke is an instance of IlvMapCircle.
As this method returns a reference to an internal object, this object is subject to change when this IlvMapCircularRing changes.

Specified by:

getOutline in interface IlvMapRingInterface

Returns:

An IlvCurve object that should not be modified.

contains

public boolean contains(IlvCoordinate c)

Returns true if coordinate is contained in the object.

Specified by:

contains in interface IlvMapRingInterface

Parameters:

c - The point to be checked.

Returns:

true if the specified point is contained in the object.