Git Product home page Git Product logo

chompprogressview's Introduction

Chomp Progress View

Android Arsenal

A (semi) realistic chomping progress view that takes bites out of your delicious images! Nom! Nom!

  • Increment progress.
  • Change bite size.
  • Select a bite direction or just take random(ish) bites.
  • (semi) realistic bites taken from images set in the view (use an image with a transparent background for best effect)

ChompProgressView

ChompProgressView

Setup

To use ChompProgressView in your projects, simply add the library as a dependency to your build.

Gradle
dependencies {
  compile 'uk.co.barbuzz:chompprogressview:0.0.2'
}
Maven
<dependency>
  <groupId>uk.co.barbuzz.chompprogressview</groupId>
  <artifactId>chompprogressview</artifactId>
  <version>0.0.2</version>
  <type>pom</type>
</dependency>

Alternatively you can directly import the /library project into your Android Studio project and add it as a dependency in your build.gradle.

The library is currently configured to be built via Gradle only. It doesn't have any dependencies. :-)

  • Compiled SDK Version - marshmallow-24
  • Minimum SDK Version - >= Gingerbread-10

Usage

For more detailed code example to use the library, Please refer to the /sample app.

ChompProgressView can be added as a custom view to any layout.

<uk.co.barbuzz.chompprogressview.ChompProgressView
        android:id="@+id/chompProgressView"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:src="@drawable/pizza"
        app:biteRadius="200dp"
        app:chompProgress="0"
        app:chompMax="100"
        app:chompDirection="top"/>

You can then either set the xml parameters to configure the view or do it programmatically as follows.

ChompProgressView chompProgressView = (ChompProgressView) findViewById(R.id.chompProgressView);

chompProgressView.setImageDrawableChomp(mPizzaDrawble)
chompProgressView.setBiteRadius(400);
chompProgressView.setChompMax(100);
chompProgressView.setChompProgress(0);

Remember to use the setImageDrawableChomp(Drawable) method instead of setImageDrawable(Drawable) as this stores the orginal drawable and calculates some bite information.

The chomp direction can be changed between random bites and a specified direction as shown in the example below (RANDOM is the default). This can also be set in the view attributes xml (see above).

mChompProgressImageView.setChompDirection(ChompProgressImageView.ChompDirection.TOP);

Bite radius can be set (400 is the default) in code as follows or in the view attributes xml (see above).

mChompProgressImageView.setBiteRadius(400);

You can also reset the image and progress/bites taken by calling the following method.

chompProgressView.removeBites();

TODO

  1. Improve the overall drawing of the bite
  2. Make the takeBite() method of ChompProgressImageView more flexible with bite direction config

Thanks

This library was made after a conversation while eating free pizza at the great SW Mobile Meetup in Bristol UK. Thanks for all the pizza inspiration!

Also thanks to the noun project for providing the pizza and lolly icons (Imogen Oh & Kristin McPeak respectively)

Licence

Copyright (c) 2016 Andy Barber

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

chompprogressview's People

Contributors

andyb129 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.