Loading...
Searching...
No Matches
RouteEvent Class Reference

Class storing one route event payload. More...

Public Member Functions

 RouteEvent (this.type, this.turnEvent, this.transitionEntryEvent, this.transitionExitEvent, this.targetReachedEvent)
 Default constructor.
 

Public Attributes

RouteEventType type
 Active event variant discriminator.
 
TurnEvent turnEvent
 Payload for turn events, set when type is TURN_EVENT.
 
TransitionEntryEvent transitionEntryEvent
 Payload for transition entry events.
 
TransitionExitEvent transitionExitEvent
 Payload for transition exit events.
 
TargetReachedEvent targetReachedEvent
 Payload for target reached events.
 

Detailed Description

Class storing one route event payload.

Referenced from RoutePath, RouteNode.

Definition at line 23 of file route_event.dart.

Constructor & Destructor Documentation

◆ RouteEvent()

RouteEvent.RouteEvent ( this. type,
this. turnEvent,
this. transitionEntryEvent,
this. transitionExitEvent,
this. targetReachedEvent )

Default constructor.

Member Data Documentation

◆ targetReachedEvent

TargetReachedEvent RouteEvent.targetReachedEvent

Payload for target reached events.

Dart code snippet:

TargetReachedEvent? reachedEvent = event.targetReachedEvent;
if (reachedEvent != null) {
_demonstrateTargetReachedEventUsage(reachedEvent);
}

Definition at line 80 of file route_event.dart.

◆ transitionEntryEvent

TransitionEntryEvent RouteEvent.transitionEntryEvent

Payload for transition entry events.

Dart code snippet:

TransitionEntryEvent? entryEvent = event.transitionEntryEvent;
if (entryEvent != null) {
_demonstrateTransitionEntryEventUsage(entryEvent);
}

Definition at line 58 of file route_event.dart.

◆ transitionExitEvent

TransitionExitEvent RouteEvent.transitionExitEvent

Payload for transition exit events.

Dart code snippet:

TransitionExitEvent? exitEvent = event.transitionExitEvent;
if (exitEvent != null) {
_demonstrateTransitionExitEventUsage(exitEvent);
}

Definition at line 69 of file route_event.dart.

◆ turnEvent

TurnEvent RouteEvent.turnEvent

Payload for turn events, set when type is TURN_EVENT.

Dart code snippet:

TurnEvent? turnEvent = event.turnEvent;
if (turnEvent != null) {
_demonstrateTurnEventUsage(turnEvent);
}

Definition at line 47 of file route_event.dart.

◆ type

RouteEventType RouteEvent.type

Active event variant discriminator.

Dart code snippet:

// Get event type
RouteEventType type = event.type;
print("Event type: $type");

Definition at line 36 of file route_event.dart.


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