ImageView scaling TOP_CROP

AndroidImageview

Android Problem Overview


I have an ImageView which is displaying a png that has a bigger aspect ratio than that of the device (vertically speaking - meaning its longer). I want to display this while maintaining aspect ratio, matching the width of the parent, and pinning the imageview to the top of the screen.

The problem i have with using CENTER_CROP as the scale type is that it will (understandable) center the scaled image instead of aligning the top edge to the top edge f the image view.

The problem with FIT_START is that the image will fit the screen height and not fill the width.

I have solved this problem by using a custom ImageView and overriding onDraw(Canvas) and handeling this manually using the canvas; the problem with this approach is that 1) I'm worried there may be a simpler solution, 2) I am getting a VM mem exception when calling super(AttributeSet) in the constructor when trying to set a src img of 330kb when the heap has 3 mb free (with a heap size of 6 mb) and cant work out why.

Any ideas / suggestions / solutions are much welcome :)

Thanks

p.s. i thought that a solution may be to use a matrix scale type and do it myself, but that seems to to be the same or more work than my current solution!

Android Solutions


Solution 1 - Android

Ok, I have a working solution. The prompt from Darko made me look again at the ImageView class (thanks) and have applied the transformation using a Matrix (as i originally suspected but did not have success on my first attempt!). In my custom imageView class I call setScaleType(ScaleType.MATRIX) after super() in the constructor, and have the following method.

    @Override
    protected boolean setFrame(int l, int t, int r, int b)
    {
        Matrix matrix = getImageMatrix(); 
		float scaleFactor = getWidth()/(float)getDrawable().getIntrinsicWidth();	
		matrix.setScale(scaleFactor, scaleFactor, 0, 0);
		setImageMatrix(matrix);
		return super.setFrame(l, t, r, b);
	}

I have placed int in the setFrame() method as in ImageView the call to configureBounds() is within this method, which is where all the scaling and matrix stuff takes place, so seems logical to me (say if you disagree)

Below is the super.setFrame() method from the AOSP (Android Open Source Project)

    @Override
    protected boolean setFrame(int l, int t, int r, int b) {
        boolean changed = super.setFrame(l, t, r, b);
        mHaveFrame = true;
        configureBounds();
        return changed;
    }

Find the full class src here

Solution 2 - Android

Here is my code for centering it at the bottom.

BTW in Dori's Code is a little bug: Since the super.frame() is called at the very end, the getWidth() method might return the wrong value.

If you want to center it at the top simply remove the postTranslate line and you're done.

The nice thing is that with this code you can move it anywhere you want. (right, center => no problem ;)

    public class CenterBottomImageView extends ImageView {
    
    	public CenterBottomImageView(Context context) {
    		super(context);
    		setup();
    	}
    	
    	public CenterBottomImageView(Context context, AttributeSet attrs) {
    		super(context, attrs);
    		setup();
    	}
    
    	public CenterBottomImageView(Context context, AttributeSet attrs,
    			int defStyle) {
    		super(context, attrs, defStyle);
    		setup();
    	}
    	
    	private void setup() {
    		setScaleType(ScaleType.MATRIX);
    	}
    
    	@Override
        protected boolean setFrame(int frameLeft, int frameTop, int frameRight, int frameBottom) {
            if (getDrawable() == null) {
                return super.setFrame(frameLeft, frameTop, frameRight, frameBottom);
            }
    		float frameWidth = frameRight - frameLeft;
    		float frameHeight = frameBottom - frameTop;
    		
    		float originalImageWidth = (float)getDrawable().getIntrinsicWidth();
    		float originalImageHeight = (float)getDrawable().getIntrinsicHeight();
    		
    		float usedScaleFactor = 1;
    		
    		if((frameWidth > originalImageWidth) || (frameHeight > originalImageHeight)) {
    			// If frame is bigger than image
    			// => Crop it, keep aspect ratio and position it at the bottom and center horizontally
    			
    			float fitHorizontallyScaleFactor = frameWidth/originalImageWidth;
    	        float fitVerticallyScaleFactor = frameHeight/originalImageHeight;
    	        
    	        usedScaleFactor = Math.max(fitHorizontallyScaleFactor, fitVerticallyScaleFactor);
    		}
            
            float newImageWidth = originalImageWidth * usedScaleFactor;
            float newImageHeight = originalImageHeight * usedScaleFactor;
            
            Matrix matrix = getImageMatrix();
            matrix.setScale(usedScaleFactor, usedScaleFactor, 0, 0); // Replaces the old matrix completly
//comment matrix.postTranslate if you want crop from TOP
            matrix.postTranslate((frameWidth - newImageWidth) /2, frameHeight - newImageHeight);
            setImageMatrix(matrix);
            return super.setFrame(frameLeft, frameTop, frameRight, frameBottom);
        }
    
    }

