<html> <head> <title>Interface XAnimation</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../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="XAnimation-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 class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">rendering</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XAnimation</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>This interface defines an animation sequence.</dd> <dd><p> This interface must be implemented by every animation object. It is used by the <a href="XCanvas.html">XCanvas</a> interface to render generic animations.<p> </dd> <dt><b>Since </b></dt> <dd>OOo 2.0 </dd> </dl> </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="#render">render</a></td> <td class="imsum_right">Render the animation content at time t into the specified canvas. </td> </tr> <tr> <td class="imsum_left"><a href="#getAnimationAttributes">getAnimationAttributes</a></td> <td class="imsum_right">Request the attribute information for this animation. </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="render" class="membertitle">render</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>render</b>(</td> <td valign="top">[in] <a href="XCanvas.html">XCanvas</a></td> <td valign="bottom"> canvas,</td> </tr> <tr> <td/><td valign="top">[in] <a href="ViewState.html">ViewState</a></td> <td valign="bottom"> viewState,</td> </tr> <tr> <td/><td valign="top">[in] double</td> <td valign="bottom"> t )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Render the animation content at time t into the specified canvas.</dd> <dd><p> Note that it is perfectly legal to e.g. map t in a nonlinear fashion to internal frames, for example to achieve acceleration or deceleration effects. It is required that the render method has const semantics, i.e. when called with the same parameter set, identical output must be generated. This is because e.g. a Sprite might decide arbitrarily to render an animation once and cache the result, or repaint it via XAnimation::render everytime.<p> The rendered content, although, must be exactly the same for identical viewState, canvas and t values. Or, for that matters, must call the same canvas methods in the same order with the same parameter sets, for identical viewState and t values. Furthermore, when viewState has the identity transformation set, rendered output must be contained in a rectangle with upper left corner at (0,0) and width and height given by the AnimationAttributes' untransformedSize member. Any content exceeding this box might get clipped off.<p> </dd> <dt><b>Parameter canvas</b></dt> <dd>The target canvas to render this animation to. </dd> <dt><b>Parameter viewState</b></dt> <dd>The view state to be used when rendering this animation to the target canvas. The view transformation matrix must not be singular. </dd> <dt><b>Parameter t</b></dt> <dd>Time instant for which animation content is requested. The range must always be [0,1], where 0 denotes the very beginning, and 1 the end of the animation sequence. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if one of the passed parameters does not lie in the specified, permissible range. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAnimationAttributes" class="membertitle">getAnimationAttributes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="AnimationAttributes.html">AnimationAttributes</a></td> </tr> <tr> <td valign="top"><b>getAnimationAttributes</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Request the attribute information for this animation.</dd> <dd><p> This method returns the <a href="AnimationAttributes.html">AnimationAttributes</a> structure, which defines more closely how to play this animation.<p> </dd> <dt><b>Returns</b></dt> <dd>the requested <a href="AnimationAttributes.html">AnimationAttributes</a> structure. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
