ZoomApi

AbsolutePan

Annotation to indicate an AbsolutePan value.

Alignment

Defines the available alignments

RealZoom

Annotation to indicate a RealZoom value.

ScaledPan

Annotation to indicate a ScaledPan value.

Transformation

Defines the available transformation types

Zoom

Annotation to indicate a zoom value.

ZoomType

Defines the available zoom types

pan

The current pan as an AbsolutePoint.

panX

Returns the current horizontal pan value, in content absolute coordinates (that is, as if there was no zoom at all).

panY

Returns the current vertical pan value, in content absolute coordinates (that is, as if there was no zoom at all).

realZoom

Gets the current zoom value, including the base zoom that was eventually applied when initializing to respect the "center inside" policy. This will match the scaleX - scaleY values you get into the Matrix, and is the actual scale value of the content from its original size.

scaledPan

The current pan as a ScaledPoint, that is, taking into account the current zoom. This basically returns the pan value multiplied by the current realZoom.

scaledPanX

Returns the current horizontal pan value, in content scaled coordinates (that is, including the current zoom). This is equivalent to panX multiplied by realZoom.

scaledPanY

Returns the current vertical pan value, in content scaled coordinates (that is, including the current zoom). This is equivalent to panY multiplied by realZoom.

zoom

Gets the current zoom value, which can be used as a reference when calling ZoomApi.zoomTo or ZoomApi.zoomBy.

cancelAnimations

Cancels all currently active animations triggered by either API calls with animate = true or touch input flings. If no animation is currently active this is a no-op.

getMaxZoom

Get the currently allowed max zoom. If ZoomApi.setOverPinchable is set to true, this can be over-pinched for a brief time.

getMaxZoomType

Get the currently set max zoom type.

getMinZoom

Get the currently allowed min zoom. If ZoomApi.setOverPinchable is set to true, this can be over-pinched for a brief time.

getMinZoomType

Get the currently set min zoom type.

moveTo

A low level API that can animate both zoom and pan at the same time. Zoom might not be the actual matrix scale, see ZoomApi.zoom and ZoomApi.realZoom. The coordinates are referred to the content size so they do not depend on current zoom.

moveToCenter

Moves to the center of the content.

panBy

Pans the content by the given quantity in dx-dy values. These are referred to the content size so they do not depend on current zoom.

panTo

Pans the content until the top-left coordinates match the given x-y values. These are referred to the content size so they do not depend on current zoom.

realZoomTo

Animates the actual matrix zoom to the given value.

setAlignment

Sets the content alignment. Can be any of the constants defined in com.otaliastudios.zoom.Alignment. The content will be aligned and forced to the specified side of the container. Defaults to ALIGNMENT_DEFAULT.

setAllowFlingInOverscroll

Controls whether fling events are allowed when the view is in an overscrolled state.

setAnimationDuration

Sets the duration of animations triggered by zoom and pan APIs. Defaults to ZoomEngine.DEFAULT_ANIMATION_DURATION.

setFlingEnabled

Controls whether fling gesture is enabled or not.

setHorizontalPanEnabled

Controls whether horizontal panning using gestures is enabled.

setMaxZoom

Which is the max zoom that should be allowed. If ZoomApi.setOverPinchable is set to true, this can be over-pinched for a brief time.

setMinZoom

Which is the min zoom that should be allowed. If ZoomApi.setOverPinchable is set to true, this can be over-pinched for a brief time.

setOneFingerScrollEnabled

Controls whether one finger scroll gesture is enabled or not.

setOverPanRange

Set the OverPanRangeProvider that specifies the amount of overpan to allow.

setOverPinchable

Controls whether the content should be overPinchable. If it is, pinch events can change the zoom outside the safe bounds, than return to safe values.

setOverScrollHorizontal

Controls whether the content should be over-scrollable horizontally. If it is, drag and fling horizontal events can scroll the content outside the safe area, then return to safe values.

setOverScrollVertical

Controls whether the content should be over-scrollable vertically. If it is, drag and fling vertical events can scroll the content outside the safe area, then return to safe values.

setOverZoomRange

Set the OverZoomRangeProvider that specifies the amount of overzoom to allow.

setScrollEnabled

Controls whether scroll gesture is enabled or not.

setThreeFingersScrollEnabled

Controls whether three fingers scroll gesture is enabled or not.

setTransformation

Sets the base transformation to be applied to the content. See setTransformation.

Sets the base transformation to be applied to the content. Defaults to TRANSFORMATION_CENTER_INSIDE with android.view.Gravity.CENTER, which means that the content will be zoomed so that it fits completely inside the container.

setTwoFingersScrollEnabled

Controls whether two fingers scroll gesture is enabled or not.

setVerticalPanEnabled

Controls whether vertical panning using gestures is enabled.

setZoomEnabled

Controls whether zoom using pinch gesture is enabled or not.

zoomBy

Applies the given factor to the current zoom.

zoomIn

Applies a small, animated zoom-in.

zoomOut

Applies a small, animated zoom-out.

zoomTo

Zooms to the given scale. This might not be the actual matrix zoom, see ZoomApi.zoom and ZoomApi.realZoom.

ALIGNMENT_DEFAULT

The default value for setAlignment.

MAX_ZOOM_DEFAULT

The default setMaxZoom applied by the engine if none is specified.

MAX_ZOOM_DEFAULT_TYPE

The default setMaxZoom type applied by the engine if none is specified.

MIN_ZOOM_DEFAULT

The default setMinZoom applied by the engine if none is specified.

MIN_ZOOM_DEFAULT_TYPE

The default setMinZoom type applied by the engine if none is specified.

TRANSFORMATION_CENTER_CROP

Constant for ZoomApi.setTransformation. The content will be zoomed so that its smaller side fits exactly inside the container. The larger side will be partially cropped.

TRANSFORMATION_CENTER_INSIDE

Constant for ZoomApi.setTransformation. The content will be zoomed so that it fits completely inside the container.

TRANSFORMATION_GRAVITY_AUTO

Constant for ZoomApi.setTransformation gravity. This means that the gravity will be inferred from the alignment or fallback to a reasonable default.

TRANSFORMATION_NONE

Constant for ZoomApi.setTransformation. No transformation will be applied, which means that both ZoomApi.zoom and ZoomApi.realZoom will return the same value.

TYPE_REAL_ZOOM

Flag for zoom constraints and settings. With ZoomApi.TYPE_REAL_ZOOM the constraint is measured over the zoom in ZoomApi.realZoom, which is the actual scale you get in the matrix.

TYPE_ZOOM

Flag for zoom constraints and settings. With ZoomApi.TYPE_ZOOM the constraint is measured over the zoom in ZoomApi.zoom. This is not the actual matrix scale value.

ZoomEngine

A low level class that listens to touch events and posts zoom and pan updates. The most useful output is a Matrix that can be used to do pretty much everything, from canvas drawing to View hierarchies translations.

ZoomImageView

Uses ZoomEngine to allow zooming and pan events to the inner drawable.

ZoomLayout

Uses ZoomEngine to allow zooming and pan events onto a view hierarchy. The hierarchy must be contained in a single view, added to this layout (like what you do with a ScrollView).

ZoomSurfaceView

Uses ZoomEngine to allow zooming and pan events onto a GL rendered surface.