Annotation Pro API
Public Member Functions | Properties | Events | List of all members
LayerObject Class Reference

A layer object. More...

Public Member Functions

void ClearSegmentSelection ()
 Clears the segment selection. More...
 
LayerObject Copy ()
 Copies this object. More...
 
LayerObject Copy (bool withSegments)
 Copies this object. More...
 
void Crop (float start, float end)
 Crops annotation to given start and and More...
 
SegmentCollection FindSegmentsInRange (float start, float end, bool onlySegmentsFullInRange)
 Searches for segments in range. More...
 
int GetCurrentHeight ()
 Gets current height. More...
 
void InvertSegmentSelection ()
 Inverts segment selection More...
 

Properties

Color BackColor [get, set]
 Gets or sets the color of the back. More...
 
double ChartMaximum [get, set]
 Gets or sets the chart maximum. More...
 
double ChartMinimum [get, set]
 Gets or sets the chart minimum. More...
 
int ClosedLayerHeight [get]
 Gets the height of the closed layer. More...
 
Rectangle ControlRectangle [get, set]
 Gets or sets the control rectangle. More...
 
int CoordinateControlStyle [get, set]
 Gets or sets the coordinate control style. More...
 
int FontSize [get, set]
 Gets or sets font size for labels on layer More...
 
int Height [get, set]
 Gets or sets the height. More...
 
Guid Id [get, set]
 Gets or sets the identifier. More...
 
bool IncludeInFrequency [get, set]
 Gets or sets a value indicating whether the in frequency should be included. More...
 
bool IsClosed [get, set]
 Gets or sets a value indicating whether this object is closed. More...
 
bool IsDragging [get, set]
 Gets or sets a value indicating whether this object is dragging. More...
 
bool IsDraggingBottom [get, set]
 Gets or sets a value indicating whether this object is dragging bottom. More...
 
bool IsLocked [get, set]
 Gets or sets a value indicating whether this object is locked. More...
 
bool IsLockedInSession [get, set]
 Gets or sets a value indicating whether this object is locked in session. More...
 
bool IsSelected [get, set]
 Gets or sets a value indicating whether this object is selected. More...
 
bool IsVideoTarget [get]
 Gets true if this layer has set target for video clips More...
 
bool IsVisible [get, set]
 Gets or sets layer visibility. More...
 
string Name [get, set]
 Gets or sets the name. More...
 
Rectangle NameAreaRectangle = 0 [get]
 Gets the name area rectangle. More...
 
string Parameter1Name [get, set]
 Gets or sets the name of the parameter 1. More...
 
string Parameter2Name [get, set]
 Gets or sets the name of the parameter 2. More...
 
string Parameter3Name [get, set]
 Gets or sets the name of the parameter 3. More...
 
SegmentCollection Segments [get, set]
 Gets or sets the segments. More...
 
SegmentObject SelectedSegment [get]
 Gets the selected segment. More...
 
SegmentCollection SelectedSegments [get]
 Gets the selected segments. More...
 
bool ShowAsChart [get, set]
 Gets or sets a value indicating whether as chart is shown. More...
 
bool ShowBoundaries [get, set]
 Gets or sets a value indicating whether the boundaries is shown. More...
 
bool ShowOnSpectrogram [get, set]
 Gets or sets a value indicating whether the on spectrogram is shown. More...
 
object Tag [get, set]
 Gets or sets the tag. More...
 
int VideoPlayerIndex [get, set]
 Index of video player to play assigned video if any More...
 

Events

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

Detailed Description

A layer object.

Member Function Documentation

◆ ClearSegmentSelection()

void ClearSegmentSelection ( )
inline

Clears the segment selection.

◆ Copy() [1/2]

LayerObject Copy ( )
inline

Copies this object.

Returns
A LayerObject.

◆ Copy() [2/2]

LayerObject Copy ( bool  withSegments)
inline

Copies this object.

