CartoType Android API 7.8.2, 2022-03-25
for Java development on Android
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
com.cartotype.Turn Class Reference

Public Member Functions

String TurnCommand ()
 

Public Attributes

int iTurnType
 
boolean iContinue
 
int iRoundaboutState
 
double iTurnAngle
 
int iExitNumber
 
double iDistance
 
double iTime
 
String iFromName
 
String iFromRef
 
int iFromRoadType
 
String iToName
 
String iToRef
 
int iToRoadType
 
String iInstructions
 

Static Public Attributes

static final int TURN_NONE = 0
 
static final int TURN_AHEAD = 1
 
static final int TURN_BEAR_RIGHT = 2
 
static final int TURN_RIGHT = 3
 
static final int TURN_SHARP_RIGHT = 4
 
static final int TURN_AROUND = 5
 
static final int TURN_SHARP_LEFT = 6
 
static final int TURN_LEFT = 7
 
static final int TURN_BEAR_LEFT = 8
 
static final int ROUNDABOUT_STATE_NONE = 0
 
static final int ROUNDABOUT_STATE_ENTER = 1
 
static final int ROUNDABOUT_STATE_CONTINUE = 2
 
static final int ROUNDABOUT_STATE_EXIT = 3
 
static final int ROUNDABOUT_STATE__CONTINUE = 2
 

Detailed Description

Information about a turn from one route segment to another.

Member Function Documentation

◆ TurnCommand()

String com.cartotype.Turn.TurnCommand ( )

Returns the turn command in the language of the current locale.

Deprecated:
Use iInstructions directly.

Member Data Documentation

◆ iContinue

boolean com.cartotype.Turn.iContinue

True if this turn is a continuation of the current road and no notification is needed.

◆ iDistance

double com.cartotype.Turn.iDistance

The distance to the turn in metres.

◆ iExitNumber

int com.cartotype.Turn.iExitNumber

The junction to take, counting the current junction as 0, if this junction is part of a roundabout.

◆ iFromName

String com.cartotype.Turn.iFromName

The name of the road before the turn.

◆ iFromRef

String com.cartotype.Turn.iFromRef

The reference code (e.g., B4009) of the road before the turn.

◆ iFromRoadType

int com.cartotype.Turn.iFromRoadType

The road type of the road before the turn: bit-fields as defined in the RoadType class.

◆ iInstructions

String com.cartotype.Turn.iInstructions

Instructions for the turn, in the current locale's language.

◆ iRoundaboutState

int com.cartotype.Turn.iRoundaboutState

The roundabout state.

◆ iTime

double com.cartotype.Turn.iTime

The estimated time to the turn in seconds.

◆ iToName

String com.cartotype.Turn.iToName

The name of the road after the turn.

◆ iToRef

String com.cartotype.Turn.iToRef

The reference code (e.g., B4009) of the road after the turn.

◆ iToRoadType

int com.cartotype.Turn.iToRoadType

The road type of the road after the turn: bit-fields as defined in the RoadType class.

◆ iTurnAngle

double com.cartotype.Turn.iTurnAngle

The turn angle: 0 = straight ahead; negative = left, positive = right.

◆ iTurnType

int com.cartotype.Turn.iTurnType

The turn type: ahead, left, right, etc.

◆ ROUNDABOUT_STATE__CONTINUE

final int com.cartotype.Turn.ROUNDABOUT_STATE__CONTINUE = 2
static

This junction continues around a roundabout.

Deprecated:
: use ROUNDABOUT_STATE_CONTINUE.

◆ ROUNDABOUT_STATE_CONTINUE

final int com.cartotype.Turn.ROUNDABOUT_STATE_CONTINUE = 2
static

This junction continues around a roundabout.

◆ ROUNDABOUT_STATE_ENTER

final int com.cartotype.Turn.ROUNDABOUT_STATE_ENTER = 1
static

This junction enters a roundabout.

◆ ROUNDABOUT_STATE_EXIT

final int com.cartotype.Turn.ROUNDABOUT_STATE_EXIT = 3
static

This junction exits a roundabout.

◆ ROUNDABOUT_STATE_NONE

final int com.cartotype.Turn.ROUNDABOUT_STATE_NONE = 0
static

This junction does not involve a roundabout.

◆ TURN_AHEAD

final int com.cartotype.Turn.TURN_AHEAD = 1
static

A turn of less than 22.5 degrees left or right, unless this is a fork with two choices, in which case the turn will be bear right or bear left.

◆ TURN_AROUND

final int com.cartotype.Turn.TURN_AROUND = 5
static

This turn type is use for U-turns: turns back along the same road.

◆ TURN_BEAR_LEFT

final int com.cartotype.Turn.TURN_BEAR_LEFT = 8
static

A turn between 22.5 degrees and 67.5 degrees left. or a turn through a smaller angle which is the leftmost of a fork with two choices.

◆ TURN_BEAR_RIGHT

final int com.cartotype.Turn.TURN_BEAR_RIGHT = 2
static

A turn between 22.5 degrees and 67.5 degrees right or a turn through a smaller angle which is the rightmost of a fork with two choices.

◆ TURN_LEFT

final int com.cartotype.Turn.TURN_LEFT = 7
static

A turn between 67.5 degrees and 112.5 degrees left.

◆ TURN_NONE

final int com.cartotype.Turn.TURN_NONE = 0
static

No turn exists or is needed. This turn type is used at the start of a route.

◆ TURN_RIGHT

final int com.cartotype.Turn.TURN_RIGHT = 3
static

A turn between 67.5 degrees and 112.5 degrees right.

◆ TURN_SHARP_LEFT

final int com.cartotype.Turn.TURN_SHARP_LEFT = 6
static

A turn between 112.5 degrees and 180 degrees left.

◆ TURN_SHARP_RIGHT

final int com.cartotype.Turn.TURN_SHARP_RIGHT = 4
static

A turn between 112.5 degrees and 180 degrees right.


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