Class NavMapComponent

Represents Vector's navigation memory map.

The NavMapComponent object subscribes for nav memory map updates from the robot to store and dispatch.

Inheritance
Object
RobotObject
Component
NavMapComponent
Implements
Inherited Members
Namespace: Anki.Vector
Assembly: Anki.Vector.dll
Syntax
public class NavMapComponent : Component, INotifyPropertyChanged

Properties

| Improve this Doc View Source

Frequency

Gets the map frequency.

public float Frequency { get; }
Property Type
Single
| Improve this Doc View Source

IsFeedActive

Gets a value indicating whether the nav map feed is active.

public bool IsFeedActive { get; }
Property Type
Boolean
| Improve this Doc View Source

LatestNavMap

Gets the latest nav map.

public NavMapGrid LatestNavMap { get; }
Property Type
NavMapGrid

Methods

| Improve this Doc View Source

StartFeed(Single)

Starts the nav map feed. The feed will run in a background thread and raise the LatestNavMap event for each map change. It will also update the LatestNavMap property.

public Task StartFeed(float frequency = 0.5F)
Parameters
Type Name Description
Single frequency

The navmap polling frequency.
Returns
Type Description
Task

A task that represents the asynchronous operation.
| Improve this Doc View Source

StopFeed()

Stops the nav map feed.

public Task StopFeed()
Returns
Type Description
Task

A task that represents the asynchronous operation.

Events

| Improve this Doc View Source

NavMapUpdate

Occurs when nav map updated

public event EventHandler<NavMapUpdateEventArgs> NavMapUpdate
Event Type
EventHandler<NavMapUpdateEventArgs>

Implements

See Also