PathShape
public
class
PathShape
extends Shape
| java.lang.Object | ||
| ↳ | android.graphics.drawable.shapes.Shape | |
| ↳ | android.graphics.drawable.shapes.PathShape | |
Creates geometric paths, utilizing the Path class.
The path can be drawn to a Canvas with its own draw() method,
but more graphical control is available if you instead pass
the PathShape to a ShapeDrawable.
Summary
Public constructors | |
|---|---|
PathShape(Path path, float stdWidth, float stdHeight)
PathShape constructor. |
|
Public methods | |
|---|---|
PathShape
|
clone()
Creates and returns a copy of this object. |
void
|
draw(Canvas canvas, Paint paint)
Draws this shape into the provided Canvas, with the provided Paint. |
boolean
|
equals(Object o)
Indicates whether some other object is "equal to" this one. |
int
|
hashCode()
Returns a hash code value for the object. |
Protected methods | |
|---|---|
void
|
onResize(float width, float height)
Callback method called when |
Inherited methods | |
|---|---|
Public constructors
PathShape
public PathShape (Path path, float stdWidth, float stdHeight)
PathShape constructor.
| Parameters | |
|---|---|
path |
Path: a Path that defines the geometric paths for this shape
This value cannot be null. |
stdWidth |
float: the standard width for the shape. Any changes to the
width with resize() will result in a width scaled based
on the new width divided by this width. |
stdHeight |
float: the standard height for the shape. Any changes to the
height with resize() will result in a height scaled based
on the new height divided by this height. |
Public methods
clone
public PathShape clone ()
Creates and returns a copy of this object. The precise meaning
of "copy" may depend on the class of the object. The general
intent is that, for any object x, the expression:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
true, this is not an absolute requirement.
By convention, the returned object should be obtained by calling
super.clone. If a class and all of its superclasses (except
Object) obey this convention, it will be the case that
x.clone().getClass() == x.getClass().
By convention, the object returned by this method should be independent
of this object (which is being cloned). To achieve this independence,
it may be necessary to modify one or more fields of the object returned
by super.clone before returning it. Typically, this means
copying any mutable objects that comprise the internal "deep structure"
of the object being cloned and replacing the references to these
objects with references to the copies. If a class contains only
primitive fields or references to immutable objects, then it is usually
the case that no fields in the object returned by super.clone
need to be modified.
The method clone for class Object performs a
specific cloning operation. First, if the class of this object does
not implement the interface Cloneable, then a
CloneNotSupportedException is thrown. Note that all arrays
are considered to implement the interface Cloneable and that
the return type of the clone method of an array type T[]
is T[] where T is any reference or primitive type.
Otherwise, this method creates a new instance of the class of this
object and initializes all its fields with exactly the contents of
the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method
performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object does not itself implement the interface
Cloneable, so calling the clone method on an object
whose class is Object will result in throwing an
exception at run time.
| Returns | |
|---|---|
PathShape |
a clone of this instance. |
| Throws | |
|---|---|
CloneNotSupportedException |
|
draw
public void draw (Canvas canvas, Paint paint)
Draws this shape into the provided Canvas, with the provided Paint.
Before calling this, you must call resize(float, float).
| Parameters | |
|---|---|
canvas |
Canvas: the Canvas within which this shape should be drawn |
paint |
Paint: the Paint object that defines this shape's characteristics |
equals
public boolean equals (Object o)
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation
on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
| Parameters | |
|---|---|
o |
Object: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)method, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal
according to the
equals(java.lang.Object)method, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined
by class Object does return distinct integers for
distinct objects. (The hashCode may or may not be implemented
as some function of an object's memory address at some point
in time.)
| Returns | |
|---|---|
int |
a hash code value for this object. |
Protected methods
onResize
protected void onResize (float width,
float height)
Callback method called when resize(float, float) is executed.
| Parameters | |
|---|---|
width |
float: the new width of the Shape |
height |
float: the new height of the Shape |