first commit
This commit is contained in:
Jose Caban
@@ -0,0 +1,538 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:23 EDT 2004 -->
|
||||
<TITLE>
|
||||
AnimatedSprite
|
||||
</TITLE>
|
||||
|
||||
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.graphics.AnimatedSprite class">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="AnimatedSprite";
|
||||
}
|
||||
</SCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
PREV CLASS
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Direction.html" title="class in edu.gatech.cs2335.lemmings.graphics"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="AnimatedSprite.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
edu.gatech.cs2335.lemmings.graphics</FONT>
|
||||
<BR>
|
||||
Class AnimatedSprite</H2>
|
||||
<PRE>
|
||||
java.lang.Object
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.graphics.AnimatedSprite</B>
|
||||
</PRE>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT>public final class <B>AnimatedSprite</B><DT>extends java.lang.Object</DL>
|
||||
|
||||
<P>
|
||||
Class AnimatedSprite: This animated sprite will be used to render
|
||||
all things animated onto the screen. It will be created using a
|
||||
TileSet, and will treat the frames as follows: it will keep track
|
||||
of which direction the sprite is moving in. If we are moving in a
|
||||
certain direction, we will only use half of the frames - which half
|
||||
depends on where we are moving - from left to right means using the
|
||||
first half of the frames, and from right to left - the second
|
||||
half. If the sprite is not moving in any direction, all frames will
|
||||
be used in the animation.
|
||||
|
||||
<PRE>
|
||||
Revision History:
|
||||
v1.0 (Mar. 12, 2004) - Created the AnimatedSprite class
|
||||
</PRE>
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Version:</B></DT>
|
||||
<DD>Version 1.0, Mar. 12, 2004</DD>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD><A HREF="mailto:gtg308i@mail.gatech.edu">Vladimir Urazov</A></DD>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/TileSet.html" title="class in edu.gatech.cs2335.lemmings.graphics"><CODE>TileSet</CODE></A>,
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/TileSetManager.html" title="class in edu.gatech.cs2335.lemmings.graphics"><CODE>TileSetManager</CODE></A></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
|
||||
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#AnimatedSprite()">AnimatedSprite</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>AnimatedSprite</code> instance.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#AnimatedSprite(edu.gatech.cs2335.lemmings.graphics.TileSet)">AnimatedSprite</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/TileSet.html" title="class in edu.gatech.cs2335.lemmings.graphics">TileSet</A> anim)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>AnimatedSprite</code> instance.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#AnimatedSprite(edu.gatech.cs2335.lemmings.graphics.TileSet, edu.gatech.cs2335.lemmings.graphics.Direction, edu.gatech.cs2335.lemmings.graphics.Looping)">AnimatedSprite</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/TileSet.html" title="class in edu.gatech.cs2335.lemmings.graphics">TileSet</A> anim,
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Direction.html" title="class in edu.gatech.cs2335.lemmings.graphics">Direction</A> dir,
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Looping.html" title="class in edu.gatech.cs2335.lemmings.graphics">Looping</A> loop)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates a new <code>AnimatedSprite</code> instance.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=2><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/TileSet.html" title="class in edu.gatech.cs2335.lemmings.graphics">TileSet</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#getAnimation()">getAnimation</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the tileset associated with the sprite.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#getCurrentFrame()">getCurrentFrame</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the current frame number.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Looping.html" title="class in edu.gatech.cs2335.lemmings.graphics">Looping</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#getLoopingMode()">getLoopingMode</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the looping mode.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Direction.html" title="class in edu.gatech.cs2335.lemmings.graphics">Direction</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#getMovementDirection()">getMovementDirection</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the direction in which the sprite is moving.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>protected int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#getNumFrames()">getNumFrames</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the number of frames in a complete loop of animation.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#isInitialized()">isInitialized</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns true if the sprite is initialized with animation already,
|
||||
and false f it is not yet.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#nextFrameNumber()">nextFrameNumber</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the next frame number and increments the counter.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#renderSprite(java.awt.Graphics, java.awt.Point)">renderSprite</A></B>(java.awt.Graphics g,
|
||||
java.awt.Point coordinates)</CODE>
|
||||
|
||||
<BR>
|
||||
Renders the sprite at the specified coordinates.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#setAnimation(edu.gatech.cs2335.lemmings.graphics.TileSet)">setAnimation</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/TileSet.html" title="class in edu.gatech.cs2335.lemmings.graphics">TileSet</A> v)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the new animation for the sprite.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#setLoopingMode(edu.gatech.cs2335.lemmings.graphics.Looping)">setLoopingMode</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Looping.html" title="class in edu.gatech.cs2335.lemmings.graphics">Looping</A> v)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets a new looping mode.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/AnimatedSprite.html#setMovementDirection(edu.gatech.cs2335.lemmings.graphics.Direction)">setMovementDirection</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Direction.html" title="class in edu.gatech.cs2335.lemmings.graphics">Direction</A> v)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets a direction in which the sprite is moving.</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="AnimatedSprite()"><!-- --></A><H3>
|
||||
AnimatedSprite</H3>
|
||||
<PRE>
|
||||
public <B>AnimatedSprite</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>AnimatedSprite</code> instance.
|
||||
<P>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="AnimatedSprite(edu.gatech.cs2335.lemmings.graphics.TileSet)"><!-- --></A><H3>
|
||||
AnimatedSprite</H3>
|
||||
<PRE>
|
||||
public <B>AnimatedSprite</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/TileSet.html" title="class in edu.gatech.cs2335.lemmings.graphics">TileSet</A> anim)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>AnimatedSprite</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>anim</CODE> - a <code>TileSet</code> value</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="AnimatedSprite(edu.gatech.cs2335.lemmings.graphics.TileSet, edu.gatech.cs2335.lemmings.graphics.Direction, edu.gatech.cs2335.lemmings.graphics.Looping)"><!-- --></A><H3>
|
||||
AnimatedSprite</H3>
|
||||
<PRE>
|
||||
public <B>AnimatedSprite</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/TileSet.html" title="class in edu.gatech.cs2335.lemmings.graphics">TileSet</A> anim,
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Direction.html" title="class in edu.gatech.cs2335.lemmings.graphics">Direction</A> dir,
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Looping.html" title="class in edu.gatech.cs2335.lemmings.graphics">Looping</A> loop)</PRE>
|
||||
<DL>
|
||||
<DD>Creates a new <code>AnimatedSprite</code> instance.
|
||||
<P>
|
||||
<DT><B>Parameters:</B><DD><CODE>anim</CODE> - a <code>TileSet</code> value<DD><CODE>dir</CODE> - a <code>Direction</code> value<DD><CODE>loop</CODE> - a <code>Looping</code> value</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TD COLSPAN=1><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="isInitialized()"><!-- --></A><H3>
|
||||
isInitialized</H3>
|
||||
<PRE>
|
||||
public boolean <B>isInitialized</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns true if the sprite is initialized with animation already,
|
||||
and false f it is not yet.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getNumFrames()"><!-- --></A><H3>
|
||||
getNumFrames</H3>
|
||||
<PRE>
|
||||
protected int <B>getNumFrames</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the number of frames in a complete loop of animation.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>an <code>int</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getMovementDirection()"><!-- --></A><H3>
|
||||
getMovementDirection</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Direction.html" title="class in edu.gatech.cs2335.lemmings.graphics">Direction</A> <B>getMovementDirection</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the direction in which the sprite is moving.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>Direction</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setMovementDirection(edu.gatech.cs2335.lemmings.graphics.Direction)"><!-- --></A><H3>
|
||||
setMovementDirection</H3>
|
||||
<PRE>
|
||||
public void <B>setMovementDirection</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Direction.html" title="class in edu.gatech.cs2335.lemmings.graphics">Direction</A> v)</PRE>
|
||||
<DL>
|
||||
<DD>Sets a direction in which the sprite is moving. If the value
|
||||
passed in is NULL, an exception will be thrown.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>v</CODE> - a <code>Direction</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getLoopingMode()"><!-- --></A><H3>
|
||||
getLoopingMode</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Looping.html" title="class in edu.gatech.cs2335.lemmings.graphics">Looping</A> <B>getLoopingMode</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the looping mode.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>Looping</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setLoopingMode(edu.gatech.cs2335.lemmings.graphics.Looping)"><!-- --></A><H3>
|
||||
setLoopingMode</H3>
|
||||
<PRE>
|
||||
public void <B>setLoopingMode</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Looping.html" title="class in edu.gatech.cs2335.lemmings.graphics">Looping</A> v)</PRE>
|
||||
<DL>
|
||||
<DD>Sets a new looping mode. If the value passed in is NULL, an
|
||||
exception will be thrown.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>v</CODE> - a <code>Looping</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getAnimation()"><!-- --></A><H3>
|
||||
getAnimation</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/TileSet.html" title="class in edu.gatech.cs2335.lemmings.graphics">TileSet</A> <B>getAnimation</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the tileset associated with the sprite.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <code>TileSet</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setAnimation(edu.gatech.cs2335.lemmings.graphics.TileSet)"><!-- --></A><H3>
|
||||
setAnimation</H3>
|
||||
<PRE>
|
||||
public void <B>setAnimation</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/TileSet.html" title="class in edu.gatech.cs2335.lemmings.graphics">TileSet</A> v)</PRE>
|
||||
<DL>
|
||||
<DD>Sets the new animation for the sprite.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>v</CODE> - a <code>TileSet</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getCurrentFrame()"><!-- --></A><H3>
|
||||
getCurrentFrame</H3>
|
||||
<PRE>
|
||||
public int <B>getCurrentFrame</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the current frame number.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>an <code>int</code> value.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="nextFrameNumber()"><!-- --></A><H3>
|
||||
nextFrameNumber</H3>
|
||||
<PRE>
|
||||
public int <B>nextFrameNumber</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Returns the next frame number and increments the counter.
|
||||
<P>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>an <code>int</code> value.</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="renderSprite(java.awt.Graphics, java.awt.Point)"><!-- --></A><H3>
|
||||
renderSprite</H3>
|
||||
<PRE>
|
||||
public boolean <B>renderSprite</B>(java.awt.Graphics g,
|
||||
java.awt.Point coordinates)</PRE>
|
||||
<DL>
|
||||
<DD>Renders the sprite at the specified coordinates.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>g</CODE> - a <code>Graphics</code> value<DD><CODE>coordinates</CODE> - a <code>Point</code> value
|
||||
<DT><B>Returns:</B><DD>a <code>boolean</code> value</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
PREV CLASS
|
||||
<A HREF="../../../../../edu/gatech/cs2335/lemmings/graphics/Direction.html" title="class in edu.gatech.cs2335.lemmings.graphics"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="AnimatedSprite.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
Reference in New Issue
Block a user