SegmentCollection Class Reference

Collection of segments. More...

Inherits List< SegmentObject >.

Public Member Functions
	SegmentCollection ()
	Default constructor. More...
new void	Add (SegmentObject item)
	Adds item. More...
SegmentObject	ById (Guid id)
	By identifier. More...
void	ClearSelection ()
	Clears the selection. More...
SegmentCollection	Copy ()
	Copies this object. More...
SegmentObject	FindLeftNeighbour (SegmentObject segment)
	Searches for the first left neighbour. More...
SegmentObject	FindLeftNeighbour (SegmentObject segment, bool sticked)
	Searches for the first left neighbour. More...
SegmentObject	FindLeftNeighbour (SegmentObject segment, bool sticked, uint stickApproximation)
	Searches for the first left neighbour. More...
SegmentObject	FindRightNeighbour (SegmentObject segment)
	Searches for the first right neighbour. More...
SegmentObject	FindRightNeighbour (SegmentObject segment, bool sticked)
	Searches for the first right neighbour. More...
SegmentObject	FindRightNeighbour (SegmentObject segment, bool sticked, uint stickApproximation)
	Searches for the first right neighbour. More...
new void	Insert (int index, SegmentObject item)
	Inserts. More...
void	SelectAllSegments ()
	Select all segments. More...

Properties
SegmentObject	MostLeftSegment [get]
	Gets the most left segment. More...
SegmentObject	MostRightSegment [get]
	Gets the most right segment. More...
LayerObject	ParentLayer [get, set]
	Gets or sets the parent layer. More...

Detailed Description

Collection of segments.

Constructor & Destructor Documentation

SegmentCollection()

SegmentCollection ( )

inline

Default constructor.

Member Function Documentation

Add()

new void Add ( SegmentObject  item )

inline

Adds item.

Parameters

item	The item to add.

ById()

SegmentObject ById ( Guid  id )

inline

By identifier.

Parameters

id	The identifier.

Returns

A SegmentObject.

ClearSelection()

void ClearSelection ( )

inline

Clears the selection.

Copy()

SegmentCollection Copy ( )

inline

Copies this object.

Returns

A SegmentCollection.

FindLeftNeighbour() [1/3]

SegmentObject FindLeftNeighbour ( SegmentObject  segment )

inline

Searches for the first left neighbour.

Parameters

segment

The segment.

Returns

The found left neighbour.

FindLeftNeighbour() [2/3]

SegmentObject FindLeftNeighbour ( SegmentObject  segment, bool  sticked  )

inline

Searches for the first left neighbour.

Parameters

segment	Given segment
sticked	Search for sticked only.

Returns

The found left neighbour.

FindLeftNeighbour() [3/3]

SegmentObject FindLeftNeighbour ( SegmentObject  segment, bool  sticked, uint  stickApproximation  )

inline

Searches for the first left neighbour.

Parameters

segment	The segment.
sticked	true if sticked.
stickApproximation	Maximum sticked border distance.

Returns

The found left neighbour.

FindRightNeighbour() [1/3]

SegmentObject FindRightNeighbour ( SegmentObject  segment )

inline

Searches for the first right neighbour.

Parameters

segment

Given segment.

Returns

The found right neighbour.

FindRightNeighbour() [2/3]

SegmentObject FindRightNeighbour ( SegmentObject  segment, bool  sticked  )

inline

Searches for the first right neighbour.

Parameters

segment	Given segment.
sticked	Search for sticked only.

Returns

The found right neighbour.

FindRightNeighbour() [3/3]

SegmentObject FindRightNeighbour ( SegmentObject  segment, bool  sticked, uint  stickApproximation  )

inline

Searches for the first right neighbour.

Parameters

segment	Given segment.
sticked	Search for sticked only.
stickApproximation	Maximum sticked border distance.

Returns

The found right neighbour.

Insert()

new void Insert ( int  index, SegmentObject  item  )

inline

Inserts.

Parameters

index	Zero-based index of the.
item	The item.

SelectAllSegments()

void SelectAllSegments ( )

inline

Select all segments.

Property Documentation

MostLeftSegment

SegmentObject MostLeftSegment

get

Gets the most left segment.

The most left segment.

MostRightSegment

SegmentObject MostRightSegment

get

Gets the most right segment.

The most right segment.

ParentLayer

LayerObject ParentLayer

getset

Gets or sets the parent layer.

The parent layer.

---

The documentation for this class was generated from the following file:

• AnnotationPro.Logic/SegmentCollection.cs