Beginner tip: If it plain doesn't work, you likely have to extends androidx.appcompat.widget.AppCompatImageView rather than ImageView

Solution 3 - Android

You don't need to write a Custom Image View for getting the TOP_CROP functionality. You just need to modify the matrix of the ImageView.

  1. Set the scaleType to matrix for the ImageView:

     <ImageView
           android:id="@+id/imageView"
           android:contentDescription="Image"
           android:layout_width="match_parent"
           android:layout_height="match_parent"
           android:src="@drawable/image"
           android:scaleType="matrix"/>
    
  2. Set a custom matrix for the ImageView:

     final ImageView imageView = (ImageView) findViewById(R.id.imageView);
     final Matrix matrix = imageView.getImageMatrix();
     final float imageWidth = imageView.getDrawable().getIntrinsicWidth();
     final int screenWidth = getResources().getDisplayMetrics().widthPixels;
     final float scaleRatio = screenWidth / imageWidth;
     matrix.postScale(scaleRatio, scaleRatio);
     imageView.setImageMatrix(matrix);
    

Doing this will give you the TOP_CROP functionality.

Solution 4 - Android

This example works with images that is loaded after creation of object + some optimization. I added some comments in code that explain what's going on.

Remember to call:

imageView.setScaleType(ImageView.ScaleType.MATRIX);

or

android:scaleType="matrix"

Java source:

import com.appunite.imageview.OverlayImageView;

public class TopAlignedImageView extends ImageView {
    private Matrix mMatrix;
	private boolean mHasFrame;

    @SuppressWarnings("UnusedDeclaration")
    public TopAlignedImageView(Context context) {
        this(context, null, 0);
    }

    @SuppressWarnings("UnusedDeclaration")
    public TopAlignedImageView(Context context, AttributeSet attrs) {
        this(context, attrs, 0);
    }

    @SuppressWarnings("UnusedDeclaration")
    public TopAlignedImageView(Context context, AttributeSet attrs, int defStyle) {
        super(context, attrs, defStyle);
		mHasFrame = false;
        mMatrix = new Matrix();
		// we have to use own matrix because:
		// ImageView.setImageMatrix(Matrix matrix) will not call
		// configureBounds(); invalidate(); because we will operate on ImageView object
    }

    @Override
    protected boolean setFrame(int l, int t, int r, int b)
    {
        boolean changed = super.setFrame(l, t, r, b);
        if (changed) {
        	mHasFrame = true;
			// we do not want to call this method if nothing changed
            setupScaleMatrix(r-l, b-t);
        }
        return changed;
    }

    private void setupScaleMatrix(int width, int height) {
        if (!mHasFrame) {
			// we have to ensure that we already have frame
			// called and have width and height
            return;
        }
        final Drawable drawable = getDrawable();
        if (drawable == null) {
			// we have to check if drawable is null because
			// when not initialized at startup drawable we can
			// rise NullPointerException
            return;
        }
        Matrix matrix = mMatrix;
        final int intrinsicWidth = drawable.getIntrinsicWidth();
        final int intrinsicHeight = drawable.getIntrinsicHeight();

        float factorWidth = width/(float) intrinsicWidth;
        float factorHeight = height/(float) intrinsicHeight;
        float factor = Math.max(factorHeight, factorWidth);

		// there magic happen and can be adjusted to current
		// needs
        matrix.setTranslate(-intrinsicWidth/2.0f, 0);
        matrix.postScale(factor, factor, 0, 0);
        matrix.postTranslate(width/2.0f, 0);
        setImageMatrix(matrix);
    }

