Michael Bayne
371 lines
14 KiB
HTML
371 lines
14 KiB
HTML
<!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:12 PDT 2015 -->
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>Scene (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="Scene (Vilya Core 1.6 API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/Scene.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/whirled/data/DefaultSceneConfig.html" title="class in com.threerings.whirled.data"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/threerings/whirled/data/SceneCodes.html" title="interface in com.threerings.whirled.data"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/threerings/whirled/data/Scene.html" target="_top">Frames</a></li>
|
|
<li><a href="Scene.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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.whirled.data</div>
|
|
<h2 title="Interface Scene" class="title">Interface Scene</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><a href="../../../../com/threerings/whirled/data/SceneImpl.html" title="class in com.threerings.whirled.data">SceneImpl</a>, <a href="../../../../com/threerings/stage/data/StageScene.html" title="class in com.threerings.stage.data">StageScene</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">Scene</span></pre>
|
|
<div class="block">This interface makes available basic scene information. At this basic
|
|
level, not much information is available, but extensions to this
|
|
interface begin to create a more comprehensive picture of a scene in a
|
|
system built from the Whirled services.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/whirled/data/Scene.html#getId--">getId</a></span>()</code>
|
|
<div class="block">Returns the unique identifier for this scene.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/whirled/data/Scene.html#getName--">getName</a></span>()</code>
|
|
<div class="block">Returns the human readable name of this scene.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>com.threerings.crowd.data.PlaceConfig</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/whirled/data/Scene.html#getPlaceConfig--">getPlaceConfig</a></span>()</code>
|
|
<div class="block">Returns the place config that can be used to determine which place
|
|
controller instance should be used to display this scene as well as
|
|
to obtain runtime configuration information.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/whirled/data/Scene.html#getSceneModel--">getSceneModel</a></span>()</code>
|
|
<div class="block">Returns the scene model from which this scene was created.</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/whirled/data/Scene.html#getVersion--">getVersion</a></span>()</code>
|
|
<div class="block">Returns the version number of this scene.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/whirled/data/Scene.html#setId-int-">setId</a></span>(int sceneId)</code>
|
|
<div class="block">Sets this scene's unique identifier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/whirled/data/Scene.html#setName-java.lang.String-">setName</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code>
|
|
<div class="block">Sets the human readable name of this scene.</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/whirled/data/Scene.html#setVersion-int-">setVersion</a></span>(int version)</code>
|
|
<div class="block">Sets this scene's version number.</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/whirled/data/Scene.html#updateReceived-com.threerings.whirled.data.SceneUpdate-">updateReceived</a></span>(<a href="../../../../com/threerings/whirled/data/SceneUpdate.html" title="class in com.threerings.whirled.data">SceneUpdate</a> update)</code>
|
|
<div class="block">Called to inform the scene that an update has been received while
|
|
the scene was resolved and active.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getId--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getId</h4>
|
|
<pre>int getId()</pre>
|
|
<div class="block">Returns the unique identifier for this scene.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getName--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getName</h4>
|
|
<pre><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre>
|
|
<div class="block">Returns the human readable name of this scene.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getVersion--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVersion</h4>
|
|
<pre>int getVersion()</pre>
|
|
<div class="block">Returns the version number of this scene.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getPlaceConfig--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPlaceConfig</h4>
|
|
<pre>com.threerings.crowd.data.PlaceConfig getPlaceConfig()</pre>
|
|
<div class="block">Returns the place config that can be used to determine which place
|
|
controller instance should be used to display this scene as well as
|
|
to obtain runtime configuration information.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setId-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setId</h4>
|
|
<pre>void setId(int sceneId)</pre>
|
|
<div class="block">Sets this scene's unique identifier.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setName-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setName</h4>
|
|
<pre>void setName(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre>
|
|
<div class="block">Sets the human readable name of this scene.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setVersion-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setVersion</h4>
|
|
<pre>void setVersion(int version)</pre>
|
|
<div class="block">Sets this scene's version number.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="updateReceived-com.threerings.whirled.data.SceneUpdate-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>updateReceived</h4>
|
|
<pre>void updateReceived(<a href="../../../../com/threerings/whirled/data/SceneUpdate.html" title="class in com.threerings.whirled.data">SceneUpdate</a> update)</pre>
|
|
<div class="block">Called to inform the scene that an update has been received while
|
|
the scene was resolved and active. The update should be applied to
|
|
the underlying scene model and any derivative data should be
|
|
appropriately updated.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getSceneModel--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getSceneModel</h4>
|
|
<pre><a href="../../../../com/threerings/whirled/data/SceneModel.html" title="class in com.threerings.whirled.data">SceneModel</a> getSceneModel()</pre>
|
|
<div class="block">Returns the scene model from which this scene was created.</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/Scene.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/whirled/data/DefaultSceneConfig.html" title="class in com.threerings.whirled.data"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../com/threerings/whirled/data/SceneCodes.html" title="interface in com.threerings.whirled.data"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/threerings/whirled/data/Scene.html" target="_top">Frames</a></li>
|
|
<li><a href="Scene.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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 © 2015. All rights reserved.</small></p>
|
|
</body>
|
|
</html>
|