blob: 197ff39972d606ef10c527472a949ed2b470dd4c [file]
<html>
<head>
<title>Interface XSprite</title>
<style>h3 { font-size:13pt; font-weight:bold; margin-top:3pt; margin-bottom:1pt; }
p, dt, dd, pre { font-size:11pt; margin-top:3pt; margin-bottom:1pt; }
table.lightbg { background-color:#eeeeff; }
table.subtitle { margin-top:6pt; margin-bottom:6pt; }
td { font-size:11pt; }
td.title { font-family: Arial; font-size:19pt; font-weight:bold; text-align:center; background-color:#ccccff; line-height:30pt; }
td.subtitle { font-family: Arial; font-size:13pt; background-color:#ccccff; line-height:20pt; }
td.imdetail { width:100%; background-color:#eeeeff; }
a.membertitle { font-size:12pt; font-weight:bold; line-height:18pt; }
td.imsum_left { width:30%; }
td.imsum_right { width:70%; }
td.navimain, a.navimain { text-align:center; font-family: Arial; font-size:12pt; font-weight:bold; }
td.navimainself { text-align:center; font-family: Arial; font-size:12pt; font-weight:bold; color:#ffffff; background-color:#2222ad; }
td.navimainnone { text-align:center; font-family: Arial; font-size:12pt; }
td.attrtitle { font-weight:bold; background-color:#eeeeff; }
td.navisub, a.navisub, td.attrtitle, td.attrvalue { text-align:center; font-family: Arial; font-size:9pt; font-variant:small-caps; }
td.navimain, td.navisub { padding-left:7pt; padding-right:7pt; }
p.raise { font-size:11pt; margin-top:0pt; text-align:right; padding-right:5pt; }
a.navimain, a.navisub { color:#000000; }
.dt { font-weight:bold; }
.namechain { font-size:13pt; font-weight:bold; margin-top:3pt; margin-bottom:6pt; }
.tpl { font-size:13pt; margin-top:3pt; margin-bottom:6pt; }
</style>
<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
</head>
<body bgcolor="#ffffff">
<a name="_top_"> </a>
<table border="0" cellpadding="3" class="lightbg">
<tr>
<td class="navimain"><a href="com/sun/star/module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XSprite-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="module-ix.html" class="namechain">::</a> </p>
</td>
</tr>
<tr>
<td class="title">interface XSprite</td>
</tr>
<tr>
<td/></tr>
<tr>
<td/></tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#startAnimation">startAnimation</a></td>
<td class="imsum_right"> Start animation sequence of this sprite. The speed of the
animation is given in frames per second.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#stopAnimation">stopAnimation</a></td>
<td class="imsum_right"> Stop the animation sequence. A subsequent startAnimation will
commence the sequence at the point where it was stopped with
stopAnimation.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#resetAnimation">resetAnimation</a></td>
<td class="imsum_right"> Reset the animation sequence to start with the first frame. If
the animation is currently running, the next frame that is
drawn after this method has finished, will be the first one.
</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setTransparency">setTransparency</a></td>
<td class="imsum_right"> Set overall transparency of the sprite. Useful for e.g. fading
in/out of animations.
</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="startAnimation" class="membertitle">startAnimation</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">void<br>
<b>startAnimation</b>(</td>
<td valign="top">&nbsp;<br>
[in] double</td>
<td valign="top">&nbsp;<br>
speed );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Start animation sequence of this sprite. The speed of the
animation is given in frames per second.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="stopAnimation" class="membertitle">stopAnimation</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">void<br>
<b>stopAnimation</b>();</td>
<td valign="top">&nbsp;<br>
</td>
<td valign="top">&nbsp;<br>
</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Stop the animation sequence. A subsequent startAnimation will
commence the sequence at the point where it was stopped with
stopAnimation.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="resetAnimation" class="membertitle">resetAnimation</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">void<br>
<b>resetAnimation</b>();</td>
<td valign="top">&nbsp;<br>
</td>
<td valign="top">&nbsp;<br>
</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Reset the animation sequence to start with the first frame. If
the animation is currently running, the next frame that is
drawn after this method has finished, will be the first one.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setTransparency" class="membertitle">setTransparency</a>
<table border="0" width="96%" cellpadding="5" cellspacing="0" bgcolor="#ffffff" align="center">
<tr>
<td><table border="0">
<tr>
<td valign="top">void<br>
<b>setTransparency</b>(</td>
<td valign="top">&nbsp;<br>
[in] double</td>
<td valign="top">&nbsp;<br>
alpha );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd> Set overall transparency of the sprite. Useful for e.g. fading
in/out of animations.
</dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2003 Sun Microsystems, Inc.</p>
</body>
</html>