Class Timeline
Represents a timeline used by profile elements
Implements
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public class Timeline : CorePropertyChanged, IStorageModel
Constructors
Timeline()
Creates a new instance of the Timeline class
Declaration
public Timeline()
Properties
Delta
Gets the cumulative delta of all calls to Update(TimeSpan, bool) that took place after the last call to ClearDelta()
Declaration
public TimeSpan Delta { get; }
Property Value
Type | Description |
---|---|
TimeSpan |
EndSegmentEndPosition
Gets or sets the end position of the end segment
Declaration
public TimeSpan EndSegmentEndPosition { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
EndSegmentLength
Gets or sets the length of the end segment
Declaration
public TimeSpan EndSegmentLength { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
EndSegmentStartPosition
Gets or sets the end position of the end segment
Declaration
public TimeSpan EndSegmentStartPosition { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
IsFinished
Gets a boolean indicating whether the timeline has finished its run
Declaration
public bool IsFinished { get; }
Property Value
Type | Description |
---|---|
bool |
IsOverridden
Gets a boolean indicating whether the timeline progress has been overridden
Declaration
public bool IsOverridden { get; }
Property Value
Type | Description |
---|---|
bool |
Length
Gets the total length of this timeline
Declaration
public TimeSpan Length { get; }
Property Value
Type | Description |
---|---|
TimeSpan |
MainSegmentEndPosition
Gets or sets the end position of the main segment
Declaration
public TimeSpan MainSegmentEndPosition { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
MainSegmentLength
Gets or sets the length of the main segment
Declaration
public TimeSpan MainSegmentLength { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
MainSegmentStartPosition
Gets or sets the start position of the main segment
Declaration
public TimeSpan MainSegmentStartPosition { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
Position
Gets the current position of the timeline
Declaration
public TimeSpan Position { get; }
Property Value
Type | Description |
---|---|
TimeSpan |
StartSegmentEndPosition
Gets or sets the end position of the start segment
Declaration
public TimeSpan StartSegmentEndPosition { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
StartSegmentLength
Gets or sets the length of the start segment
Declaration
public TimeSpan StartSegmentLength { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
Methods
ClearDelta()
Declaration
public void ClearDelta()
JumpToEnd()
Moves the position of the timeline forwards to the very end of the timeline
Declaration
public void JumpToEnd()
JumpToEndSegment()
Moves the position of the timeline forwards to the beginning of the end segment
Declaration
public void JumpToEndSegment()
JumpToStart()
Moves the position of the timeline backwards to the very start of the timeline
Declaration
public void JumpToStart()
Load()
Loads the model from its associated entity
Declaration
public void Load()
Save()
Saves the model to its associated entity
Declaration
public void Save()
ToString()
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |
Overrides
Update(TimeSpan, bool)
Updates the timeline, applying the provided delta
to the Position
Declaration
public void Update(TimeSpan delta, bool stickToMainSegment)
Parameters
Type | Name | Description |
---|---|---|
TimeSpan | delta | The amount of time to apply to the position |
bool | stickToMainSegment | Whether to stick to the main segment, wrapping around if needed |
Events
TimelineChanged
Occurs when changes have been made to any of the segments of the timeline.
Declaration
public event EventHandler? TimelineChanged
Event Type
Type | Description |
---|---|
EventHandler |