| <html> |
| <head> |
| <title>Interface XCustomSprite</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="XCustomSprite-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"><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" 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 XCustomSprite</td> |
| <td width="*"/></tr> |
| </table> |
| </td> |
| </tr> |
| <tr> |
| <td><dl> |
| <dt><b>Base Interfaces</b></dt> |
| <dd><pre style="font-family:monospace;"><strong>XCustomSprite</strong> |
| ┗ <a href="XSprite.html">XSprite</a> |
| ┗ ::com::sun::star::uno::XInterface |
| |
| </pre></dd> |
| <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> |
| <tr> |
| <td class="imsum_left"><a href="XSprite.html">XSprite</a></td> |
| <td class="imsum_right"><dl> |
| <dt>(referenced interface's summary:)</dt> |
| <dd>Interface to control a sprite object. </dd> |
| </dl> |
| </td> |
| </tr> |
| </table> |
| </dd> |
| </dl> |
| </td> |
| </tr> |
| <tr> |
| <td><dl> |
| <dt><b>Description</b></dt> |
| <dd>Interface to control a custom sprite object on a XSpriteCanvas. </dd> |
| <dd><p> |
| |
| Every change performed on XCustomSprite objects is only visible |
| after a XSpriteCanvas::updateScreen() call, to facilitate |
| synchronized screen updates. |
| |
| TODO: Maybe more than alpha has to be overridden from render state. |
| TODO: Provide means to change the output area |
| </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="#getContentCanvas">getContentCanvas</a></td> |
| <td class="imsum_right">Query a render canvas for this sprite's content. </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="getContentCanvas" class="membertitle">getContentCanvas</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="XCanvas.html">XCanvas</a></td> |
| </tr> |
| <tr> |
| <td valign="top"><b>getContentCanvas</b>();</td> |
| </tr> |
| </table> |
| <hr> |
| <dl> |
| <dt><b>Description</b></dt> |
| <dd>Query a render canvas for this sprite's content. </dd> |
| <dd><p> |
| |
| Whatever is rendered to this canvas will become visible on the |
| screen only after a XSpriteCanvas::updateScreen() call at the |
| associated sprite canvas. This canvas is not equivalent to the |
| host canvas of the sprite. At the very least, all output |
| happens relative to the sprite's upper left corner, i.e. the |
| origin of the sprite's canvas device coordinate system will |
| move with the sprite across the screen. |
| |
| @attention Everytime the XCustomSprite is updated, the content |
| canvas must be quried via this method. You are, on the other |
| hand, allowed to temporarily store the canvas while rendering |
| a single sprite update. You might even store the canvas |
| between subsequent calls to getContentCanvas(), but should be |
| aware of the fact that the returned interface might be a |
| different object everytime. |
| |
| @attention Since changes to the sprite content will become |
| visible after a XSpriteCanvas::updateScreen(), calls to this |
| method must be synchronized externally. Otherwise, the sprite |
| content rendered to screen is undefined. This is nothing the |
| XCustomSprite can or will manage by itself. |
| |
| </dd> |
| <dt><b>Returns</b></dt> |
| <dd>the canvas the sprite content can be rendered into. |
| </dd> |
| </dl> |
| </td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2003 Sun Microsystems, Inc.</p> |
| |
| </div> <!-- id="adc-idlref" --> |
| </body> |
| |
| </html> |
