Collection of layers. More...

Inherits List< LayerObject >.

Public Member Functions
	LayerCollection ()
	Default constructor. More...

new void	Add (LayerObject layer)
	Adds layer. More...

void	ClearSelection ()
	Clears the selection. More...

void	ClearSelection (bool clearLayers, bool clearSegments)
	Clears the selection. More...

LayerCollection	Copy (bool withId, bool withSegments)
	Copies this object. More...

LayerObject	FindById (Guid layerId)
	Searches for the first identifier. More...

LayerObject	FindByName (string layerName)
	Searches for the first layer with given name 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	FindLeftSnapTarget (SegmentObject segment, float minimumDistanceInSamples)
	Searches for the first left snap target. 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...

SegmentObject	FindRightSnapTarget (SegmentObject segment, float minimumDistanceInSamples)
	Searches for the first right snap target. More...

SegmentCollection	FindSegmentsInRange (float rangeStart, float rangeEnd)
	Searches segments in range. More...

SegmentObject	FindSnapTarget (SegmentObject segment, float minimumDistanceInSamples)
	Searches for the first snap target. More...

new void	Insert (int index, LayerObject item)
	Inserts. More...

new void	Remove (LayerObject layer)
	Removes the given layer. More...

Properties
string	Description `[get, set]`
	Gets or sets the description. More...

Events
ChangedHandler	Changed
	Event queue for all listeners interested in Changed events. More...

Detailed Description

Collection of layers.

Constructor & Destructor Documentation

◆ LayerCollection()

LayerCollection ( )

inline

Default constructor.

Member Function Documentation

◆ Add()

new void Add ( LayerObject layer )

inline

Adds layer.

Parameters

layer The layer to add.

◆ ClearSelection() [1/2]

void ClearSelection ( )

inline

Clears the selection.

◆ ClearSelection() [2/2]

void ClearSelection	(	bool	clearLayers,
		bool	clearSegments
	)

inline

Clears the selection.

Parameters

clearLayers	true to clear layers.
clearSegments	true to clear segments.

◆ Copy()

LayerCollection Copy	(	bool	withId,
		bool	withSegments
	)

inline

Copies this object.

Parameters

withId	true to with identifier.
withSegments	true to with segments.

Returns: A LayerCollection.

◆ FindById()

LayerObject FindById ( Guid layerId )

inline

Searches for the first identifier.

Parameters

layerId Identifier for the layer.

Returns: The found identifier.

◆ FindByName()

LayerObject FindByName ( string layerName )

inline

Searches for the first layer with given name

Parameters

layerName Name of layer to search

Returns: Layer if found otherwise null

////////////////////////////////////////////////////////////////////////////////////////////////////

◆ 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.

◆ FindLeftSnapTarget()

SegmentObject FindLeftSnapTarget	(	SegmentObject	segment,
		float	minimumDistanceInSamples
	)

inline

Searches for the first left snap target.

Parameters

segment	The segment.
minimumDistanceInSamples	The minimum distance in samples.

Returns: The found left snap target.

◆ 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.

◆ FindRightSnapTarget()

SegmentObject FindRightSnapTarget	(	SegmentObject	segment,
		float	minimumDistanceInSamples
	)

inline

Searches for the first right snap target.

Parameters

segment	The segment.
minimumDistanceInSamples	The minimum distance in samples.

Returns: The found right snap target.

◆ FindSegmentsInRange()

SegmentCollection FindSegmentsInRange	(	float	rangeStart,
		float	rangeEnd
	)

inline

Searches segments in range.

Parameters

rangeStart	Start of range.
rangeEnd	End of range.

Returns: The found segments in range.

◆ FindSnapTarget()

SegmentObject FindSnapTarget	(	SegmentObject	segment,
		float	minimumDistanceInSamples
	)

inline

Searches for the first snap target.

Parameters

segment	The segment.
minimumDistanceInSamples	The minimum distance in samples.

Returns: The found snap target.

◆ Insert()

new void Insert	(	int	index,
		LayerObject	item
	)

inline

Inserts.

Parameters

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

◆ Remove()

new void Remove ( LayerObject layer )

inline

Removes the given layer.

Parameters

layer The layer to add.

Property Documentation

◆ Description

string Description

getset

Gets or sets the description.

The description.

Event Documentation

◆ Changed

ChangedHandler Changed

Event queue for all listeners interested in Changed events.

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

AnnotationPro.Logic/LayerCollection.cs

Public Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ LayerCollection()

Member Function Documentation

◆ Add()

◆ ClearSelection() [1/2]

◆ ClearSelection() [2/2]

◆ Copy()

◆ FindById()

◆ FindByName()

◆ FindLeftNeighbour() [1/3]

◆ FindLeftNeighbour() [2/3]

◆ FindLeftNeighbour() [3/3]

◆ FindLeftSnapTarget()

◆ FindRightNeighbour() [1/3]

◆ FindRightNeighbour() [2/3]

◆ FindRightNeighbour() [3/3]

◆ FindRightSnapTarget()

◆ FindSegmentsInRange()

◆ FindSnapTarget()

◆ Insert()

◆ Remove()

Property Documentation

◆ Description

Event Documentation

◆ Changed