    @Override
    public void setImageDrawable(Drawable drawable) {
        super.setImageDrawable(drawable);
		// We have to recalculate image after chaning image
        setupScaleMatrix(getWidth(), getHeight());
    }

    @Override
    public void setImageResource(int resId) {
        super.setImageResource(resId);
		// We have to recalculate image after chaning image
        setupScaleMatrix(getWidth(), getHeight());
    }

    @Override
    public void setImageURI(Uri uri) {
        super.setImageURI(uri);
		// We have to recalculate image after chaning image
        setupScaleMatrix(getWidth(), getHeight());
    }
	
	// We do not have to overide setImageBitmap because it calls 
	// setImageDrawable method

}

Solution 5 - Android

Based on Dori I'm using a solution which either scales the image based on the width or height of the image to always fill the surrounding container. This allows scaling an image to fill the whole available space using the top left point of the image rather than the center as origin (CENTER_CROP):

@Override
protected boolean setFrame(int l, int t, int r, int b)
{
    
  	Matrix matrix = getImageMatrix(); 
    float scaleFactor, scaleFactorWidth, scaleFactorHeight;
    scaleFactorWidth = (float)width/(float)getDrawable().getIntrinsicWidth();
    scaleFactorHeight = (float)height/(float)getDrawable().getIntrinsicHeight();	
    
    if(scaleFactorHeight > scaleFactorWidth) {
        scaleFactor = scaleFactorHeight;
    } else {
    	scaleFactor = scaleFactorWidth;
    }
        
    matrix.setScale(scaleFactor, scaleFactor, 0, 0);
    setImageMatrix(matrix);

    return super.setFrame(l, t, r, b);
}

I hope this helps - works like a treat in my project.

Solution 6 - Android

None of these solutions worked for me, because I wanted a class that supported an arbitrary crop from either the horizontal or vertical direction, and I wanted it to allow me to change the crop dynamically. I also needed Picasso compatibility, and Picasso sets image drawables lazily.

My implementation is adapted directly from ImageView.java in the AOSP. To use it, declare like so in XML:

    <com.yourapp.PercentageCropImageView
        android:id="@+id/view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
		android:scaleType="matrix"/>

From source, if you wish to have a top crop, call:

imageView.setCropYCenterOffsetPct(0f);

If you wish to have a bottom crop, call:

imageView.setCropYCenterOffsetPct(1.0f);

If you wish to have a crop 1/3 of the way down, call:

imageView.setCropYCenterOffsetPct(0.33f);

Furthermore, if you elect to use another crop method, like fit_center, you may do so and none of this custom logic will be triggered. (Other implementations ONLY let you use their cropping methods).

Lastly, I added a method, redraw(), so if you elect to change your crop method/scaleType dynamically in code, you can force the view to redraw. For example:

fullsizeImageView.setScaleType(ScaleType.FIT_CENTER);
fullsizeImageView.redraw();

To go back to your custom top-center-third crop, call:

fullsizeImageView.setScaleType(ScaleType.MATRIX);
fullsizeImageView.redraw();

Here is the class:

/* 
 * Adapted from ImageView code at: 
 * http://grepcode.com/file/repository.grepcode.com/java/ext/com.google.android/android/4.4.4_r1/android/widget/ImageView.java
 */
import android.content.Context;
import android.graphics.Matrix;
import android.graphics.drawable.Drawable;
import android.util.AttributeSet;
import android.widget.ImageView;

public class PercentageCropImageView extends ImageView{

	private Float mCropYCenterOffsetPct;
	private Float mCropXCenterOffsetPct;

	public PercentageCropImageView(Context context) {
		super(context);
	}

