318 lines
14 KiB
HTML
318 lines
14 KiB
HTML
<!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 09:00:20 CEST 2011 -->
|
|
<TITLE>
|
|
algoanim.util
|
|
</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="algoanim.util";
|
|
}
|
|
}
|
|
</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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.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-files/index-1.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="../../algoanim/properties/items/package-summary.html"><B>PREV PACKAGE</B></A>
|
|
<A HREF="../../algoanim/variables/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?algoanim/util/package-summary.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="package-summary.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>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<H2>
|
|
Package algoanim.util
|
|
</H2>
|
|
Using the classes in the <em>animalscriptapi.util</em> package
|
|
<P>
|
|
<B>See:</B>
|
|
<BR>
|
|
<A HREF="#package_description"><B>Description</B></A>
|
|
<P>
|
|
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Class Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD WIDTH="15%"><B><A HREF="../../algoanim/util/ArrayDisplayOptions.html" title="class in algoanim.util">ArrayDisplayOptions</A></B></TD>
|
|
<TD>This is a workaround for the <code>DisplayOptions</code> associated with an array.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD WIDTH="15%"><B><A HREF="../../algoanim/util/CodeGroupDisplayOptions.html" title="class in algoanim.util">CodeGroupDisplayOptions</A></B></TD>
|
|
<TD>This is a workaround for the <code>DisplayOptions</code> associated with a code group.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD WIDTH="15%"><B><A HREF="../../algoanim/util/Coordinates.html" title="class in algoanim.util">Coordinates</A></B></TD>
|
|
<TD>A concrete type of a <code>Node</code>.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD WIDTH="15%"><B><A HREF="../../algoanim/util/DisplayOptions.html" title="class in algoanim.util">DisplayOptions</A></B></TD>
|
|
<TD>Abstract class for handling <code>Hidden</code> and
|
|
<code>Timing</code> offset in the definition for a
|
|
<code>Primitive</code>.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD WIDTH="15%"><B><A HREF="../../algoanim/util/Hidden.html" title="class in algoanim.util">Hidden</A></B></TD>
|
|
<TD>A class to flag a <code>Primitive</code> as hidden.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD WIDTH="15%"><B><A HREF="../../algoanim/util/MsTiming.html" title="class in algoanim.util">MsTiming</A></B></TD>
|
|
<TD>A concrete kind of a <code>Timing</code>.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD WIDTH="15%"><B><A HREF="../../algoanim/util/Node.html" title="class in algoanim.util">Node</A></B></TD>
|
|
<TD>This is an abstract representation of a coordinate within the animation
|
|
screen.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD WIDTH="15%"><B><A HREF="../../algoanim/util/Offset.html" title="class in algoanim.util">Offset</A></B></TD>
|
|
<TD>This is a concrete kind of a <code>Node</code>.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD WIDTH="15%"><B><A HREF="../../algoanim/util/OffsetFromLastPosition.html" title="class in algoanim.util">OffsetFromLastPosition</A></B></TD>
|
|
<TD>This is a concrete kind of a <code>Node</code>.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD WIDTH="15%"><B><A HREF="../../algoanim/util/TicksTiming.html" title="class in algoanim.util">TicksTiming</A></B></TD>
|
|
<TD>TicksTiming is a certain kind of a <code>Timing</code> with a numeric
|
|
value measured in ticks.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD WIDTH="15%"><B><A HREF="../../algoanim/util/Timing.html" title="class in algoanim.util">Timing</A></B></TD>
|
|
<TD>An abstract representation of a Timing.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<P>
|
|
<A NAME="package_description"><!-- --></A><H2>
|
|
Package algoanim.util Description
|
|
</H2>
|
|
|
|
<P>
|
|
<h1>Using the classes in the <em>animalscriptapi.util</em> package</h1>
|
|
|
|
<p>The classes in the <em>animalscriptapi.util</em> package are utility
|
|
classes that help in creating animation content. They address three
|
|
different aspects: definitions of <em>nodes, display options,</em> and
|
|
<em>timing</em>.</p>
|
|
|
|
<h2>Node Definition</h2>
|
|
|
|
<p>Many operations in <span style="font-variant: small-caps">AnimalScript</span>
|
|
and thus also in the <span style="font-variant: small-caps">AnimalScript</span> API
|
|
expect the specification of (at least) one node. For example, each graphical object
|
|
will have at least one node to specify its basic location, or to specify the first
|
|
of multiple nodes that define the shape (e.g., a triangle has three nodes).</p>
|
|
|
|
<p>The <span style="font-variant: small-caps">AnimalScript</span> API allows the following
|
|
ways to define a node, based on the (empty) abstract class <em>animalscriptapi.util.Node</em>:</p>
|
|
|
|
<dl>
|
|
<dt>using absolute coordinates</dt>
|
|
<dd>Absolute coordinates specify the node as a pair of <em>x</em> and <em>y</em> positions.
|
|
Use the classe <em>animalscriptapi.util.Coordinates</em> if you want to use absolute
|
|
coordinates. This class expects you to pass in the <em>int</em> values for x and y,
|
|
respectively. Of course, you can use arbitrarily complex arithmetic expressions to
|
|
define the values x and y, but they will ultimately be evaluated to a fixed value when
|
|
the constructor is called.</dd<
|
|
<dt>Using an offset from another element</dt>
|
|
<dd>This more, represented by class <em>animalscriptapi.util.Offset</em>, allows you to
|
|
place an object in relation to another element.
|
|
<ul>
|
|
<li>The other element can be another <em>graphical object</em> - in this case, you have
|
|
to pass this object as a parameter to the constructor call.</li>
|
|
<li>It can also be an other <em>node</em>, such as the "fifth node of this
|
|
polygon" - in this case, you have to pass a <em>Node</em> instance to the constructor
|
|
call.</li>
|
|
<li>Finally, it may also be an offset from a pre-assigned ID - in this case, you have to pass
|
|
the String ID of this ID.</li>
|
|
</ul> In all cases, the constructor also expects the offset (dx, dy) values and the <em>direction</em>.
|
|
Typically, you should use the following direction constants defined in class
|
|
<em>animalscriptapi.animalscript.AnimalScript</em>:
|
|
<ul>
|
|
<li>DIRECTION_NW</li>
|
|
<li>DIRECTION_N</li>
|
|
<li>DIRECTION_NE</li>
|
|
<li>DIRECTION_W</li>
|
|
<li>DIRECTION_C</li>
|
|
<li>DIRECTION_E</li>
|
|
<li>DIRECTION_SW</li>
|
|
<li>DIRECTION_S</li>
|
|
<li>DIRECTION_SE</li>
|
|
<li>DIRECTION_BASELINE_START</li>
|
|
<li>DIRECTION_BASELINE_END</li>
|
|
</ul>
|
|
For all entries except for the last two, the offset will be determined based on the
|
|
<em>bounding box</em> of the underlying reference element. The bounding box of an
|
|
object is defined as the <em>smallest rectangle that completely contains the object</em>.
|
|
The <em>NW, NE, SW, SE</em> values are thus the four corners of this bounding box; <em>N, W, E, S</em>
|
|
are the centers of the box edges, and <em>C</em> is the center of the bounding box.<br />
|
|
"Baseline" refers to the base line of a text. As text characters may extrude under their base
|
|
line (e.g., for "g", "p" and "q"), the "SW" coordinate of the bounding box for a text may not
|
|
have the same y coordinate as the text itself.</dd>
|
|
</dl>
|
|
|
|
<h2>Display Option</h2>
|
|
|
|
<p>Display options toggle the display of a given graphical object. They are not concerned
|
|
with attributes such as color or depth of the object, but rather concerned with <em>whether</em>
|
|
and <em>how</em> a given object will appear.</p>
|
|
|
|
<p>The base class for display options is the abstract class <em>animalscriptapi.util.DisplayOptions</em>.
|
|
Its (empty) subclass <em>animalscriptapi.util.Hidden</em> should be used when a given primitive
|
|
is supposed to be invisible (hidden from the viewer).</p>
|
|
|
|
<p><em>Code groups</em> also have a special display options class, called <em>animalscriptapi.util.CodeGroupDisplayOptions</em>.
|
|
In this class, the user can specify both the <em>offset</em> (how long after the start of a given step
|
|
will it take before the code group starts to be displayed?) and the <em>duration</em> (how much time will
|
|
the code group take from the offset until all elements are shown?).</p>
|
|
|
|
<p><em>Arrays</em> also have thei own display options class: <em>animalscriptapi.util.ArrayDisplayOptions</em>.
|
|
This class uses the <em>offset</em> and <em>duration</em> described above for code groups. Additionally,
|
|
they have a boolean option <em>isCascaded</em>. If this option is set to <em>true</em>, the array
|
|
will be shown element by element, instead of all elements at the same time.</p>
|
|
|
|
<h2>Timing Specification</h2>
|
|
|
|
<p>Timing is used in the <span style="font-variant: small-caps">AnimalScript</span> API to specify when
|
|
effects start and how long they take. They are based on the class <em>animalscriptapi.util.Timing</em>,
|
|
another subclass of <em>animalscriptapi.util.DisplayOptions</em> described above. Currently,
|
|
the <span style="font-variant: small-caps">AnimalScript</span> API supports the following timing-related
|
|
classes:
|
|
|
|
<dl>
|
|
<dt>animalscriptapi.util.Timing</dt>
|
|
<dd>This class allows setting only one <em>time value</em> as an int. This method is inherited by subclasses.
|
|
Please note that this class is <em>abstract</em>!</dd>
|
|
<dt>MsTiming</dt>
|
|
<dd>This class represents timing information measured on a millisecond (ms) base. Its constructor
|
|
expects only the number of time units as an int value.</dd>
|
|
<dt>TicksTiming</dt>
|
|
<dd>This class represents timing information measured by the number of animation frames ("ticks"). Its constructor
|
|
expects only the number of time units as an int value.</dd>
|
|
</dl>
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
</DL>
|
|
<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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.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-files/index-1.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="../../algoanim/properties/items/package-summary.html"><B>PREV PACKAGE</B></A>
|
|
<A HREF="../../algoanim/variables/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?algoanim/util/package-summary.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="package-summary.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>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
|
|
</BODY>
|
|
</HTML>
|