Namespace Anki.Vector.Types

Classes

Animation

Animation that can be played by the robot.

AnimationTrigger

Animation trigger that can be played by the robot.

CameraConfig

The fixed properties for Vector's camera.

A full 3x3 calibration matrix for doing 3D reasoning based on the camera images would look like:

+--------------+--------------+---------------+ |focal_length.x| 0 | center.x | +--------------+--------------+---------------+ | 0 |focal_length.y| center.y | +--------------+--------------+---------------+ | 0 | 0 | 1 | +--------------+--------------+---------------+

CheckUpdateStatus

The result of check update status methods.

CloudConnection

Cloud connection information

CubeBatteryState

The state of the cube battery.

Image

Represents a single image captured from the robot.

ImageRect

Image coordinates and size

KnownFace

A face that Vector has detected.

LatestAttentionTransfer

Vector attention transfer info event args

Light

Lights are used with Vector's Cube.

Lights may either be "on" or "off", though in practice any colors may be assigned to either state (including no color/light).

MotionProfile

Tells Vector how to drive when receiving navigation and movement actions such as GoToPose and DockWithCube.

NavMapGrid

A navigation memory map, stored as a quad-tree.

NavMapGridNode

A node in the NavMap

Leaf nodes contain content, all other nodes are split into 4 equally sized children.

Child node indices are stored in the following X,Y orientation:

+---+----+---+ | ^ | 2 | 0 | +---+----+---+ | Y | 3 | 1 | +---+----+---+ | | X->| | +---+----+---+

PhotoInfo

Store photo information

Pose

Represents where an object is in the world.

Whenever Vector is delocalized (i.e.whenever Vector no longer knows where he is - e.g.when he's picked up), Vector creates a new pose starting at (0,0,0) with no rotation, with origin_id incremented to show that these poses cannot be compared with earlier ones. As Vector drives around, his pose (and the pose of other objects he observes - e.g.faces, his LightCube, charger, etc.) is relative to this initial position and orientation.

The coordinate space is relative to Vector, where Vector's origin is the point on the ground between Vector's two front wheels. The X axis is Vector's forward direction, the Y axis is to Vector's left, and the Z axis is up.

Only poses of the same origin can safely be compared or operated on.

RobotLifetimeStats

Vector lifetime statistics

RobotSettings

THe permanently stored Vector robot settings

StatusCodeExtensions

Extensions for status codes

VersionState

The versioning information for Vector.

Structs

Acceleration

Represents acceleration values

AngularVelocity

Represents the angular velocity

Color

Extensions for working with robot colors

ColorProfile

Applies transforms to make Vector’s lights and colors appear as intended, by limiting maximum channel intensity.

Matrix

Simplified matrix struct

Point

Represents a point.

Position

Represents the position of an object in the world. A position consists of its x, y and z values in millimeters.

Quaternion

Represents the rotation of an object in the world.

Vector2

Represents a 2D Vector (type/units aren't specified)

Vector3

Represents a 3D Vector (type/units aren't specified)

Interfaces

IAnimation

Interface for animation and animation triggers

Enums

ActionResultCode

The result of an action

AttentionTransferReason

The reason for the last attention transfer

BatteryLevel

Battery level

BehaviorResultCode

The result of a behavior

ButtonWakeWord

The service that responds when clicking Vector's back button

CloudConnectionCode

Cloud connection code

CubeBatteryLevel

Cube battery level

CustomObjectMarker

Defines all available custom object markers.

CustomObjectType

Custom object type.

Vector has 20 slots for custom object types. You can define a Anki.Vector.ExternalInterface.CustomBoxDefinition, Anki.Vector.ExternalInterface.CustomCubeDefinition, or Anki.Vector.ExternalInterface.CustomWallDefinition in these slots and Vector will recognize objects of those types.