Stay organized with collections
Save and categorize content based on your preferences.
public
static
class
CircularRevealWidget.RevealInfo
extends Object
| java.lang.Object
|
| ↳ |
com.google.android.material.circularreveal.CircularRevealWidget.RevealInfo
|
RevealInfo holds three values for a circular reveal. The circular reveal is represented by two
float coordinates for the center, and one float value for the radius.
Summary
Constants |
|---|
float |
INVALID_RADIUS
Radius value representing a lack of a circular reveal clip.
|
Fields |
|---|
public
float |
centerX
View-local float coordinate for the centerX of the reveal circular reveal.
|
public
float |
centerY
View-local float coordinate for the centerY of the reveal circular reveal.
|
public
float |
radius
Float value for the radius of the reveal circular reveal, or INVALID_RADIUS.
|
Public methods |
|---|
boolean
|
isInvalid()
Returns whether this RevealInfo has an invalid radius, representing a lack of a circular
reveal clip.
|
void
|
set(CircularRevealWidget.RevealInfo other)
|
void
|
set(float centerX, float centerY, float radius)
|
Inherited methods |
|---|
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
|
Constants
INVALID_RADIUS
public static final float INVALID_RADIUS
Radius value representing a lack of a circular reveal clip.
Constant Value:
3.4028235E38
Fields
centerX
public float centerX
View-local float coordinate for the centerX of the reveal circular reveal.
centerY
public float centerY
View-local float coordinate for the centerY of the reveal circular reveal.
radius
public float radius
Float value for the radius of the reveal circular reveal, or INVALID_RADIUS.
Public constructors
RevealInfo
public RevealInfo (float centerX,
float centerY,
float radius)
| Parameters |
|---|
centerX |
float |
centerY |
float |
radius |
float |
Public methods
isInvalid
public boolean isInvalid ()
Returns whether this RevealInfo has an invalid radius, representing a lack of a circular
reveal clip.
set
public void set (float centerX,
float centerY,
float radius)
| Parameters |
|---|
centerX |
float |
centerY |
float |
radius |
float |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# CircularRevealWidget.RevealInfo\n\nSummary: [Constants](#constants) \\| [Fields](#lfields) \\| [Ctors](#pubctors) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nCircularRevealWidget.RevealInfo\n===============================\n\n\n`\npublic\nstatic\n\n\nclass\nCircularRevealWidget.RevealInfo\n`\n\n\n`\n\nextends Object\n\n\n`\n\n`\n\n\n`\n\n|---|----------------------------------------------------------------------------|\n| java.lang.Object ||\n| ↳ | com.google.android.material.circularreveal.CircularRevealWidget.RevealInfo |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nRevealInfo holds three values for a circular reveal. The circular reveal is represented by two\nfloat coordinates for the center, and one float value for the radius.\n\nSummary\n-------\n\n| ### Constants ||\n|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `float` | [INVALID_RADIUS](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#INVALID_RADIUS) Radius value representing a lack of a circular reveal clip. |\n\n| ### Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` public float` | [centerX](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#centerX) View-local float coordinate for the centerX of the reveal circular reveal. |\n| ` public float` | [centerY](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#centerY) View-local float coordinate for the centerY of the reveal circular reveal. |\n| ` public float` | [radius](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#radius) Float value for the radius of the reveal circular reveal, or [INVALID_RADIUS](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#INVALID_RADIUS). |\n\n| ### Public constructors ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ` `[RevealInfo](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#RevealInfo(float,%20float,%20float))`(float centerX, float centerY, float radius) ` |\n| ` `[RevealInfo](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#RevealInfo(com.google.android.material.circularreveal.CircularRevealWidget.RevealInfo))`(`[CircularRevealWidget.RevealInfo](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo)` other) ` |\n\n| ### Public methods ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` boolean` | ` `[isInvalid](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#isInvalid())`() ` Returns whether this RevealInfo has an invalid radius, representing a lack of a circular reveal clip. |\n| ` void` | ` `[set](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#set(com.google.android.material.circularreveal.CircularRevealWidget.RevealInfo))`(`[CircularRevealWidget.RevealInfo](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo)` other) ` |\n| ` void` | ` `[set](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#set(float,%20float,%20float))`(float centerX, float centerY, float radius) ` |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` java.lang.Object ` |-------------------|-------------------------------| | ` Object` | ` clone() ` | | ` boolean` | ` equals(Object arg0) ` | | ` void` | ` finalize() ` | | ` final Class\u003c?\u003e` | ` getClass() ` | | ` int` | ` hashCode() ` | | ` final void` | ` notify() ` | | ` final void` | ` notifyAll() ` | | ` String` | ` toString() ` | | ` final void` | ` wait(long arg0, int arg1) ` | | ` final void` | ` wait(long arg0) ` | | ` final void` | ` wait() ` | ||\n\nConstants\n---------\n\n### INVALID_RADIUS\n\n```\npublic static final float INVALID_RADIUS\n```\n\nRadius value representing a lack of a circular reveal clip.\n\n\u003cbr /\u003e\n\nConstant Value:\n\n3.4028235E38\n\n\nFields\n------\n\n### centerX\n\n```\npublic float centerX\n```\n\nView-local float coordinate for the centerX of the reveal circular reveal.\n\n\u003cbr /\u003e\n\n### centerY\n\n```\npublic float centerY\n```\n\nView-local float coordinate for the centerY of the reveal circular reveal.\n\n\u003cbr /\u003e\n\n### radius\n\n```\npublic float radius\n```\n\nFloat value for the radius of the reveal circular reveal, or [INVALID_RADIUS](/reference/com/google/android/material/circularreveal/CircularRevealWidget.RevealInfo#INVALID_RADIUS).\n\n\u003cbr /\u003e\n\nPublic constructors\n-------------------\n\n### RevealInfo\n\n```\npublic RevealInfo (float centerX, \n float centerY, \n float radius)\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-----------|----------------|\n| `centerX` | `float` \u003cbr /\u003e |\n| `centerY` | `float` \u003cbr /\u003e |\n| `radius` | `float` \u003cbr /\u003e |\n\n### RevealInfo\n\n```\npublic RevealInfo (CircularRevealWidget.RevealInfo other)\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------|------------------------------------------|\n| `other` | `CircularRevealWidget.RevealInfo` \u003cbr /\u003e |\n\nPublic methods\n--------------\n\n### isInvalid\n\n```\npublic boolean isInvalid ()\n```\n\nReturns whether this RevealInfo has an invalid radius, representing a lack of a circular\nreveal clip.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-----------|--------|\n| `boolean` | \u003cbr /\u003e |\n\n### set\n\n```\npublic void set (CircularRevealWidget.RevealInfo other)\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Parameters ||\n|---------|------------------------------------------|\n| `other` | `CircularRevealWidget.RevealInfo` \u003cbr /\u003e |\n\n### set\n\n```\npublic void set (float centerX, \n float centerY, \n float radius)\n```\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-----------|----------------|\n| `centerX` | `float` \u003cbr /\u003e |\n| `centerY` | `float` \u003cbr /\u003e |\n| `radius` | `float` \u003cbr /\u003e |"]]