Parameters
withSegmentstrue to with segments.
Returns
A LayerObject.

◆ Crop()

void Crop ( float  start,
float  end 
)
inline

Crops annotation to given start and and

Parameters
startcropping start position in samples
endcropping end position in samples

◆ FindSegmentsInRange()

SegmentCollection FindSegmentsInRange ( float  start,
float  end,
bool  onlySegmentsFullInRange 
)
inline

Searches for segments in range.

Parameters
startThe start.
endThe end.
onlySegmentsFullInRangetrue to only segments full in range.
Returns
The found segments in range.

◆ GetCurrentHeight()

int GetCurrentHeight ( )
inline

Gets current height.

Returns
The current height.

◆ InvertSegmentSelection()

void InvertSegmentSelection ( )
inline

Inverts segment selection

Property Documentation

◆ BackColor

Color BackColor
getset

Gets or sets the color of the back.

◆ ChartMaximum

double ChartMaximum
getset

Gets or sets the chart maximum.

◆ ChartMinimum

double ChartMinimum
getset

Gets or sets the chart minimum.

◆ ClosedLayerHeight

int ClosedLayerHeight
get

Gets the height of the closed layer.

◆ ControlRectangle

Rectangle ControlRectangle
getset

Gets or sets the control rectangle.

◆ CoordinateControlStyle

int CoordinateControlStyle
getset

Gets or sets the coordinate control style.

◆ FontSize

int FontSize
getset

Gets or sets font size for labels on layer

◆ Height

int Height
getset

Gets or sets the height.

◆ Id

Guid Id
getset

Gets or sets the identifier.

◆ IncludeInFrequency

bool IncludeInFrequency
getset

Gets or sets a value indicating whether the in frequency should be included.

◆ IsClosed

bool IsClosed
getset

Gets or sets a value indicating whether this object is closed.

◆ IsDragging

bool IsDragging
getset

Gets or sets a value indicating whether this object is dragging.

◆ IsDraggingBottom

bool IsDraggingBottom
getset

Gets or sets a value indicating whether this object is dragging bottom.

◆ IsLocked

bool IsLocked
getset

Gets or sets a value indicating whether this object is locked.

◆ IsLockedInSession

bool IsLockedInSession
getset

Gets or sets a value indicating whether this object is locked in session.

◆ IsSelected

bool IsSelected
getset

Gets or sets a value indicating whether this object is selected.

◆ IsVideoTarget

bool IsVideoTarget
get

Gets true if this layer has set target for video clips

◆ IsVisible

bool IsVisible
getset

Gets or sets layer visibility.

◆ Name

string Name
getset

Gets or sets the name.

◆ NameAreaRectangle

Rectangle NameAreaRectangle = 0
get

Gets the name area rectangle.

◆ Parameter1Name

string Parameter1Name
getset

Gets or sets the name of the parameter 1.

◆ Parameter2Name

string Parameter2Name
getset

Gets or sets the name of the parameter 2.

◆ Parameter3Name

string Parameter3Name
getset

Gets or sets the name of the parameter 3.

◆ Segments

SegmentCollection Segments
getset

Gets or sets the segments.

◆ SelectedSegment

SegmentObject SelectedSegment
get

Gets the selected segment.

◆ SelectedSegments

SegmentCollection SelectedSegments
get

Gets the selected segments.

◆ ShowAsChart

bool ShowAsChart
getset

Gets or sets a value indicating whether as chart is shown.

◆ ShowBoundaries

bool ShowBoundaries
getset

Gets or sets a value indicating whether the boundaries is shown.

◆ ShowOnSpectrogram

bool ShowOnSpectrogram
getset

Gets or sets a value indicating whether the on spectrogram is shown.

◆ Tag

object Tag
getset

Gets or sets the tag.

◆ VideoPlayerIndex

int VideoPlayerIndex
getset

Index of video player to play assigned video if any

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: