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/DropBlockSprite.html
T
Michael Bayne 907eaa7014 Updated docs for 1.6 release.
2015-03-14 10:44:30 -07:00

611 lines
30 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:08 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DropBlockSprite (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="DropBlockSprite (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};
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/DropBlockSprite.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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/threerings/puzzle/drop/client/DropBoardView.html" title="class 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/DropBlockSprite.html" target="_top">Frames</a></li>
<li><a href="DropBlockSprite.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 DropBlockSprite" class="title">Class DropBlockSprite</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><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html" title="class in com.threerings.puzzle.drop.client">com.threerings.puzzle.drop.client.DropSprite</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.puzzle.drop.client.DropBlockSprite</li>
</ul>
</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>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DropBlockSprite</span>
extends <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html" title="class in com.threerings.puzzle.drop.client">DropSprite</a></pre>
<div class="block">The drop block sprite represents a block of multiple pieces that can be rotated to any of the
four cardinal compass directions. As such, it may span multiple columns or rows depending on
its orientation. The block has a "central" piece around which it rotates, with the other pieces
referred to as "external" pieces.</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/DropBlockSprite.html#DropBlockSprite-com.threerings.puzzle.drop.client.DropBoardView-int-int-int-int:A-">DropBlockSprite</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;orient,
int[]&nbsp;pieces)</code>
<div class="block">Constructs a drop block 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/DropBlockSprite.html#DropBlockSprite-com.threerings.puzzle.drop.client.DropBoardView-int-int-int-int:A-int-">DropBlockSprite</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;orient,
int[]&nbsp;pieces,
int&nbsp;renderOrder)</code>
<div class="block">Constructs a drop block 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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropBlockSprite.html#canPopup--">canPopup</a></span>()</code>
<div class="block">Can this sprite pop-up a row on a forgiving rotation?</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/DropBlockSprite.html#didPopup--">didPopup</a></span>()</code>
<div class="block">Called if we pop up to decrement the remaining popups we have.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropBlockSprite.html#getBoardBounds--">getBoardBounds</a></span>()</code>
<div class="block">Returns the bounds of the block in board piece coordinates.</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/DropBlockSprite.html#getColumns--">getColumns</a></span>()</code>
<div class="block">Returns an array of the column numbers containing the block pieces.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropBlockSprite.html#getExternalColumn--">getExternalColumn</a></span>()</code>
<div class="block">Returns the column the external piece is located in.</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/DropBlockSprite.html#getExternalRow--">getExternalRow</a></span>()</code>
<div class="block">Returns the row the external piece is located in.</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/DropBlockSprite.html#getRows--">getRows</a></span>()</code>
<div class="block">Returns an array of the row numbers containing the block pieces.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropBlockSprite.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="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropBlockSprite.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="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropBlockSprite.html#setOrientation-int-">setOrientation</a></span>(int&nbsp;orient)</code>
<div class="block">Updates the sprite image offset to reflect the direction in which the external piece is
hanging.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropBlockSprite.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="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/client/DropBlockSprite.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.puzzle.drop.client.DropSprite">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.puzzle.drop.client.<a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html" title="class in com.threerings.puzzle.drop.client">DropSprite</a></h3>
<code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#drop--">drop</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#fastForward-long-">fastForward</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getColumn--">getColumn</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getDistance--">getDistance</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getPercentDone-long-">getPercentDone</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getPieces--">getPieces</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getRow--">getRow</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#getVelocity--">getVelocity</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#inside-java.awt.Shape-">inside</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#isBouncing--">isBouncing</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#isDropping--">isDropping</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#paint-java.awt.Graphics2D-">paint</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setBouncing-boolean-">setBouncing</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setColumnOffset-int-">setColumnOffset</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setPieces-int:A-">setPieces</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setRowOffset-int-">setRowOffset</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setVelocity-float-">setVelocity</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#stop--">stop</a>, <a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#tick-long-">tick</a></code></li>
</ul>
<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="DropBlockSprite-com.threerings.puzzle.drop.client.DropBoardView-int-int-int-int:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DropBlockSprite</h4>
<pre>public&nbsp;DropBlockSprite(<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;orient,
int[]&nbsp;pieces)</pre>
<div class="block">Constructs a drop block 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 central piece.</dd>
<dd><code>row</code> - the row of the central piece.</dd>
<dd><code>orient</code> - the orientation of the sprite.</dd>
<dd><code>pieces</code> - the pieces displayed by the sprite.</dd>
</dl>
</li>
</ul>
<a name="DropBlockSprite-com.threerings.puzzle.drop.client.DropBoardView-int-int-int-int:A-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DropBlockSprite</h4>
<pre>public&nbsp;DropBlockSprite(<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;orient,
int[]&nbsp;pieces,
int&nbsp;renderOrder)</pre>
<div class="block">Constructs a drop block 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 central piece.</dd>
<dd><code>row</code> - the row of the central piece.</dd>
<dd><code>orient</code> - the orientation of the sprite.</dd>
<dd><code>pieces</code> - the pieces displayed by the sprite.</dd>
<dd><code>renderOrder</code> - the rendering order of the sprite.</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="getRows--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRows</h4>
<pre>public&nbsp;int[]&nbsp;getRows()</pre>
<div class="block">Returns an array of the row numbers containing the block pieces. The first index is the row
of the central piece. The array is cached and re-used internally and so the caller should
make their own copy if they care to modify it.</div>
</li>
</ul>
<a name="getColumns--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumns</h4>
<pre>public&nbsp;int[]&nbsp;getColumns()</pre>
<div class="block">Returns an array of the column numbers containing the block pieces. The first index is the
column of the central piece. The array is cached and re-used internally and so the caller
should make their own copy if they care to modify it.</div>
</li>
</ul>
<a name="getBoardBounds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoardBounds</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/awt/Rectangle.html?is-external=true" title="class or interface in java.awt">Rectangle</a>&nbsp;getBoardBounds()</pre>
<div class="block">Returns the bounds of the block in board piece coordinates. The bounds rectangle is cached
and re-used internally and so the caller should make their own copy if they care to modify
it.</div>
</li>
</ul>
<a name="getExternalRow--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalRow</h4>
<pre>public&nbsp;int&nbsp;getExternalRow()</pre>
<div class="block">Returns the row the external piece is located in.</div>
</li>
</ul>
<a name="getExternalColumn--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalColumn</h4>
<pre>public&nbsp;int&nbsp;getExternalColumn()</pre>
<div class="block">Returns the column the external 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"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setColumn-int-">DropSprite</a></code></span></div>
<div class="block">Sets the column the piece is located in.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setColumn-int-">setColumn</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html" title="class in com.threerings.puzzle.drop.client">DropSprite</a></code></dd>
</dl>
</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"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setRow-int-">DropSprite</a></code></span></div>
<div class="block">Set the row the piece is located in.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setRow-int-">setRow</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html" title="class in com.threerings.puzzle.drop.client">DropSprite</a></code></dd>
</dl>
</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"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setBoardLocation-int-int-">DropSprite</a></code></span></div>
<div class="block">Sets the row and column the piece is located in.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setBoardLocation-int-int-">setBoardLocation</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html" title="class in com.threerings.puzzle.drop.client">DropSprite</a></code></dd>
</dl>
</li>
</ul>
<a name="setOrientation-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOrientation</h4>
<pre>public&nbsp;void&nbsp;setOrientation(int&nbsp;orient)</pre>
<div class="block">Updates the sprite image offset to reflect the direction in which the external piece is
hanging.</div>
<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><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#setOrientation-int-">setOrientation</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html" title="class in com.threerings.puzzle.drop.client">DropSprite</a></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><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html#toString-java.lang.StringBuilder-">toString</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../com/threerings/puzzle/drop/client/DropSprite.html" title="class in com.threerings.puzzle.drop.client">DropSprite</a></code></dd>
</dl>
</li>
</ul>
<a name="canPopup--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canPopup</h4>
<pre>public&nbsp;boolean&nbsp;canPopup()</pre>
<div class="block">Can this sprite pop-up a row on a forgiving rotation?</div>
</li>
</ul>
<a name="didPopup--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>didPopup</h4>
<pre>public&nbsp;void&nbsp;didPopup()</pre>
<div class="block">Called if we pop up to decrement the remaining popups we have.</div>
</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/DropBlockSprite.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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/threerings/puzzle/drop/client/DropBoardView.html" title="class 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/DropBlockSprite.html" target="_top">Frames</a></li>
<li><a href="DropBlockSprite.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