# PinConfiguration


```
public class PinConfiguration implements Parcelable
```

<br />

*** ** * ** ***

A class to configure the contents of a 3D marker.

For example:

```
map.addMarker(
 markerOptions {
   position = sanFrancisco
   style = pinConfiguration {
     backgroundColor = Color.GREEN
     borderColor = Color.GREEN
     glyph = Glyph.fromColor(Color.RED)
   }
 }
)

map.addMarker(
 markerOptions {
   position = sanFrancisco
   style = pinConfiguration {
     backgroundColor = Color.GREEN
     glyph = Glyph.fromText("S")
   }
 }
)
```

## Summary

| ### Nested types |
|---|
| `public final class https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration.Builder` Builder for `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration`. |

| ### Constants |
|---|---|
| `static final int` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#BITMAP_LENGTH_DP() = 37` |
| `static final int` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#BITMAP_WIDTH_DP() = 26` |
| `static final int` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#DEFAULT_BACKGROUND_COLOR() = -1424587` |
| `static final int` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#DEFAULT_BACKGROUND_COLOR_ABGR() = -13286422` |
| `static final int` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#DEFAULT_BORDER_COLOR() = -3857889` |
| `static final int` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#DEFAULT_BORDER_COLOR_ABGR() = -14736699` |
| `static final float` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#DEFAULT_SCALE() = 1.0f` |

| ### Public fields |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/ColorInt.html int` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#backgroundColor()` |
| `@https://developer.android.com/reference/androidx/annotation/ColorInt.html int` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#borderColor()` |
| `@https://developer.android.com/reference/androidx/annotation/Nullable.html https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/Glyph` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#glyph()` |
| `float` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#scale()` |

| ### Public constructors |
|---|
| `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#PinConfiguration()()` Default constructor for PinConfiguration. |
| `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#PinConfiguration(int,int,float,com.google.android.gms.maps3d.model.Glyph)( int backgroundColor, int borderColor, float scale, @https://developer.android.com/reference/androidx/annotation/Nullable.html https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/Glyph glyph )` Constructor for PinConfiguration with parameters for required fields. |

| ### Public methods |
|---|---|
| `static @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration.Builder` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#builder()()` Creates a builder for `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration`. |
| `boolean` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#equals(java.lang.Object)(@https://developer.android.com/reference/androidx/annotation/Nullable.html https://developer.android.com/reference/java/lang/Object.html o)` |
| `@https://developer.android.com/reference/androidx/annotation/ColorInt.html int` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#getBackgroundColor()()` The background color of the pin. |
| `@https://developer.android.com/reference/androidx/annotation/ColorInt.html int` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#getBorderColor()()` The border color of the pin. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable.html https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/Glyph` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#getGlyph()()` The glyph of the pin. |
| `float` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#getScale()()` The scale of the pin. |
| `int` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#hashCode()()` |
| `void` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#setBackgroundColor(int)(@https://developer.android.com/reference/androidx/annotation/ColorInt.html int backgroundColor)` Sets the background color of the pin. |
| `void` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#setBorderColor(int)(@https://developer.android.com/reference/androidx/annotation/ColorInt.html int borderColor)` Sets the border color of the pin. |
| `void` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#setGlyph(com.google.android.gms.maps3d.model.Glyph)(@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/Glyph glyph)` Sets the glyph of the pin. |
| `void` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#setScale(float)(float scale)` Sets the scale of the pin. |
| `void` | `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration#writeToParcel(android.os.Parcel,int)(@https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/android/os/Parcel.html out, int flags)` |

### Inherited Constants

From [android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable.html) `static final int` `https://developer.android.com/reference/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR = 1` `static final int` `https://developer.android.com/reference/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE = 1`

### Inherited methods

From [android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable.html) `abstract int` `https://developer.android.com/reference/android/os/Parcelable.html#describeContents()()`

## Constants

### BITMAP_LENGTH_DP

```
public static final int BITMAP_LENGTH_DP = 37
```

### BITMAP_WIDTH_DP

```
public static final int BITMAP_WIDTH_DP = 26
```

### DEFAULT_BACKGROUND_COLOR

```
public static final int DEFAULT_BACKGROUND_COLOR = -1424587
```

### DEFAULT_BACKGROUND_COLOR_ABGR

```
public static final int DEFAULT_BACKGROUND_COLOR_ABGR = -13286422
```

### DEFAULT_BORDER_COLOR

```
public static final int DEFAULT_BORDER_COLOR = -3857889
```

### DEFAULT_BORDER_COLOR_ABGR

```
public static final int DEFAULT_BORDER_COLOR_ABGR = -14736699
```

### DEFAULT_SCALE

```
public static final float DEFAULT_SCALE = 1.0f
```

## Public fields

### backgroundColor

```
public @ColorInt int backgroundColor
```

### borderColor

```
public @ColorInt int borderColor
```

### glyph

```
public @Nullable Glyph glyph
```

### scale

```
public float scale
```

## Public constructors

### PinConfiguration

```
public PinConfiguration()
```

Default constructor for PinConfiguration.

### PinConfiguration

```
public PinConfiguration(
    int backgroundColor,
    int borderColor,
    float scale,
    @Nullable Glyph glyph
)
```

Constructor for PinConfiguration with parameters for required fields.

| Parameters |
|---|---|
| `int backgroundColor` | The background color of the pin in ARGB format. |
| `int borderColor` | The border color of the pin in ARGB format. |
| `float scale` | The scale of the pin. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable.html https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/Glyph glyph` | The glyph of the pin. |

## Public methods

### builder

```
public static @NonNull PinConfiguration.Builder builder()
```

Creates a builder for `https://developers.google.com/maps/documentation/maps-3d/android-sdk/reference/com/google/android/gms/maps3d/model/PinConfiguration`.

### equals

```
public boolean equals(@Nullable Object o)
```

### getBackgroundColor

```
public @ColorInt int getBackgroundColor()
```

The background color of the pin.

### getBorderColor

```
public @ColorInt int getBorderColor()
```

The border color of the pin.

### getGlyph

```
public @Nullable Glyph getGlyph()
```

The glyph of the pin.

### getScale

```
public float getScale()
```

The scale of the pin.

### hashCode

```
public int hashCode()
```

### setBackgroundColor

```
public void setBackgroundColor(@ColorInt int backgroundColor)
```

Sets the background color of the pin.

### setBorderColor

```
public void setBorderColor(@ColorInt int borderColor)
```

Sets the border color of the pin.

### setGlyph

```
public void setGlyph(@NonNull Glyph glyph)
```

Sets the glyph of the pin.

### setScale

```
public void setScale(float scale)
```

Sets the scale of the pin.

### writeToParcel

```
public void writeToParcel(@NonNull Parcel out, int flags)
```