Skip to content

Refactor code (Make comments looks more cleaner.) #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Marvel999 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Refactor code (Make comments looks more cleaner.) #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
821c2c2
Refactor code (Make comments looks more cleaner.)
Marvel999 Jan 26, 2022
f093726
Merge branch 'main' into Marvel999/Refactor_carouselrecyclerview
Marvel999 Jan 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 77 additions & 68 deletions ...cyclerview/src/main/java/com/jackandphantom/carouselrecyclerview/CarouselLayoutManager.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ import kotlin.math.sqrt
class CarouselLayoutManager constructor(
isLoop: Boolean, isItem3D: Boolean, ratio: Float, flat: Boolean, alpha: Boolean, isScrollingEnabled: Boolean)
: RecyclerView.LayoutManager() {

/**
* We are supposing that all the items in recyclerview will have same size
* Decorated child view width
Expand All @@ -30,10 +29,10 @@ class CarouselLayoutManager constructor(
/** Initially position of an item (x coordinates) */
private var mStartX = 0

/** items Sliding offset */
/** Items Sliding offset */
private var mOffsetAll = 0

/** interval ratio is how much portion of a view will show */
/** Interval ratio is how much portion of a view will show */
private var intervalRatio = 0.5f

/** Cached all required items in rect object (left, top, right, bottom) */
Expand All @@ -42,31 +41,31 @@ class CarouselLayoutManager constructor(
/** Cache those items which are currently attached to the screen */
private val mHasAttachedItems = SparseBooleanArray()

/** animator animate the items in layout manager */
private var animator:ValueAnimator?= null
/** Animator animate the items in layout manager */
private var animator: ValueAnimator? = null

/** Store recycler so that we can use it in [scrollToPosition]*/
private lateinit var recycler: RecyclerView.Recycler

/** Store state so that we use in scrolling [scrollToPosition] */
private lateinit var state: RecyclerView.State

/** set infinite loop of items in the layout manager if true */
/** Set infinite loop of items in the layout manager if true */
private var mInfinite = false

/** set tilt of items in layout manager if true */
/** Set tilt of items in layout manager if true */
private var is3DItem = false

/** set flat each item if true */
/** Set flat each item if true */
private var isFlat = false

/** set alpha based on the position of items in layout manager if true */
/** Set alpha based on the position of items in layout manager if true */
private var isAlpha = false

/** interface for the selected item or middle item in the layout manager */
/** Interface for the selected item or middle item in the layout manager */
private var mSelectedListener: OnSelected? = null

/** selected position of layout manager (center item)*/
/** Selected position of layout manager (center item)*/
private var selectedPosition: Int = 0

/** Previous item which was in center in layout manager */
Expand All @@ -75,7 +74,7 @@ class CarouselLayoutManager constructor(
/** Use for restore scrolling in recyclerview at the time of orientation change*/
private var isOrientationChange = false

/** set to enable/disable scrolling in recyclerview */
/** Set to enable/disable scrolling in recyclerview */
private var isScrollingEnabled = true

/** Initialize all the attribute from the constructor and also apply some conditions */
Expand All @@ -90,10 +89,10 @@ class CarouselLayoutManager constructor(
}

companion object {
/**Item moves to right */
/** Item moves to right */
private const val SCROLL_TO_RIGHT = 1

/**Items moves to left */
/** Items moves to left */
private const val SCROLL_TO_LEFT = 2

/**
Expand Down Expand Up @@ -125,7 +124,7 @@ class CarouselLayoutManager constructor(
if (state == null || recycler == null)
return

/** check item count and pre layout state of the layout manager*/
/** Check item count and pre layout state of the layout manager **/
if (state.itemCount <= 0 || state.isPreLayout) {
mOffsetAll = 0
return
Expand All @@ -144,8 +143,10 @@ class CarouselLayoutManager constructor(

var offset = mStartX

//Start from the center of the recyclerview
//Save only specific item position
/**
* Start from the center of the recyclerview
* Save only specific item position
*/
var i = 0
while (i < itemCount && i < MAX_RECT_COUNT) {
var frame = mAllItemsFrames[i]
Expand All @@ -172,9 +173,10 @@ class CarouselLayoutManager constructor(
this.state = state
}

/** Method tell recyclerview that layout manager will act on horizontally scroll
/**
* Method tell recyclerview that layout manager will act on horizontally scroll
* @return return boolean value to tell recyclerview for scroll handling with horizontal direction
* */
*/
override fun canScrollHorizontally(): Boolean {

return isScrollingEnabled
Expand All @@ -199,13 +201,13 @@ class CarouselLayoutManager constructor(

var travel = dx

if (!mInfinite) {
if (dx + mOffsetAll < 0) {
travel = - mOffsetAll
}else if (dx + mOffsetAll > maxOffset()) {
travel = (maxOffset() - mOffsetAll)
}
}
if (!mInfinite) {
if (dx + mOffsetAll < 0) {
travel = -mOffsetAll
} else if (dx + mOffsetAll > maxOffset()) {
travel = (maxOffset() - mOffsetAll)
}
}
mOffsetAll += travel
layoutItems(recycler, state, if (dx > 0) SCROLL_TO_LEFT else SCROLL_TO_RIGHT)
return travel
Expand All @@ -223,7 +225,7 @@ class CarouselLayoutManager constructor(
) {

if (state.isPreLayout) return
//calculate current display area for showing views
/** Calculate current display area for showing views */
val displayFrames = Rect(
mOffsetAll,
0,
Expand All @@ -237,18 +239,18 @@ class CarouselLayoutManager constructor(
//get position from tag class define later
val tag = checkTAG(child.tag)
tag!!.pos
}else {
} else {
getPosition(child)
}

val rect = getFrame(position)

//Now check item is in the display area, if not recycle that item
/** Now check item is in the display area, if not recycle that item */
if (!Rect.intersects(displayFrames, rect)) {
removeAndRecycleView(child, recycler)
mHasAttachedItems.delete(position)
}else {
//Shift the item which has still in the screen
} else {
/** Shift the item which has still in the screen */
layoutItem(child, rect)
mHasAttachedItems.put(position, true)
}
Expand All @@ -262,32 +264,35 @@ class CarouselLayoutManager constructor(

if (!mInfinite) {
if (min < 0) min = 0
if (max > itemCount ) max = itemCount
if (max > itemCount) max = itemCount
}

for (index in min until max) {
val rect = getFrame(index)
//layout items area of a view if it's first inside the display area
// and also not already on the screen
if (Rect.intersects(displayFrames, rect) && !mHasAttachedItems.get(
index
)) {
var actualPos = index % itemCount
if (actualPos < 0) actualPos += itemCount

val scrap = recycler.getViewForPosition(actualPos)
checkTAG(scrap.tag)
scrap.tag = TAG(index)
measureChildWithMargins(scrap, 0, 0)

if (scrollToDirection == SCROLL_TO_RIGHT) {
addView(scrap, 0)
} else addView(scrap)

layoutItem(scrap, rect)
mHasAttachedItems.put(index, true)
}
}
/**
* Layout items area of a view if it's first inside the display area
* and also not already on the screen
**/
if (Rect.intersects(displayFrames, rect) && !mHasAttachedItems.get(
index
)
) {
var actualPos = index % itemCount
if (actualPos < 0) actualPos += itemCount

val scrap = recycler.getViewForPosition(actualPos)
checkTAG(scrap.tag)
scrap.tag = TAG(index)
measureChildWithMargins(scrap, 0, 0)

if (scrollToDirection == SCROLL_TO_RIGHT) {
addView(scrap, 0)
} else addView(scrap)

layoutItem(scrap, rect)
mHasAttachedItems.put(index, true)
}
}

}

Expand Down Expand Up @@ -321,12 +326,13 @@ class CarouselLayoutManager constructor(
* tilt others views based on the drawing order
*/
private fun itemRotate(child: View, frame: Rect) {
val itemCenter = (frame.left + frame.right - 2*mOffsetAll) / 2f
var value = (itemCenter - (mStartX + mItemDecoratedWidth / 2f)) * 1f / (itemCount*getIntervalDistance())
val itemCenter = (frame.left + frame.right - 2 * mOffsetAll) / 2f
var value =
(itemCenter - (mStartX + mItemDecoratedWidth / 2f)) * 1f / (itemCount * getIntervalDistance())
value = sqrt(abs(value).toDouble()).toFloat()
val symbol =
if (itemCenter > mStartX + mItemDecoratedWidth / 2f) (-1).toFloat() else 1.toFloat()
child.rotationY = symbol * 50* abs(value)
child.rotationY = symbol * 50 * abs(value)

}

Expand Down Expand Up @@ -373,7 +379,7 @@ class CarouselLayoutManager constructor(
val direction = if (from < to) SCROLL_TO_LEFT else SCROLL_TO_RIGHT

animator = ValueAnimator.ofFloat(from * 1.0f, to * 1.0f)
animator?.duration= 500
animator?.duration = 500
animator?.interpolator = DecelerateInterpolator()

animator?.addUpdateListener { animation ->
Expand Down Expand Up @@ -412,7 +418,8 @@ class CarouselLayoutManager constructor(
return
}
mOffsetAll = calculatePositionOffset(position)
layoutItems(recycler,
layoutItems(
recycler,
state,
if (position > selectedPosition) SCROLL_TO_LEFT
else SCROLL_TO_RIGHT
Expand All @@ -433,7 +440,7 @@ class CarouselLayoutManager constructor(
position: Int
) {
//Loop does not support for smooth scrolling
if (mInfinite||!this::recycler.isInitialized || !this::state.isInitialized) return
if (mInfinite || !this::recycler.isInitialized || !this::state.isInitialized) return
val finalOffset = calculatePositionOffset(position)
startScroll(mOffsetAll, finalOffset)
}
Expand Down Expand Up @@ -465,7 +472,7 @@ class CarouselLayoutManager constructor(
if (child!!.tag != null) {
val tag = checkTAG(child.tag)
if (tag != null)
return tag.pos
return tag.pos
}
return getPosition(child)
}
Expand All @@ -477,10 +484,10 @@ class CarouselLayoutManager constructor(
return if (tag != null) {
if (tag is TAG) {
tag as TAG
}else {
} else {
throw IllegalArgumentException("You should use the set tag with the position")
}
}else {
} else {
null
}

Expand Down Expand Up @@ -549,8 +556,10 @@ class CarouselLayoutManager constructor(
selectedPosition = ((mOffsetAll / getIntervalDistance()).toFloat()).roundToInt()
if (selectedPosition < 0) selectedPosition += itemCount
selectedPosition = abs(selectedPosition % itemCount)
//check if the listener is implemented
//mLastSelectedPosition keeps track of last position which will prevent simple slide and same position
/**
* Check if the listener is implemented
* mLastSelectedPosition keeps track of last position which will prevent simple slide and same position
**/
if (mSelectedListener != null && selectedPosition != mLastSelectedPosition) {
mSelectedListener!!.onItemSelected(selectedPosition)
}
Expand Down Expand Up @@ -634,12 +643,12 @@ class CarouselLayoutManager constructor(
/**
* Calculate the maximum offset
*/
private fun maxOffset(): Int{
private fun maxOffset(): Int {
return ((itemCount - 1) * getIntervalDistance())
}

/**
* set the selected listener (interface)
* Set the selected listener (interface)
*/
fun setOnSelectedListener(l: OnSelected) {
this.mSelectedListener = l
Expand All @@ -662,7 +671,7 @@ class CarouselLayoutManager constructor(
private var isAlpha = false
private var isScrollingEnabled = true

fun setIsInfinite(isInfinite: Boolean) : Builder {
fun setIsInfinite(isInfinite: Boolean): Builder {
this.isInfinite = isInfinite
return this
}
Expand Down Expand Up @@ -720,7 +729,7 @@ class CarouselLayoutManager constructor(
}
}

class SaveState constructor(var scrollPosition:Int = 0) : Parcelable {
class SaveState constructor(var scrollPosition: Int = 0) : Parcelable {

constructor(parcel: Parcel) : this() {
scrollPosition = parcel.readInt()
Expand Down
Loading