API docs for 1.3 release.
This commit is contained in:
Michael Bayne
@@ -0,0 +1,518 @@
|
||||
<!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.6.0_24) on Wed Apr 06 17:00:16 PDT 2011 -->
|
||||
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<TITLE>
|
||||
SpotSceneImpl (vilya 1.3 API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="date" CONTENT="2011-04-06">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="SpotSceneImpl (vilya 1.3 API)";
|
||||
}
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ========= 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=2 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="class-use/SpotSceneImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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">
|
||||
<A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../com/threerings/whirled/spot/data/SpotSceneModel.html" title="class in com.threerings.whirled.spot.data"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html?com/threerings/whirled/spot/data/SpotSceneImpl.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="SpotSceneImpl.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">
|
||||
com.threerings.whirled.spot.data</FONT>
|
||||
<BR>
|
||||
Class SpotSceneImpl</H2>
|
||||
<PRE>
|
||||
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
|
||||
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.threerings.whirled.spot.data.SpotSceneImpl</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data">SpotScene</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>SpotSceneImpl</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data">SpotScene</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
An implementation of the <A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data"><CODE>SpotScene</CODE></A> interface.
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#SpotSceneImpl()">SpotSceneImpl</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Instantiates a blank scene implementation.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#SpotSceneImpl(com.threerings.whirled.spot.data.SpotSceneModel)">SpotSceneImpl</A></B>(<A HREF="../../../../../com/threerings/whirled/spot/data/SpotSceneModel.html" title="class in com.threerings.whirled.spot.data">SpotSceneModel</A> smodel)</CODE>
|
||||
|
||||
<BR>
|
||||
Creates an instance that will obtain data from the supplied spot scene model.</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">
|
||||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TH>
|
||||
</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="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#addPortal(com.threerings.whirled.spot.data.Portal)">addPortal</A></B>(<A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A> portal)</CODE>
|
||||
|
||||
<BR>
|
||||
Adds a portal to this scene, immediately making the requisite modifications to the
|
||||
underlying scene model.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#getDefaultEntrance()">getDefaultEntrance</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the portal that represents the default entrance to this scene.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> short</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#getNextPortalId()">getNextPortalId</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the portal id that should be assigned to the next portal added to this scene.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#getPortal(int)">getPortal</A></B>(int portalId)</CODE>
|
||||
|
||||
<BR>
|
||||
Returns a <A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data"><CODE>Portal</CODE></A> object for the portal with the specified id or null if no portal
|
||||
exists with that id.</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="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#getPortalCount()">getPortalCount</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns the number of portals in this scene.</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A>></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#getPortals()">getPortals</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Returns an iterator over the portals in this scene.</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="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#removePortal(com.threerings.whirled.spot.data.Portal)">removePortal</A></B>(<A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A> portal)</CODE>
|
||||
|
||||
<BR>
|
||||
Removes the specified portal from the scene.</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="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#setDefaultEntrance(com.threerings.whirled.spot.data.Portal)">setDefaultEntrance</A></B>(<A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A> portal)</CODE>
|
||||
|
||||
<BR>
|
||||
Sets the default entrance in this scene, immediately making the requisite modifications to
|
||||
the underlying scene model.</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="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#setDefaultEntranceId(int)">setDefaultEntranceId</A></B>(int defaultEntranceId)</CODE>
|
||||
|
||||
<BR>
|
||||
Used when we're being parsed from an XML scene model.</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="../../../../../com/threerings/whirled/spot/data/SpotSceneImpl.html#updateReceived()">updateReceived</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
This should be called if a scene update was received that caused our underlying scene model
|
||||
to change.</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">
|
||||
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="http://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/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://java.sun.com/j2se/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://java.sun.com/j2se/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></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="SpotSceneImpl(com.threerings.whirled.spot.data.SpotSceneModel)"><!-- --></A><H3>
|
||||
SpotSceneImpl</H3>
|
||||
<PRE>
|
||||
public <B>SpotSceneImpl</B>(<A HREF="../../../../../com/threerings/whirled/spot/data/SpotSceneModel.html" title="class in com.threerings.whirled.spot.data">SpotSceneModel</A> smodel)</PRE>
|
||||
<DL>
|
||||
<DD>Creates an instance that will obtain data from the supplied spot scene model.
|
||||
<P>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="SpotSceneImpl()"><!-- --></A><H3>
|
||||
SpotSceneImpl</H3>
|
||||
<PRE>
|
||||
public <B>SpotSceneImpl</B>()</PRE>
|
||||
<DL>
|
||||
<DD>Instantiates a blank scene implementation.
|
||||
<P>
|
||||
</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="getPortal(int)"><!-- --></A><H3>
|
||||
getPortal</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A> <B>getPortal</B>(int portalId)</PRE>
|
||||
<DL>
|
||||
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getPortal(int)">SpotScene</A></CODE></B></DD>
|
||||
<DD>Returns a <A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data"><CODE>Portal</CODE></A> object for the portal with the specified id or null if no portal
|
||||
exists with that id.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getPortal(int)">getPortal</A></CODE> in interface <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data">SpotScene</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getPortalCount()"><!-- --></A><H3>
|
||||
getPortalCount</H3>
|
||||
<PRE>
|
||||
public int <B>getPortalCount</B>()</PRE>
|
||||
<DL>
|
||||
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getPortalCount()">SpotScene</A></CODE></B></DD>
|
||||
<DD>Returns the number of portals in this scene.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getPortalCount()">getPortalCount</A></CODE> in interface <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data">SpotScene</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getPortals()"><!-- --></A><H3>
|
||||
getPortals</H3>
|
||||
<PRE>
|
||||
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A>> <B>getPortals</B>()</PRE>
|
||||
<DL>
|
||||
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getPortals()">SpotScene</A></CODE></B></DD>
|
||||
<DD>Returns an iterator over the portals in this scene.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getPortals()">getPortals</A></CODE> in interface <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data">SpotScene</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getNextPortalId()"><!-- --></A><H3>
|
||||
getNextPortalId</H3>
|
||||
<PRE>
|
||||
public short <B>getNextPortalId</B>()</PRE>
|
||||
<DL>
|
||||
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getNextPortalId()">SpotScene</A></CODE></B></DD>
|
||||
<DD>Returns the portal id that should be assigned to the next portal added to this scene.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getNextPortalId()">getNextPortalId</A></CODE> in interface <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data">SpotScene</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getDefaultEntrance()"><!-- --></A><H3>
|
||||
getDefaultEntrance</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A> <B>getDefaultEntrance</B>()</PRE>
|
||||
<DL>
|
||||
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getDefaultEntrance()">SpotScene</A></CODE></B></DD>
|
||||
<DD>Returns the portal that represents the default entrance to this scene. If a body enters the
|
||||
scene at logon time rather than entering from some other scene, this is the portal at which
|
||||
they would appear.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getDefaultEntrance()">getDefaultEntrance</A></CODE> in interface <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data">SpotScene</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="addPortal(com.threerings.whirled.spot.data.Portal)"><!-- --></A><H3>
|
||||
addPortal</H3>
|
||||
<PRE>
|
||||
public void <B>addPortal</B>(<A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A> portal)</PRE>
|
||||
<DL>
|
||||
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#addPortal(com.threerings.whirled.spot.data.Portal)">SpotScene</A></CODE></B></DD>
|
||||
<DD>Adds a portal to this scene, immediately making the requisite modifications to the
|
||||
underlying scene model. The portal id should have already been assigned using the value
|
||||
obtained from <A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#getNextPortalId()"><CODE>SpotScene.getNextPortalId()</CODE></A>.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#addPortal(com.threerings.whirled.spot.data.Portal)">addPortal</A></CODE> in interface <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data">SpotScene</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="removePortal(com.threerings.whirled.spot.data.Portal)"><!-- --></A><H3>
|
||||
removePortal</H3>
|
||||
<PRE>
|
||||
public void <B>removePortal</B>(<A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A> portal)</PRE>
|
||||
<DL>
|
||||
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#removePortal(com.threerings.whirled.spot.data.Portal)">SpotScene</A></CODE></B></DD>
|
||||
<DD>Removes the specified portal from the scene.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#removePortal(com.threerings.whirled.spot.data.Portal)">removePortal</A></CODE> in interface <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data">SpotScene</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setDefaultEntranceId(int)"><!-- --></A><H3>
|
||||
setDefaultEntranceId</H3>
|
||||
<PRE>
|
||||
public void <B>setDefaultEntranceId</B>(int defaultEntranceId)</PRE>
|
||||
<DL>
|
||||
<DD>Used when we're being parsed from an XML scene model.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="setDefaultEntrance(com.threerings.whirled.spot.data.Portal)"><!-- --></A><H3>
|
||||
setDefaultEntrance</H3>
|
||||
<PRE>
|
||||
public void <B>setDefaultEntrance</B>(<A HREF="../../../../../com/threerings/whirled/spot/data/Portal.html" title="class in com.threerings.whirled.spot.data">Portal</A> portal)</PRE>
|
||||
<DL>
|
||||
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#setDefaultEntrance(com.threerings.whirled.spot.data.Portal)">SpotScene</A></CODE></B></DD>
|
||||
<DD>Sets the default entrance in this scene, immediately making the requisite modifications to
|
||||
the underlying scene model.
|
||||
<P>
|
||||
<DD><DL>
|
||||
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html#setDefaultEntrance(com.threerings.whirled.spot.data.Portal)">setDefaultEntrance</A></CODE> in interface <CODE><A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data">SpotScene</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="updateReceived()"><!-- --></A><H3>
|
||||
updateReceived</H3>
|
||||
<PRE>
|
||||
public void <B>updateReceived</B>()</PRE>
|
||||
<DL>
|
||||
<DD>This should be called if a scene update was received that caused our underlying scene model
|
||||
to change.
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</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=2 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="class-use/SpotSceneImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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">
|
||||
<A HREF="../../../../../com/threerings/whirled/spot/data/SpotScene.html" title="interface in com.threerings.whirled.spot.data"><B>PREV CLASS</B></A>
|
||||
<A HREF="../../../../../com/threerings/whirled/spot/data/SpotSceneModel.html" title="class in com.threerings.whirled.spot.data"><B>NEXT CLASS</B></A></FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../../../index.html?com/threerings/whirled/spot/data/SpotSceneImpl.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="SpotSceneImpl.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>
|
||||
Copyright © 2011. All Rights Reserved.
|
||||
</BODY>
|
||||
</HTML>
|
||||
Reference in New Issue
Block a user