oktayayr / PictureMarker

PictureMarker provides Marker creator for Google Maps Android API that can contain picture inside it

#PictureMarker

PictureMarker provides Marker for Google Map Android API that can contain picture inside it

##Features

• Marker icon can be created from a view or bitmap
• PictureMarker is density independed. You can create markers that are compatible with different device screen
• You can create markers with two different shape: Circle and Square (It is available when marker is created with a bitmap)
• You can place image with three different mode: Strech, Center Zoom and Fit (It is available when marker is created with a bitmap)

##Attributes

These attributes are used when marker icon is created from a bitmap

###Dimensions All dimension attributes are in density independed. You should set these attributes in dp

• imageSize: Determines size of image area. If marker style is square, imageSize is the side length of square area. If marker style is circle, imageSize is the diameter of circle area (Default: 25dp)
• borderWidth: Determines width of border (Default: 2dp)
• cornerRadius: Determines radius of corners (Default: 2dp)
• cursorWidth: Determines width of cursor which is at bottom of marker. It cannot be wider than imageSize (Default: half of imageSize)
• cursorHeight: Determines height of cursor which is at bottom of marker. (Default: half of imageSize)

###Colors

• borderColor: Determines color of border
• scrapAreaColor: Determines color of scrap area.

Scrap area is outside of image in image area. This area appears when given image is not compatible with image area

##Setup

###Gradle.build

dependencies {
  // jCenter
  compile 'com.oktyayr.picturemarker:picturemarker:1.0.2'
}

##Usage

###Create marker with view

  PictureMarker pm = new PictureMarker(view);
  MarkerOptions opt = pm.build();

###Create marker with bitmap

  PictureMarker pm = new PictureMarker(context,bitmap); // A context instance must be provided in order to get screen density
  MarkerOptions opt = pm.build();

###Customize marker

  PictureMarker pm = new PictureMarker(image);
  pm.setMarkerStyle(MarkerStyle.CIRCLE); // Change marker style
  pm.setImageMode(ImageMode.STRECH); // Change image mode
  pm.setImageSize(100) // Change image size (in dp)
  
  MarkerOptions opt = pm.create(context);

##Exceptions

• IllegalStateException is thrown when image and view both are set
• InvalidDimensionException is thrown when cursor width is wider than image size
• NullImageException is thrown when marker image is null
• NullImageModeException is thrown when image mode is null.
• NullMarkerStyleException is thrown when marker style is null

License

The MIT License (MIT)

Copyright (c) 2016 Oktay AYAR

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.