SemiVirtualEdge (Core 2.0 API)

java.lang.Object
- org.tinfour.semivirtual.SemiVirtualEdge

All Implemented Interfaces:

IQuadEdge
```
public final class SemiVirtualEdge
extends Object
implements IQuadEdge
```
Provides methods and elements implementing the QuadEdge data structure using a virtual representation of the links based on integer arrays rather than direct class instances.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clear all reference in the virtual edge.
`boolean`	`equals(Object o)`
`Vertex`	`getA()` Gets the initial vertex for this edge.
`Vertex`	`getB()` Gets the second vertex for this edge.
`int`	`getBaseIndex()` Gets the index of the base of the current edge.
`SemiVirtualEdge`	`getBaseReference()` Constructs a new instance of the virtual edge class referencing the base of the current edge (may be a copy of the current edge if it is a base).
`int`	`getConstraintIndex()` Gets the index of the constraint associated with this edge.
`SemiVirtualEdge`	`getDual()` Constructs a new instance of the virtual edge class referencing the dual of the current edge.
`SemiVirtualEdge`	`getDualFromForward()` Constructs a new instance of the virtual edge class referencing the dual of the forward of the current edge
`SemiVirtualEdge`	`getDualFromReverse()` Constructs a new instance of the virtual edge class referencing the dual of the current edge's reverse.
`SemiVirtualEdge`	`getForward()` Gets the forward reference of the edge.
`SemiVirtualEdge`	`getForwardFromDual()` Constructs a new instance of the virtual edge class referencing the forward of the dual of the current edge
`int`	`getIndex()` Gets the index value for this edge.
`double`	`getLength()` Gets the length of the edge.
`SemiVirtualEdge`	`getReverse()` Constructs a new instance of the virtual edge class referencing the forward of the current edge.
`SemiVirtualEdge`	`getReverseFromDual()` Constructs a new instance of the virtual edge class referencing the reverse of the dual of the current edge
`int`	`getSide()` Gets the low-order bit of the index of the current edge
`Vertex`	`getTriangleApex()` When the edge exists within a TIN, this method gets the apex of a triangle formed with the edge as the base.
`int`	`hashCode()`
`boolean`	`isConstrained()` Indicates whether an edge is constrained.
`boolean`	`isConstrainedRegionBorder()` Indicates whether an edge represents the border of a constrained region.
`boolean`	`isConstrainedRegionInterior()` Indicates whether the edge is in the interior of a constrained region.
`boolean`	`isConstrainedRegionMember()` Indicates whether the edge is a member of a constrained region (is in the interior or serves as the border of a polygon-based constraint).
`boolean`	`isExterior()` Indicates if the edge is exterior to a TIN.
`boolean`	`isSynthetic()` Indicates whether the synthetic flag is set for the edge.
`void`	`loadForwardFromEdge(SemiVirtualEdge e)` Load the content of the forward of the specified edge
`void`	`loadReverseFromEdge(SemiVirtualEdge e)` Load the content of the reverse of the specified edge
`Iterable<IQuadEdge>`	`pinwheel()` Gets an instance of an iterable that performs a pinwheel operation.
`void`	`setA(Vertex a)` Sets the initial vertex of the current edge (and final vertex of its dual)
`void`	`setB(Vertex b)` Sets the final vertex of the current edge (and initial vertex of its dual)
`void`	`setConstrained(int constraintIndex)` Sets an edge as constrained and sets its constraint index.
`void`	`setConstrainedRegionBorderFlag()` Sets a flag indicating that the edge is an edge of a constrained region.
`void`	`setConstrainedRegionInteriorFlag()` Sets the constrained region membership flag for the edge to true.
`void`	`setConstraintIndex(int constraintIndex)` Sets the constraint index for this edge.
`void`	`setDualForward(SemiVirtualEdge forward)` Sets the forward link for the dual of the current edge.
`void`	`setDualReverse(SemiVirtualEdge reverse)` Sets the reverse link for the dual of the current edge.
`void`	`setForward(SemiVirtualEdge e)` Sets the forward link for the current edge.
`void`	`setReverse(SemiVirtualEdge e)` Sets the reverse link for the current edge.
`void`	`setSynthetic(boolean status)` Sets the synthetic flag for the edge.
`void`	`setVertices(Vertex a, Vertex b)` Sets both vertices for the current edge (and the opposite vertices of its dual).
`String`	`toString()`

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

