IlvSegmentedHyperEdge.Segment (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.hypergraph.IlvSegmentedHyperEdge.Segment

Enclosing class:

IlvSegmentedHyperEdge
```
public final class IlvSegmentedHyperEdge.Segment
extends Object
```
A segment of the hyperedge.

Since:

JViews 8.0

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`endsAt(IlvSegmentedHyperEdge.Segment segment, IlvTransformer t)` Checks whether this segment ends at the input segment.
`double`	`getAngle()` Returns the angle of the segment in degree.
`IlvHyperEdgeEnd[]`	`getEnds()` Returns the hyperedge ends of the segment.
`Object`	`getExtension()` Returns the user extension of the segment.
`IlvSegmentedHyperEdge`	`getHyperEdge()` Returns the hyperedge that owns this segment.
`IlvSegmentedHyperEdge.Segment`	`getIncidentSegment(int i)` Returns the incident segment with index i.
`IlvSegmentedHyperEdge.Segment[]`	`getIncidentSegments()` Returns the incident segments of this segment.
`int`	`getIncidentSegmentsCount()` Returns the number of incident segments.
`IlvPoint`	`getIntersectionPoint(IlvSegmentedHyperEdge.Segment segment, IlvTransformer t)` Returns the intersection point in view coordinates of the input segment with this segment.
`IlvSegmentedHyperEdge.Segment`	`getOtherIncidentSegment(IlvSegmentedHyperEdge.Segment segment)` Returns an incident segment other than the input segment.
`IlvPoint[]`	`getPoints(IlvTransformer t, IlvPoint[] pts)` Returns the start and end point of the segment in view coordinates.
`IlvSegmentedHyperEdge.Segment[]`	`getTerminatingSegments()` Returns the terminating segments.
`boolean`	`isColinear(IlvSegmentedHyperEdge.Segment seg)` Returns whether this segment and the input segment are colinear.
`boolean`	`isFullyTerminated()` Returns whether the segment is fully terminated.
`boolean`	`isIncident(IlvSegmentedHyperEdge.Segment segment)` Returns true if the input segment is incident to this segment.
`boolean`	`isSelected()` Returns `true` if the segment is selected, and `false` if the segment is not selected.
`boolean`	`isVariable()` Returns whether the segment has a variable angle.
`void`	`setExtension(Object extension)` Sets the user extension of the segment.
`void`	`setSelected(boolean flag)` Selects the segment.

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

- Method Detail
  - getHyperEdge
```
public IlvSegmentedHyperEdge getHyperEdge()
```
    Returns the hyperedge that owns this segment.
  - isVariable
```
public boolean isVariable()
```
    Returns whether the segment has a variable angle.
    A segment with variable angle changes it angle on the fly when moving the end points of the segment. A segment with a variable angle can have two hyperedge ends, or one hyperedge end and one incident segment, or two incident segments.
    A segment with constant angle never changes its angle. Moving one end of the segment will also move the other end in order to keep then angle constant. A segment with constant angle have have one hyperedge end, and additionally any arbitrary number of incident segments. Adjacent segments with constant angle must not be colinear.
  - isFullyTerminated
```
public boolean isFullyTerminated()
```
    Returns whether the segment is fully terminated. If the segment is fully terminated, it is not possible to connect more segments with fixed angle. For any segment, it is always possible to add arbitrary many segments with variable angle.
    If this segment has a fixed angle, it is never fully terminated, since it is always possible to add more segments. If this segment has a variable angle, it is fully terminated, if it has two incident segments, or one hyperedge end and one incident segments, or two hyperedge ends.
  - getTerminatingSegments
```
public IlvSegmentedHyperEdge.Segment[] getTerminatingSegments()
```
    Returns the terminating segments.
    If this segment has a fixed angle, it is never fully terminated, since it is always possible to add more segments. Hence it never has any terminating segments. An array of size 0 is returned.
    If this segment has a variable angle, it is fully terminated, if it has two incident segments, or one hyperedge end and one incident segments, or two hyperedge ends. In this case, an array with 0, 1 or 2 segments is returned.
  - endsAt
```
public boolean endsAt(IlvSegmentedHyperEdge.Segment segment,
                      IlvTransformer t)
```
    Checks whether this segment ends at the input segment. This means, this segment joins at one end into the input segment. For segments with variable angle, this segment ends at the input segment if the input segment is a terminating segment. For segments with fixed angle, there are no terminating segments but the segment can visually end at the input segment. If the hyperedge is nonzoomable, it depends on the transformer which segment joins into which other segment.
    
    Parameters:
    
    segment - The segment to be tested.
    
    t - The transformer to draw the hyperedge,
    
    Returns:
    
    true if this segment ends at the input segment.
    
    See Also:
    
    getTerminatingSegments()
  - isSelected
```
public boolean isSelected()
```
    Returns true if the segment is selected, and false if the segment is not selected.
  - setSelected
```
public void setSelected(boolean flag)
```
    Selects the segment.
  - getEnds
```
public IlvHyperEdgeEnd[] getEnds()
```
    Returns the hyperedge ends of the segment. Return an empty array if the segment is not incident to any end.
  - getAngle
```
public double getAngle()
```
    Returns the angle of the segment in degree. A horizontal segment has angle 0, a vertical segment has angle 90. The angle is between 0 and 180 degree.
  - isColinear
```
public boolean isColinear(IlvSegmentedHyperEdge.Segment seg)
```
    Returns whether this segment and the input segment are colinear. It should be avoided to connect colinear segments. Segments with variable angles are never colinear.
  - getIncidentSegmentsCount
```
public int getIncidentSegmentsCount()
```
    Returns the number of incident segments.
  - getIncidentSegment
```
public IlvSegmentedHyperEdge.Segment getIncidentSegment(int i)
```
    Returns the incident segment with index i.
  - getIncidentSegments
```
public IlvSegmentedHyperEdge.Segment[] getIncidentSegments()
```
    Returns the incident segments of this segment.
  - getOtherIncidentSegment
```
public IlvSegmentedHyperEdge.Segment getOtherIncidentSegment(IlvSegmentedHyperEdge.Segment segment)
```
    Returns an incident segment other than the input segment.
  - isIncident
```
public boolean isIncident(IlvSegmentedHyperEdge.Segment segment)
```
    Returns true if the input segment is incident to this segment.
  - getPoints
```
public IlvPoint[] getPoints(IlvTransformer t,
                            IlvPoint[] pts)
```
    Returns the start and end point of the segment in view coordinates.
    
    Parameters:
    
    t - The transformer to draw the hyperedge.
    
    pts - If an array of two points is passed, the array is filled with the points and returned as result. If null is passed, a newly allocated array is returned.
    
    Returns:
    
    An array of two points.
  - getIntersectionPoint
```
public IlvPoint getIntersectionPoint(IlvSegmentedHyperEdge.Segment segment,
                                     IlvTransformer t)
```
    Returns the intersection point in view coordinates of the input segment with this segment.
    
    Parameters:
    
    segment - The intersecting segment.
    
    t - The transformer to draw the hyperedge.
    
    Returns:
    
    The intersection point, or null if the input segment is not incident to this segment.
  - setExtension
```
public void setExtension(Object extension)
```
    Sets the user extension of the segment. This field is available for free user purpose. It allows to store additional information about the segment. The field is not used by the hyperedge itself.
    
    See Also:
    
    getExtension()
  - getExtension
```
public Object getExtension()
```
    Returns the user extension of the segment.
    
    See Also:
    
    setExtension(java.lang.Object)

Class IlvSegmentedHyperEdge.Segment

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getHyperEdge

isVariable

isFullyTerminated

getTerminatingSegments

endsAt

isSelected

setSelected

getEnds

getAngle

isColinear

getIncidentSegmentsCount

getIncidentSegment

getIncidentSegments

getOtherIncidentSegment

isIncident

getPoints

getIntersectionPoint

setExtension

getExtension