ilog.views.maps.geometry
Class IlvMapSegmentRing

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

All Implemented Interfaces:

IlvMapRingInterface

public class IlvMapSegmentRing
extends Object
implements IlvMapRingInterface

This class defines a ring whose outline is an IlvMapSegmentString. The IlvMapSegmentString should be closed, which means that its start point should be the same as its end point. If the IlvMapSegmentString is not closed, the assumption is performed that it is closed by an IlvMapLinearSegment.

Since:

JViews 3.5

Constructor Summary

IlvMapSegmentRing()
Initializes an instance of the class without its outline.

IlvMapSegmentRing(IlvMapSegmentString outline)
Initializes an instance of the class with its outline.

Method Summary

boolean	contains(IlvCoordinate c) Returns true if c is contained in the object.
IlvMapCurve	getOutline() Returns the outline of the object.
IlvMapSegmentString	setOutline(IlvMapSegmentString outline) Sets 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

IlvMapSegmentRing

public IlvMapSegmentRing()

Initializes an instance of the class without its outline.

IlvMapSegmentRing

public IlvMapSegmentRing(IlvMapSegmentString outline)

Initializes an instance of the class with its outline.

Parameters:

outline - The outline. Since the outline is not copied, the outline should not be modified after the operation.

Method Detail

getOutline

public IlvMapCurve getOutline()

Returns the outline of the object.
As the returned outline can be a reference to an internal object, you should not modify it.

Specified by:

getOutline in interface IlvMapRingInterface

Returns:

An IlvMapCurve object that should not be modified.

setOutline

public IlvMapSegmentString setOutline(IlvMapSegmentString outline)

Sets the outline of the object.

Parameters:

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

Returns:

The previous outline.

contains

public boolean contains(IlvCoordinate c)

Returns true if c 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.