- Method Detail
  - loadForwardFromEdge
```
public void loadForwardFromEdge(SemiVirtualEdge e)
```
    Load the content of the forward of the specified edge
    
    Parameters:
    
    e - a valid instance
  - loadReverseFromEdge
```
public void loadReverseFromEdge(SemiVirtualEdge e)
```
    Load the content of the reverse of the specified edge
    
    Parameters:
    
    e - a valid instance
  - getA
```
public Vertex getA()
```
    Description copied from interface: IQuadEdge
    
    Gets the initial vertex for this edge.
    
    Specified by:
    
    getA in interface IQuadEdge
    
    Returns:
    
    a valid reference.
  - getB
```
public Vertex getB()
```
    Description copied from interface: IQuadEdge
    
    Gets the second vertex for this edge.
    
    Specified by:
    
    getB in interface IQuadEdge
    
    Returns:
    
    a valid reference or a null for a ghost edge.
  - getForward
```
public SemiVirtualEdge getForward()
```
    Description copied from interface: IQuadEdge
    
    Gets the forward reference of the edge.
    
    Specified by:
    
    getForward in interface IQuadEdge
    
    Returns:
    
    a valid reference.
  - getTriangleApex
```
public Vertex getTriangleApex()
```
    When the edge exists within a TIN, this method gets the apex of a triangle formed with the edge as the base.
    
    Returns:
    
    if defined, a valid instance; otherwise, a null.
  - isExterior
```
public boolean isExterior()
```
    Indicates if the edge is exterior to a TIN.
    
    Returns:
    
    true if the edge is exterior; otherwise, false.
  - getReverse
```
public SemiVirtualEdge getReverse()
```
    Constructs a new instance of the virtual edge class referencing the forward of the current edge.
    
    Specified by:
    
    getReverse in interface IQuadEdge
    
    Returns:
    
    a new instances
  - getDualFromReverse
```
public SemiVirtualEdge getDualFromReverse()
```
    Constructs a new instance of the virtual edge class referencing the dual of the current edge's reverse.
    
    Specified by:
    
    getDualFromReverse in interface IQuadEdge
    
    Returns:
    
    a new instances
  - getDual
```
public SemiVirtualEdge getDual()
```
    Constructs a new instance of the virtual edge class referencing the dual of the current edge.
    
    Specified by:
    
    getDual in interface IQuadEdge
    
    Returns:
    
    a new instances
  - clear
```
public void clear()
```
    Clear all reference in the virtual edge.
  - getBaseReference
```
public SemiVirtualEdge getBaseReference()
```
    Constructs a new instance of the virtual edge class referencing the base of the current edge (may be a copy of the current edge if it is a base).
    
    Specified by:
    
    getBaseReference in interface IQuadEdge
    
    Returns:
    
    a new instances
  - getBaseIndex
```
public int getBaseIndex()
```
    Gets the index of the base of the current edge. The index value for a base is always an even number.
    
    Returns:
    
    an even integer value
  - getForwardFromDual
```
public SemiVirtualEdge getForwardFromDual()
```
    Constructs a new instance of the virtual edge class referencing the forward of the dual of the current edge
    
    Specified by:
    
    getForwardFromDual in interface IQuadEdge
    
    Returns:
    
    a new instances
  - getDualFromForward
```
public SemiVirtualEdge getDualFromForward()
```
    Constructs a new instance of the virtual edge class referencing the dual of the forward of the current edge
    
    Returns:
    
    a new instances
  - getReverseFromDual
```
public SemiVirtualEdge getReverseFromDual()
```
    Constructs a new instance of the virtual edge class referencing the reverse of the dual of the current edge
    
    Specified by:
    
    getReverseFromDual in interface IQuadEdge
    
    Returns:
    
    a new instances
  - getIndex
