AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
907eaa7014cde93e994514299f845079dafc5ad4
vilya/apidocs/com/threerings/puzzle/drop/client/DropSprite.html
T
Michael Bayne 907eaa7014 Updated docs for 1.6 release.
2015-03-14 10:44:30 -07:00

780 lines
33 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_31) on Sat Mar 14 10:07:09 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DropSprite (Vilya Core 1.6 API)</title>
<meta name="date" content="2015-03-14">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DropSprite (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DropSprite.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/threerings/puzzle/drop/client/DropPanel.html" title="interface in com.threerings.puzzle.drop.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/puzzle/drop/client/DropSpriteObserver.html" title="interface in com.threerings.puzzle.drop.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/puzzle/drop/client/DropSprite.html" target="_top">Frames</a></li>
<li><a href="DropSprite.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.com.threerings.media.AbstractMedia">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.threerings.puzzle.drop.client</div>
<h2 title="Class DropSprite" class="title">Class DropSprite</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.media.AbstractMedia</li>
<li>
<ul class="inheritance">
<li>com.threerings.media.sprite.Sprite</li>
<li>
<ul class="inheritance">
<li>com.threerings.puzzle.drop.client.DropSprite</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.threerings.media.util.Pathable, com.threerings.util.DirectionCodes, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/awt/Shape.html?is-external=true" title="class or interface in java.awt">Shape</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../com/threerings/puzzle/drop/client/DropBlockSprite.html" title="class in com.threerings.puzzle.drop.client">DropBlockSprite</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DropSprite</span>
extends com.threerings.media.sprite.Sprite</pre>
<div class="block">The drop sprite is a sprite that displays one or more pieces falling toward the bottom of the
board.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.media.AbstractMedia">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.threerings.media.AbstractMedia</h3>
<code>HUD_LAYER</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.util.DirectionCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.util.DirectionCodes</h3>
<code>CARDINAL_DIRECTIONS, CCW, CW, DIRECTION_COUNT, DOWN, EAST, EASTNORTHEAST, EASTSOUTHEAST, FINE_DIRECTION_COUNT, HORIZONTAL, LEFT, NONE, NORTH, NORTHEAST, NORTHNORTHEAST, NORTHNORTHWEST, NORTHWEST, RIGHT, SOUTH, SOUTHEAST, SOUTHSOUTHEAST, SOUTHSOUTHWEST, SOUTHWEST, UP, VERTICAL, WEST, WESTNORTHWEST, WESTSOUTHWEST</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#DropSprite-com.threerings.puzzle.drop.client.DropBoardView-int-int-int:A-int-">DropSprite</a></span>(<a href="../../../../../com/threerings/puzzle/drop/client/DropBoardView.html" title="class in com.threerings.puzzle.drop.client">DropBoardView</a>&nbsp;view,
int&nbsp;col,
int&nbsp;row,
int[]&nbsp;pieces,
int&nbsp;dist)</code>
<div class="block">Constructs a drop sprite and starts it dropping.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#DropSprite-com.threerings.puzzle.drop.client.DropBoardView-int-int-int:A-int-int-">DropSprite</a></span>(<a href="../../../../../com/threerings/puzzle/drop/client/DropBoardView.html" title="class in com.threerings.puzzle.drop.client">DropBoardView</a>&nbsp;view,
int&nbsp;col,
int&nbsp;row,
int[]&nbsp;pieces,
int&nbsp;dist,
int&nbsp;renderOrder)</code>
<div class="block">Constructs a drop sprite and starts it dropping.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#drop--">drop</a></span>()</code>
<div class="block">Starts the piece dropping toward the next row.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#fastForward-long-">fastForward</a></span>(long&nbsp;timeDelta)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getColumn--">getColumn</a></span>()</code>
<div class="block">Returns the column the piece is located in.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getDistance--">getDistance</a></span>()</code>
<div class="block">Returns the remaining number of columns to drop.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getPercentDone-long-">getPercentDone</a></span>(long&nbsp;timestamp)</code>
<div class="block">Returns a value between <code>0.0</code> and <code>1.0</code> representing how far the
piece has moved toward the next row as of the given time stamp.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getPieces--">getPieces</a></span>()</code>
<div class="block">Returns the pieces the sprite is displaying.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getRow--">getRow</a></span>()</code>
<div class="block">Returns the row the piece is located in.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getVelocity--">getVelocity</a></span>()</code>
<div class="block">Returns the velocity of this sprite.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#inside-java.awt.Shape-">inside</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/awt/Shape.html?is-external=true" title="class or interface in java.awt">Shape</a>&nbsp;shape)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#isBouncing--">isBouncing</a></span>()</code>
<div class="block">Returns true if this sprite is bouncing.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#isDropping--">isDropping</a></span>()</code>
<div class="block">Returns true if this drop sprite is dropping, false if it has been <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#stop--"><code>stop()</code></a>ped or has
not yet been <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#drop--"><code>drop()</code></a>ped.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#paint-java.awt.Graphics2D-">paint</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/awt/Graphics2D.html?is-external=true" title="class or interface in java.awt">Graphics2D</a>&nbsp;gfx)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setBoardLocation-int-int-">setBoardLocation</a></span>(int&nbsp;row,
int&nbsp;col)</code>
<div class="block">Sets the row and column the piece is located in.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setBouncing-boolean-">setBouncing</a></span>(boolean&nbsp;bouncing)</code>
<div class="block">Puts the drop sprite into (or takes it out of) bouncing mode.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setColumn-int-">setColumn</a></span>(int&nbsp;col)</code>
<div class="block">Sets the column the piece is located in.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setColumnOffset-int-">setColumnOffset</a></span>(int&nbsp;count)</code>
<div class="block">Sets the column offset of the sprite image.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setOrientation-int-">setOrientation</a></span>(int&nbsp;orient)</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setPieces-int:A-">setPieces</a></span>(int[]&nbsp;pieces)</code>
<div class="block">Sets the pieces the sprite is displaying.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setRow-int-">setRow</a></span>(int&nbsp;row)</code>
<div class="block">Set the row the piece is located in.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setRowOffset-int-">setRowOffset</a></span>(int&nbsp;count)</code>
<div class="block">Sets the row offset of the sprite image.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setVelocity-float-">setVelocity</a></span>(float&nbsp;velocity)</code>
<div class="block">Sets the velocity of this sprite.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#stop--">stop</a></span>()</code>
<div class="block">Stops the piece from dropping.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#tick-long-">tick</a></span>(long&nbsp;timestamp)</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#toString-java.lang.StringBuilder-">toString</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;buf)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.media.sprite.Sprite">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.media.sprite.Sprite</h3>
<code>addSpriteObserver, cancelMove, contains, getHeight, getOrientation, getPath, getWidth, getX, getXOffset, getY, getYOffset, hitTest, intersects, isMoving, move, paintPath, pathBeginning, pathCompleted, removeSpriteObserver, setLocation, viewLocationDidChange</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.media.AbstractMedia">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.media.AbstractMedia</h3>
<code>contains, contains, contains, contains, getBounds, getBounds2D, getPathIterator, getPathIterator, getRenderOrder, init, intersects, intersects, invalidate, queueNotification, renderCompareTo, setRenderOrder, toString</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.media.util.Pathable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.threerings.media.util.Pathable</h3>
<code>getBounds</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DropSprite-com.threerings.puzzle.drop.client.DropBoardView-int-int-int:A-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DropSprite</h4>
<pre>public&nbsp;DropSprite(<a href="../../../../../com/threerings/puzzle/drop/client/DropBoardView.html" title="class in com.threerings.puzzle.drop.client">DropBoardView</a>&nbsp;view,
int&nbsp;col,
int&nbsp;row,
int[]&nbsp;pieces,
int&nbsp;dist)</pre>
<div class="block">Constructs a drop sprite and starts it dropping.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>view</code> - the board view upon which this sprite will be displayed.</dd>
<dd><code>col</code> - the column of the sprite.</dd>
<dd><code>row</code> - the row of the bottom-most piece.</dd>
<dd><code>pieces</code> - the pieces displayed by the sprite.</dd>
<dd><code>dist</code> - the distance the sprite is to drop in rows.</dd>
</dl>
</li>
</ul>
<a name="DropSprite-com.threerings.puzzle.drop.client.DropBoardView-int-int-int:A-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DropSprite</h4>
<pre>public&nbsp;DropSprite(<a href="../../../../../com/threerings/puzzle/drop/client/DropBoardView.html" title="class in com.threerings.puzzle.drop.client">DropBoardView</a>&nbsp;view,
int&nbsp;col,
int&nbsp;row,
int[]&nbsp;pieces,
int&nbsp;dist,
int&nbsp;renderOrder)</pre>
<div class="block">Constructs a drop sprite and starts it dropping.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>view</code> - the board view upon which this sprite will be displayed.</dd>
<dd><code>col</code> - the column of the sprite.</dd>
<dd><code>row</code> - the row of the bottom-most piece.</dd>
<dd><code>pieces</code> - the pieces displayed by the sprite.</dd>
<dd><code>dist</code> - the distance the sprite is to drop in rows.</dd>
<dd><code>renderOrder</code> - the render order.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getDistance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDistance</h4>
<pre>public&nbsp;int&nbsp;getDistance()</pre>
<div class="block">Returns the remaining number of columns to drop.</div>
</li>
</ul>
<a name="getColumn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumn</h4>
<pre>public&nbsp;int&nbsp;getColumn()</pre>
<div class="block">Returns the column the piece is located in.</div>
</li>
</ul>
<a name="getRow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRow</h4>
<pre>public&nbsp;int&nbsp;getRow()</pre>
<div class="block">Returns the row the piece is located in.</div>
</li>
</ul>
<a name="getPieces--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPieces</h4>
<pre>public&nbsp;int[]&nbsp;getPieces()</pre>
<div class="block">Returns the pieces the sprite is displaying.</div>
</li>
</ul>
<a name="getVelocity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVelocity</h4>
<pre>public&nbsp;float&nbsp;getVelocity()</pre>
<div class="block">Returns the velocity of this sprite.</div>
</li>
</ul>
<a name="setBoardLocation-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBoardLocation</h4>
<pre>public&nbsp;void&nbsp;setBoardLocation(int&nbsp;row,
int&nbsp;col)</pre>
<div class="block">Sets the row and column the piece is located in.</div>
</li>
</ul>
<a name="setColumn-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumn</h4>
<pre>public&nbsp;void&nbsp;setColumn(int&nbsp;col)</pre>
<div class="block">Sets the column the piece is located in.</div>
</li>
</ul>
<a name="setRow-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRow</h4>
<pre>public&nbsp;void&nbsp;setRow(int&nbsp;row)</pre>
<div class="block">Set the row the piece is located in.</div>
</li>
</ul>
<a name="setColumnOffset-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnOffset</h4>
<pre>public&nbsp;void&nbsp;setColumnOffset(int&nbsp;count)</pre>
<div class="block">Sets the column offset of the sprite image.</div>
</li>
</ul>
<a name="setRowOffset-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRowOffset</h4>
<pre>public&nbsp;void&nbsp;setRowOffset(int&nbsp;count)</pre>
<div class="block">Sets the row offset of the sprite image.</div>
</li>
</ul>
<a name="setPieces-int:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPieces</h4>
<pre>public&nbsp;void&nbsp;setPieces(int[]&nbsp;pieces)</pre>
<div class="block">Sets the pieces the sprite is displaying.</div>
</li>
</ul>
<a name="setVelocity-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVelocity</h4>
<pre>public&nbsp;void&nbsp;setVelocity(float&nbsp;velocity)</pre>
<div class="block">Sets the velocity of this sprite. The time at which the current row was entered is modified
so that the sprite position will remain the same when calculated using the new velocity
since the piece sprite may have its velocity modified in the middle of a row traversal.</div>
</li>
</ul>
<a name="drop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drop</h4>
<pre>public&nbsp;void&nbsp;drop()</pre>
<div class="block">Starts the piece dropping toward the next row.</div>
</li>
</ul>
<a name="isDropping--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDropping</h4>
<pre>public&nbsp;boolean&nbsp;isDropping()</pre>
<div class="block">Returns true if this drop sprite is dropping, false if it has been <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#stop--"><code>stop()</code></a>ped or has
not yet been <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#drop--"><code>drop()</code></a>ped.</div>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public&nbsp;void&nbsp;stop()</pre>
<div class="block">Stops the piece from dropping.</div>
</li>
</ul>
<a name="setBouncing-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBouncing</h4>
<pre>public&nbsp;void&nbsp;setBouncing(boolean&nbsp;bouncing)</pre>
<div class="block">Puts the drop sprite into (or takes it out of) bouncing mode. Bouncing mode is used to put
the sprite into limbo after it lands but before we commit the landing, giving the user a
last moment change move or rotate the piece. While the sprite is "bouncing" it will be
rendered one pixel below its at rest state.</div>
</li>
</ul>
<a name="isBouncing--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBouncing</h4>
<pre>public&nbsp;boolean&nbsp;isBouncing()</pre>
<div class="block">Returns true if this sprite is bouncing.</div>
</li>
</ul>
<a name="inside-java.awt.Shape-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inside</h4>
<pre>public&nbsp;boolean&nbsp;inside(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/awt/Shape.html?is-external=true" title="class or interface in java.awt">Shape</a>&nbsp;shape)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>inside</code>&nbsp;in class&nbsp;<code>com.threerings.media.sprite.Sprite</code></dd>
</dl>
</li>
</ul>
<a name="getPercentDone-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPercentDone</h4>
<pre>public&nbsp;float&nbsp;getPercentDone(long&nbsp;timestamp)</pre>
<div class="block">Returns a value between <code>0.0</code> and <code>1.0</code> representing how far the
piece has moved toward the next row as of the given time stamp.</div>
</li>
</ul>
<a name="paint-java.awt.Graphics2D-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>paint</h4>
<pre>public&nbsp;void&nbsp;paint(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/awt/Graphics2D.html?is-external=true" title="class or interface in java.awt">Graphics2D</a>&nbsp;gfx)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>paint</code>&nbsp;in class&nbsp;<code>com.threerings.media.sprite.Sprite</code></dd>
</dl>
</li>
</ul>
<a name="tick-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tick</h4>
<pre>public&nbsp;void&nbsp;tick(long&nbsp;timestamp)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>tick</code>&nbsp;in class&nbsp;<code>com.threerings.media.sprite.Sprite</code></dd>
</dl>
</li>
</ul>
<a name="fastForward-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fastForward</h4>
<pre>public&nbsp;void&nbsp;fastForward(long&nbsp;timeDelta)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>fastForward</code>&nbsp;in class&nbsp;<code>com.threerings.media.sprite.Sprite</code></dd>
</dl>
</li>
</ul>
<a name="toString-java.lang.StringBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;void&nbsp;toString(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/StringBuilder.html?is-external=true" title="class or interface in java.lang">StringBuilder</a>&nbsp;buf)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>com.threerings.media.sprite.Sprite</code></dd>
</dl>
</li>
</ul>
<a name="setOrientation-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setOrientation</h4>
<pre>public&nbsp;void&nbsp;setOrientation(int&nbsp;orient)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setOrientation</code>&nbsp;in interface&nbsp;<code>com.threerings.media.util.Pathable</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>setOrientation</code>&nbsp;in class&nbsp;<code>com.threerings.media.sprite.Sprite</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DropSprite.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/threerings/puzzle/drop/client/DropPanel.html" title="interface in com.threerings.puzzle.drop.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/puzzle/drop/client/DropSpriteObserver.html" title="interface in com.threerings.puzzle.drop.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/puzzle/drop/client/DropSprite.html" target="_top">Frames</a></li>
<li><a href="DropSprite.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.com.threerings.media.AbstractMedia">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink