Reference Source Test
public class | source

MotionTargetQueue

Queue of targets (points) that robot has to reach.

Method Summary

Public Methods
public

addPointBack(point: *, params: *)

Add single point at the end of the queue

public

addPointFront(point: misc.Point, params: Object)

Add single point at the beginning of the queue

public

addPointsBack(points: *, params: *)

Add points at the end of the queue

public

addPointsFront(points: *, params: *)

Add points at the beginning of the queue

public

empty()

Delete all items from queue

public

getPfLine(): misc.Line

Make line between current position and target if path finding is enabled

public

Get final target of path finding algorithm if path finding is enabled

public

getTargetBack(): services.motion.MotionTarget

Get target at the end of the queue

public

getTargetFront(): services.motion.MotionTarget

Get target at the front of queue

public

getTargets(): Array<services.motion.MotionTarget>

Get all targets

public

isEmpty(): *

Check if queue is empty

public

Remove target from back of queue

public

Remove target from front of queue

Public Methods

public addPointBack(point: *, params: *) source

Add single point at the end of the queue

Params:

NameTypeAttributeDescription
point *

{misc.Point} - Point

params *

{Object} - Params for target

public addPointFront(point: misc.Point, params: Object) source

Add single point at the beginning of the queue

Params:

NameTypeAttributeDescription
point misc.Point

Point

params Object

Params for target

public addPointsBack(points: *, params: *) source

Add points at the end of the queue

Params:

NameTypeAttributeDescription
points *

{Array<misc.Point>} - Array of points

params *

{Object} - Params for each target

public addPointsFront(points: *, params: *) source

Add points at the beginning of the queue

Params:

NameTypeAttributeDescription
points *

{Array<misc.Point>} - Array of points

params *

{Object} - Params for each target

public empty() source

Delete all items from queue

public getPfLine(): misc.Line source

Make line between current position and target if path finding is enabled

Return:

misc.Line

public getPfTarget(): MotionTarget source

Get final target of path finding algorithm if path finding is enabled

Return:

MotionTarget

public getTargetBack(): services.motion.MotionTarget source

Get target at the end of the queue

Return:

services.motion.MotionTarget

public getTargetFront(): services.motion.MotionTarget source

Get target at the front of queue

Return:

services.motion.MotionTarget

public getTargets(): Array<services.motion.MotionTarget> source

Get all targets

Return:

Array<services.motion.MotionTarget>

List of all targets

public isEmpty(): * source

Check if queue is empty

Return:

*

public removeBack() source

Remove target from back of queue

public removeFront() source

Remove target from front of queue