Skip to content

Latest commit

 

History

History
111 lines (91 loc) · 4.54 KB

README.md

File metadata and controls

111 lines (91 loc) · 4.54 KB
Raw

PhysicsLayout

Android layout that simulates physics using JBox2D. Simply add views, enable physics, and watch them fall!

See it in action with the sample app:

Google Play

Maven Central

Gradle

dependencies {
    implementation("com.jawnnypoo:physicslayout:latest.release.here")
}

Basic Usage

If you want to see what your layout looks like when physics is applied to it, simply change your root layout to a physics layout.

<com.jawnnypoo.physicslayout.PhysicsLinearLayout
  android:id="@+id/physics_layout"
  android:layout_width="match_parent"
  android:layout_height="200dp">
            
      <ImageView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:src="@drawable/ic_launcher"/>

      <ImageView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:src="@drawable/ic_launcher"/>
              
      <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello world, I have physics!"/>
            
</com.jawnnypoo.physicslayout.PhysicsLinearLayout>

Custom XML Attributes

You can also further customize the behaviour of your PhysicsLayout

<com.jawnnypoo.physicslayout.PhysicsLinearLayout
  android:id="@+id/physics_layout"
  android:layout_width="match_parent"
  android:layout_height="200dp"
  app:physics="true"
  app:gravityX="0.0"
  app:gravityY="9.8"
  app:bounds="true"
  app:boundsSize="50dp"/>
  • physics boolean, Determines if physics will be applied to the layout (Default true)
  • gravityX float, Sets the gravity in the X direction (positive is right, negative is left) (Default 0)
  • gravityY float, Sets the gravity in the Y direction (positive is down, negative is up) (Default 9.8)
  • bounds boolean, Determines if the layout should have bounds on the edges of itself (Default true)
  • boundsSize dimenstion, Sets the width/height of the bounds on the edges (Default 20dp)

Custom Physics Configuration

Each view contained within the layout has a physics configuration that it uses to create itself in the Box2D world. This defines its shape, mass, restitutaion, and other physics related variables. A custom configuration can be applied to each view as well:

<TextView
  android:id="@+id/text"
  android:layout_width="20dp"
  android:layout_height="20dp"
  app:layout_shape="circle"
  app:layout_circleRadius="20dp"
  app:layout_bodyType="kinematic"
  app:layout_fixedRotation="true"
  app:layout_friction="0.8"
  app:layout_restitution="0.3"
  app:layout_density="0.5" />

or alternatively, the Physics definition can be made programmatically:

val circleView = findViewById<View>(R.id.circle)
val config = PhysicsConfig(
    shape = Shape.CIRCLE,
    fixtureDef = fixtureDef,
    bodyDef = bodyDef
)
Physics.setPhysicsConfig(circleView, config)

This is useful especially if you have view that would be considered circular, as the default for all views is a RECTANGLE shape. Most of the time, if you are just dealing with rectangular views, the defaults will work for you and you will not have to worry about this.

Check out the sample app to see most of these things in action.

Making a Game?

This library was designed with the intention of allowing for playful animations within normal Android apps. It is not built to be a game engine or meant to compete with the likes. If you are looking to do more intense mobile games, we recommend libraries such as libGDX or Unity

License

Copyright 2024 John Carlson

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.