com.mapbox.mapboxsdk.camera

Class CameraPosition.Builder

java.lang.Object

com.mapbox.mapboxsdk.camera.CameraPosition.Builder

Enclosing class:

CameraPosition

public static final class CameraPosition.Builder
extends java.lang.Object

Builder for composing CameraPosition objects.

Constructor Summary

Constructors

Constructor and Description
Builder() Create an empty builder.
Builder(CameraPosition previous) Create a builder with an existing CameraPosition data.
Builder(com.mapbox.mapboxsdk.camera.CameraUpdateFactory.CameraPositionUpdate update) Create a builder from an existing CameraPositionUpdate update.
Builder(com.mapbox.mapboxsdk.camera.CameraUpdateFactory.ZoomUpdate update) Create builder from an existing CameraPositionUpdate update.
Builder(android.content.res.TypedArray typedArray) Create a builder with an existing CameraPosition data.

Method Summary

Modifier and Type	Method and Description
CameraPosition.Builder	bearing(double bearing) Sets the direction that the camera is pointing in, in degrees clockwise from north.
CameraPosition	build() Builds the CameraPosition.
CameraPosition.Builder	padding(double[] padding) Padding in pixels that shifts the viewport by the specified amount.
CameraPosition.Builder	padding(double left, double top, double right, double bottom) Padding in pixels that shifts the viewport by the specified amount.
CameraPosition.Builder	target(LatLng location) Sets the location where the camera is pointing at.
CameraPosition.Builder	tilt(double tilt) Set the tilt of the camera in degrees
CameraPosition.Builder	zoom(double zoom) Set the zoom of the camera

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Create an empty builder.

Builder

public Builder(@Nullable
               CameraPosition previous)

Create a builder with an existing CameraPosition data.

Parameters:

previous - Existing CameraPosition values to use

Builder

public Builder(@Nullable
               android.content.res.TypedArray typedArray)

Create a builder with an existing CameraPosition data.

Parameters:

typedArray - TypedArray containing attribute values

Builder

public Builder(@Nullable
               com.mapbox.mapboxsdk.camera.CameraUpdateFactory.CameraPositionUpdate update)

Create a builder from an existing CameraPositionUpdate update.

Parameters:

update - Update containing camera options

Builder

public Builder(@Nullable
               com.mapbox.mapboxsdk.camera.CameraUpdateFactory.ZoomUpdate update)

Create builder from an existing CameraPositionUpdate update.

Parameters:

update - Update containing camera options

Method Detail

bearing

@NonNull
public CameraPosition.Builder bearing(double bearing)

Sets the direction that the camera is pointing in, in degrees clockwise from north.

Parameters:

bearing - Bearing

Returns:

this

target

@NonNull
public CameraPosition.Builder target(LatLng location)

Sets the location where the camera is pointing at.

Parameters:

location - target of the camera

Returns:

this

tilt

@NonNull
public CameraPosition.Builder tilt(@FloatRange(from=0.0,to=60.0)
                                            double tilt)

Set the tilt of the camera in degrees

value is clamped to MapboxConstants.MINIMUM_TILT and MapboxConstants.MAXIMUM_TILT.

Parameters:

tilt - Tilt value of the camera

Returns:

this

zoom

@NonNull
public CameraPosition.Builder zoom(@FloatRange(from=0.0,to=25.5)
                                            double zoom)

Set the zoom of the camera

Zoom ranges from MapboxConstants.MINIMUM_ZOOM to MapboxConstants.MAXIMUM_ZOOM

Parameters:

zoom - Zoom value of the camera

Returns:

this

padding

@NonNull
public CameraPosition.Builder padding(@Size(value=4L)
                                               double[] padding)

Padding in pixels that shifts the viewport by the specified amount. Applied padding is going to persist and impact following camera transformations.

Specified in left, top, right, bottom order.

Parameters:

padding - Camera padding

Returns:

this

padding

@NonNull
public CameraPosition.Builder padding(double left,
                                               double top,
                                               double right,
                                               double bottom)

Padding in pixels that shifts the viewport by the specified amount. Applied padding is going to persist and impact following camera transformations.

Specified in left, top, right, bottom order.

Returns:

this

build

public CameraPosition build()

Builds the CameraPosition.

Returns:

CameraPosition