	public PercentageCropImageView(Context context, AttributeSet attrs) {
		super(context, attrs);
	}

	public PercentageCropImageView(Context context, AttributeSet attrs,
			int defStyle) {
		super(context, attrs, defStyle);
	}

	public float getCropYCenterOffsetPct() {
		return mCropYCenterOffsetPct;
	}

	public void setCropYCenterOffsetPct(float cropYCenterOffsetPct) {
		if (cropYCenterOffsetPct > 1.0) {
			throw new IllegalArgumentException("Value too large: Must be <= 1.0");
		}
		this.mCropYCenterOffsetPct = cropYCenterOffsetPct;
	}

	public float getCropXCenterOffsetPct() {
		return mCropXCenterOffsetPct;
	}

	public void setCropXCenterOffsetPct(float cropXCenterOffsetPct) {
		if (cropXCenterOffsetPct > 1.0) {
			throw new IllegalArgumentException("Value too large: Must be <= 1.0");
		}
		this.mCropXCenterOffsetPct = cropXCenterOffsetPct;
	}

	private void myConfigureBounds() {
		if (this.getScaleType() == ScaleType.MATRIX) {
			/*
			 * Taken from Android's ImageView.java implementation:
			 * 
			 * Excerpt from their source:
	} else if (ScaleType.CENTER_CROP == mScaleType) {
	   mDrawMatrix = mMatrix;
	
	   float scale;
	   float dx = 0, dy = 0;
	
	   if (dwidth * vheight > vwidth * dheight) {
	       scale = (float) vheight / (float) dheight; 
	       dx = (vwidth - dwidth * scale) * 0.5f;
	   } else {
	       scale = (float) vwidth / (float) dwidth;
	       dy = (vheight - dheight * scale) * 0.5f;
	   }
	
	   mDrawMatrix.setScale(scale, scale);
	   mDrawMatrix.postTranslate((int) (dx + 0.5f), (int) (dy + 0.5f));
	}
			 */
	
			Drawable d = this.getDrawable();
			if (d != null) {
				int dwidth = d.getIntrinsicWidth();
				int dheight = d.getIntrinsicHeight();
		
				Matrix m = new Matrix();
		
				int vwidth = getWidth() - this.getPaddingLeft() - this.getPaddingRight();
				int vheight = getHeight() - this.getPaddingTop() - this.getPaddingBottom();
		
				float scale;
				float dx = 0, dy = 0;
		
				if (dwidth * vheight > vwidth * dheight) {
					float cropXCenterOffsetPct = mCropXCenterOffsetPct != null ? 
							mCropXCenterOffsetPct.floatValue() : 0.5f;
					scale = (float) vheight / (float) dheight;
					dx = (vwidth - dwidth * scale) * cropXCenterOffsetPct;
				} else {
					float cropYCenterOffsetPct = mCropYCenterOffsetPct != null ? 
							mCropYCenterOffsetPct.floatValue() : 0f;

					scale = (float) vwidth / (float) dwidth;
					dy = (vheight - dheight * scale) * cropYCenterOffsetPct;
				}
		
				m.setScale(scale, scale);
				m.postTranslate((int) (dx + 0.5f), (int) (dy + 0.5f));
		
				this.setImageMatrix(m);
			}
		}
	}

	// These 3 methods call configureBounds in ImageView.java class, which
	// adjusts the matrix in a call to center_crop (android's built-in 
	// scaling and centering crop method). We also want to trigger
	// in the same place, but using our own matrix, which is then set
	// directly at line 588 of ImageView.java and then copied over
	// as the draw matrix at line 942 of ImageVeiw.java
	@Override
	protected boolean setFrame(int l, int t, int r, int b) {
		boolean changed = super.setFrame(l, t, r, b);
		this.myConfigureBounds();
		return changed;
	}
	@Override
	public void setImageDrawable(Drawable d) {	    	
		super.setImageDrawable(d);
		this.myConfigureBounds();
	}
	@Override
	public void setImageResource(int resId) {	    	
		super.setImageResource(resId);
		this.myConfigureBounds();
	}
	