```
public int getIndex()
```
    Description copied from interface: IQuadEdge
    
    Gets the index value for this edge. In general, the index value is intended for memory management and edge pools. Thus, it may not be set by application code. In some applications involving edge-traversal operations, it is used to maintain a bitmap of visited edges.
    When an edge is allocated, it is set with an arbitrary index value. This value will not change while the edge remains allocated by and edge-pool instance. As soon as the edge is released, it is likely to have its index value reassigned.
    
    Specified by:
    
    getIndex in interface IQuadEdge
    
    Returns:
    
    a positive integer value
  - getLength
```
public double getLength()
```
    Description copied from interface: IQuadEdge
    
    Gets the length of the edge.
    
    Specified by:
    
    getLength in interface IQuadEdge
    
    Returns:
    
    a positive floating point value
  - getSide
```
public int getSide()
```
    Gets the low-order bit of the index of the current edge
    
    Specified by:
    
    getSide in interface IQuadEdge
    
    Returns:
    
    a zero or a one.
  - setA
```
public void setA(Vertex a)
```
    Sets the initial vertex of the current edge (and final vertex of its dual)
    
    Parameters:
    
    a - a valid reference or a null.
  - setB
```
public void setB(Vertex b)
```
    Sets the final vertex of the current edge (and initial vertex of its dual)
    
    Parameters:
    
    b - a valid reference or a null.
  - setDualForward
```
public void setDualForward(SemiVirtualEdge forward)
```
    Sets the forward link for the dual of the current edge.
    
    Parameters:
    
    forward - the forward reference/
  - setDualReverse
```
public void setDualReverse(SemiVirtualEdge reverse)
```
    Sets the reverse link for the dual of the current edge.
    
    Parameters:
    
    reverse - the forward reference/
  - setForward
```
public void setForward(SemiVirtualEdge e)
```
    Sets the forward link for the current edge.
    
    Parameters:
    
    e - the forward reference/
  - setReverse
```
public void setReverse(SemiVirtualEdge e)
```
    Sets the reverse link for the current edge.
    
    Parameters:
    
    e - the forward reference/
  - setVertices
```
public void setVertices(Vertex a,
                        Vertex b)
```
    Sets both vertices for the current edge (and the opposite vertices of its dual).
    
    Parameters:
    
    a - the initial vertex
    
    b - the final vertex
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getConstraintIndex
```
public int getConstraintIndex()
```
    Description copied from interface: IQuadEdge
    
    Gets the index of the constraint associated with this edge.
    
    Specified by:
    
    getConstraintIndex in interface IQuadEdge
    
    Returns:
    
    a positive value; may be zero if not specified.
  - setConstraintIndex
```
public void setConstraintIndex(int constraintIndex)
```
    Description copied from interface: IQuadEdge
    
    Sets the constraint index for this edge. This method does not necessarily set an edge to a constrained status. In some implementations the constraint index may be used as a way of associating ordinary edges with a neighboring constraint. Constraint index values must be positive integers. The range of supported values will depend on the specific class that implements this interface. Please refer to the class documentation for specific values.
    
    Specified by:
    
    setConstraintIndex in interface IQuadEdge
    
    Parameters:
    
    constraintIndex - a positive number indicating which constraint a particular edge is associated with.
  - setConstrained
```
public void setConstrained(int constraintIndex)
```
    Description copied from interface: IQuadEdge
    
    Sets an edge as constrained and sets its constraint index. Note that once an edge is constrained, it cannot be set to a non-constrained status. Constraint index values must be positive integers. The range of supported values will depend on the specific class that implements this interface. Please refer to the class documentation for specific values.
    
    Specified by:
    
    setConstrained in interface IQuadEdge
    
    Parameters:
    
    constraintIndex - positive number indicating which constraint a particular edge is associated with.
  - isConstrained
```
public boolean isConstrained()
```
    Description copied from interface: IQuadEdge
    
    Indicates whether an edge is constrained.
    
    Specified by:
    
    isConstrained in interface IQuadEdge
    
    Returns:
    
    true if the edge is constrained; otherwise, false.
  - isConstrainedRegionBorder
