IlvMapLayoutParameters (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.maps.labelling.IlvMapLayoutParameters

```
public class IlvMapLayoutParameters
extends Object
```
A class to store Perforce JViews Maps label layout parameters.

Since:

JViews 5.0

Constructor Summary

Constructors
Constructor and Description

IlvMapLayoutParameters()
Creates an IlvMapLayoutParameters.

Constructors
Constructor and Description
`IlvMapLayoutParameters()` Creates an `IlvMapLayoutParameters`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getDistFromOtherObstacles()` Retrieves the distance from the other obstacles.
`double`	`getHalfPathHeight()` Retrieves the half path height.
`double`	`getHalfPathWidth()` Retrieves the half path width.
`double`	`getLabelOffset()` Retrieves the label offset.
`double`	`getMaxDistFromPath()` Retrieves the max dist from path.
`double`	`getObstacleOffset()` Retrieves the obstacle offset.
`int`	`getObstacleShape()` Retrieves the obstacle shape.
`static IlvMapLayoutParameters`	`GetParameters(IlvManager manager)` Constructs an `IlvMapLayoutParameters` from the properties attached to an `IlvManager`.
`int`	`getPreferredDirection()` Retrieves the preferred direction.
`double`	`getPreferredDistFromPath()` Retrieves the preferred dist from path.
`boolean`	`isUsingGraphicReference()` Tells if the labeler is using the `IlvGraphic` reference of the `IlvAnchoredLabel` as an obstacle or as a point.
`static void`	`PutParameters(IlvManager manager, IlvMapLayoutParameters parameters)` Attaches the parameters to a manager.
`void`	`setDistFromOtherObstacles(double d)` Set the distance from the other obstacles.
`void`	`setHalfPathHeight(double h)` Sets the half path height.
`void`	`setHalfPathWidth(double w)` Sets the half path width.
`void`	`setLabelOffset(double o)` Sets the label offset.
`void`	`setMaxDistFromPath(double m)` Set the max dist from path.
`void`	`setObstacleOffset(double o)` Sets the obstacle offset.
`void`	`setObstacleShape(int s)` Sets the obstacle shape.
`void`	`setPreferredDirection(int d)` Sets the preferred direction.
`void`	`setPreferredDistFromPath(double p)` Set the preferred dist from path.
`void`	`setUsingGraphicReference(boolean use)` Tells the labeler if it should use the `IlvGraphic` reference of the `IlvAnchoredLabel` reference as an obstacle or as a point.
`String`	`toString()` Pretty string representation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IlvMapLayoutParameters
```
public IlvMapLayoutParameters()
```
    Creates an IlvMapLayoutParameters. The default values are the following ones :
    - LabelOffset = 1
    - ObstacleOffset = 1
    - HalfPathWidth = 1
    - HalfPathHeight = 1
    - MaxDistFromPath = 30
    - PreferredDistFromPath = 1
    - DistFromOtherObstacles = 1
    - PreferredDirection = IlvDirection.Top
    - UsingGraphicReference = true
    - ObstacleShape = IlvAnnealingPointLabelDescriptor.RECTANGULAR
- Method Detail
  - getLabelOffset
```
public double getLabelOffset()
```
    Retrieves the label offset.
  - setLabelOffset
```
public void setLabelOffset(double o)
```
    Sets the label offset.
    
    See Also:
    
    IlvAnnealingLabelLayout.setLabelOffset(double)
  - getObstacleOffset
```
public double getObstacleOffset()
```
    Retrieves the obstacle offset.
  - setObstacleOffset
```
public void setObstacleOffset(double o)
```
    Sets the obstacle offset.
    
    See Also:
    
    IlvAnnealingLabelLayout.setObstacleOffset(double)
  - getHalfPathWidth
```
public double getHalfPathWidth()
```
    Retrieves the half path width.
  - setHalfPathWidth
```
public void setHalfPathWidth(double w)
```
    Sets the half path width.
    
    See Also:
    
    IlvAnnealingPointLabelDescriptor.setHalfWidth(double)
  - getHalfPathHeight
```
public double getHalfPathHeight()
```
    Retrieves the half path height.
  - setHalfPathHeight
```
public void setHalfPathHeight(double h)
```
    Sets the half path height.
    
    See Also:
    
    IlvAnnealingPointLabelDescriptor.setHalfHeight(double)
  - getMaxDistFromPath
```
public double getMaxDistFromPath()
```
    Retrieves the max dist from path.
  - setMaxDistFromPath
```
public void setMaxDistFromPath(double m)
```
    Set the max dist from path.
    
    See Also:
    
    IlvAnnealingPointLabelDescriptor.setMaxDistFromPath(double)
  - getPreferredDistFromPath
```
public double getPreferredDistFromPath()
```
    Retrieves the preferred dist from path.
  - setPreferredDistFromPath
```
public void setPreferredDistFromPath(double p)
```
    Set the preferred dist from path.
    
    See Also:
    
    IlvAnnealingPointLabelDescriptor.setPreferredDistFromPath(double)
  - getDistFromOtherObstacles
```
public double getDistFromOtherObstacles()
```
    Retrieves the distance from the other obstacles.
  - setDistFromOtherObstacles
```
public void setDistFromOtherObstacles(double d)
```
    Set the distance from the other obstacles.
  - getPreferredDirection
```
public int getPreferredDirection()
```
    Retrieves the preferred direction.
  - setPreferredDirection
```
public void setPreferredDirection(int d)
```
    Sets the preferred direction. Possible directions are: IlvDirection.Left IlvDirection.Right IlvDirection.Top IlvDirection.Bottom
    
    See Also:
    
    IlvAnnealingPointLabelDescriptor.setPreferredDirection(int)
  - getObstacleShape
```
public int getObstacleShape()
```
    Retrieves the obstacle shape.
  - setObstacleShape
```
public void setObstacleShape(int s)
```
    Sets the obstacle shape.
    
    See Also:
    
    IlvAnnealingPointLabelDescriptor.setShape(int)
  - setUsingGraphicReference
```
public void setUsingGraphicReference(boolean use)
```
    Tells the labeler if it should use the IlvGraphic reference of the IlvAnchoredLabel reference as an obstacle or as a point.
    
    See Also:
    
    IlvAnchoredLabel.getReference(), IlvAnchoredLabel.getReferencePoint()
  - isUsingGraphicReference
```
public boolean isUsingGraphicReference()
```
    Tells if the labeler is using the IlvGraphic reference of the IlvAnchoredLabel as an obstacle or as a point.
  - toString
```
public String toString()
```
    Pretty string representation.
    
    Overrides:
    
    toString in class Object
  - PutParameters
```
public static void PutParameters(IlvManager manager,
                                 IlvMapLayoutParameters parameters)
```
    Attaches the parameters to a manager.
    
    Parameters:
    
    manager - The manager.
    
    parameters - The parameters to attach.
  - GetParameters
```
public static IlvMapLayoutParameters GetParameters(IlvManager manager)
```
    Constructs an IlvMapLayoutParameters from the properties attached to an IlvManager. If no properties have been set, an IlvMapLayoutParameters with default values is returned.

Class IlvMapLayoutParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvMapLayoutParameters

Method Detail

getLabelOffset

setLabelOffset

getObstacleOffset

setObstacleOffset

getHalfPathWidth

setHalfPathWidth

getHalfPathHeight

setHalfPathHeight

getMaxDistFromPath

setMaxDistFromPath

getPreferredDistFromPath

setPreferredDistFromPath

getDistFromOtherObstacles

setDistFromOtherObstacles

getPreferredDirection

setPreferredDirection

getObstacleShape

setObstacleShape

setUsingGraphicReference

isUsingGraphicReference

toString

PutParameters

GetParameters