	public void redraw() {
		Drawable d = this.getDrawable();

		if (d != null) {
			// Force toggle to recalculate our bounds
			this.setImageDrawable(null);
			this.setImageDrawable(d);
		}
	}
}

Solution 7 - Android

Maybe go into the source code for the image view on android and see how it draws the center crop etc.. and maybe copy some of that code into your methods. i don't really know for a better solution than doing this. i have experience manually resizing and cropping the bitmap (search for bitmap transformations) which reduces its actual size but it still creates a bit of an overhead in the process.

Solution 8 - Android

public class ImageViewTopCrop extends ImageView {
public ImageViewTopCrop(Context context) {
    super(context);
    setScaleType(ScaleType.MATRIX);
}

public ImageViewTopCrop(Context context, AttributeSet attrs) {
    super(context, attrs);
    setScaleType(ScaleType.MATRIX);
}

public ImageViewTopCrop(Context context, AttributeSet attrs, int defStyle) {
    super(context, attrs, defStyle);
    setScaleType(ScaleType.MATRIX);
}

@Override
protected boolean setFrame(int l, int t, int r, int b) {
    computMatrix();
    return super.setFrame(l, t, r, b);
}

@Override
protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
    super.onLayout(changed, left, top, right, bottom);
    computMatrix();
}

private void computMatrix() {
    Matrix matrix = getImageMatrix();
    float scaleFactor = getWidth() / (float) getDrawable().getIntrinsicWidth();
    matrix.setScale(scaleFactor, scaleFactor, 0, 0);
    setImageMatrix(matrix);
}

}

Solution 9 - Android

If you are using Fresco (SimpleDraweeView) you can easily do it with:

 PointF focusPoint = new PointF(0.5f, 0f);
 imageDraweeView.getHierarchy().setActualImageFocusPoint(focusPoint);

This one would be for a top crop.

More info at Reference Link

Solution 10 - Android

There are 2 problems with the solutions here:

  • They do not render in the Android Studio layout editor (so you can preview on various screen sizes and aspect ratios)
  • It only scales by width, so depending on the aspect ratios of the device and the image, you can end up with an empty strip on the bottom

This small modification fixes the problem (place code in onDraw, and check width and height scale factors):

@Override
protected void onDraw(Canvas canvas) {

    Matrix matrix = getImageMatrix();

    float scaleFactorWidth = getWidth() / (float) getDrawable().getIntrinsicWidth();
    float scaleFactorHeight = getHeight() / (float) getDrawable().getIntrinsicHeight();

    float scaleFactor = (scaleFactorWidth > scaleFactorHeight) ? scaleFactorWidth : scaleFactorHeight;

    matrix.setScale(scaleFactor, scaleFactor, 0, 0);
    setImageMatrix(matrix);

    super.onDraw(canvas);
}

Solution 11 - Android

Simplest Solution: Clip the image

 @Override
    public void draw(Canvas canvas) {
        if(getWidth() > 0){
            int clipHeight = 250;
            canvas.clipRect(0,clipHeight,getWidth(),getHeight());
         }
        super.draw(canvas);
    }

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionDoriView Question on Stackoverflow
Solution 1 - AndroidDoriView Answer on Stackoverflow
Solution 2 - AndroidMajorBreakfastView Answer on Stackoverflow
Solution 3 - AndroidHenryView Answer on Stackoverflow
Solution 4 - AndroidJacek MarchwickiView Answer on Stackoverflow
Solution 5 - AndroidMattView Answer on Stackoverflow
Solution 6 - AndroidesilverView Answer on Stackoverflow
Solution 7 - AndroidDArkOView Answer on Stackoverflow
Solution 8 - AndroidtianxiaView Answer on Stackoverflow
Solution 9 - AndroidfxherengView Answer on Stackoverflow
Solution 10 - AndroidOldSchool4664View Answer on Stackoverflow
Solution 11 - AndroidM. Usman KhanView Answer on Stackoverflow