```
public boolean isConstrainedRegionBorder()
```
    Description copied from interface: IQuadEdge
    
    Indicates whether an edge represents the border of a constrained region. Border edges will always be constrained. Border edges are also classified as "member" edges of a constrained region.
    
    Specified by:
    
    isConstrainedRegionBorder in interface IQuadEdge
    
    Returns:
    
    true if the edge is the border of the constrained region; otherwise, false.
  - isConstrainedRegionInterior
```
public boolean isConstrainedRegionInterior()
```
    Description copied from interface: IQuadEdge
    
    Indicates whether the edge is in the interior of a constrained region. Both sides of the edge lie within the interior of the region. All points along the edge will lie within the interior of the region with the possible exception of the endpoints. The endpoints may lie on the border of the region. An interior edge for a constrained region is not a constrained edge. Interior edges are also classified as "member" edges of a constrained region.
    
    Specified by:
    
    isConstrainedRegionInterior in interface IQuadEdge
    
    Returns:
    
    true if the edge is in the interior of an region; otherwise false.
  - isConstrainedRegionMember
```
public boolean isConstrainedRegionMember()
```
    Description copied from interface: IQuadEdge
    
    Indicates whether the edge is a member of a constrained region (is in the interior or serves as the border of a polygon-based constraint). A constrained region member is not necessarily a constrained edge.
    
    Specified by:
    
    isConstrainedRegionMember in interface IQuadEdge
    
    Returns:
    
    true if the edge is a member of an region; otherwise false.
  - setConstrainedRegionBorderFlag
```
public void setConstrainedRegionBorderFlag()
```
    Description copied from interface: IQuadEdge
    
    Sets a flag indicating that the edge is an edge of a constrained region.
    
    Specified by:
    
    setConstrainedRegionBorderFlag in interface IQuadEdge
  - setConstrainedRegionInteriorFlag
```
public void setConstrainedRegionInteriorFlag()
```
    Description copied from interface: IQuadEdge
    
    Sets the constrained region membership flag for the edge to true.
    
    Specified by:
    
    setConstrainedRegionInteriorFlag in interface IQuadEdge
  - pinwheel
```
public Iterable<IQuadEdge> pinwheel()
```
    Description copied from interface: IQuadEdge
    Gets an instance of an iterable that performs a pinwheel operation. This instance may be used in a Java for statement
```
    for(IQuadEdge e: startingEdge.pinwheel()){
    }
 
```
    Specified by:
    
    pinwheel in interface IQuadEdge
    
    Returns:
    
    a valid Iterable.
  - setSynthetic
```
public void setSynthetic(boolean status)
```
    Description copied from interface: IQuadEdge
    
    Sets the synthetic flag for the edge. Synthetic edges are those that do not arise naturally from the TIN-building logic but are created by special operations.
    
    Specified by:
    
    setSynthetic in interface IQuadEdge
    
    Parameters:
    
    status - true if the edge is synthetic; otherwise, false.
  - isSynthetic
```
public boolean isSynthetic()
```
    Description copied from interface: IQuadEdge
    
    Indicates whether the synthetic flag is set for the edge.
    
    Specified by:
    
    isSynthetic in interface IQuadEdge
    
    Returns:
    
    true if the edge is synthetic; otherwise, false.

Class SemiVirtualEdge

Method Summary

Methods inherited from class java.lang.Object

Method Detail

loadForwardFromEdge

loadReverseFromEdge

getA

getB

getForward

getTriangleApex

isExterior

getReverse

getDualFromReverse

getDual

clear

getBaseReference

getBaseIndex

getForwardFromDual

getDualFromForward

getReverseFromDual

getIndex

getLength

getSide

setA

setB

setDualForward

setDualReverse

setForward

setReverse

setVertices

toString

hashCode

equals

getConstraintIndex

setConstraintIndex

setConstrained

isConstrained

isConstrainedRegionBorder

isConstrainedRegionInterior

isConstrainedRegionMember

setConstrainedRegionBorderFlag

setConstrainedRegionInteriorFlag

pinwheel

setSynthetic

isSynthetic