1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/*************************************************************************
*
* $RCSfile: XCustomSprite.idl,v $
*
* $Revision: 1.2 $
*
* last change: $Author: vg $ $Date: 2005-03-10 12:33:30 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_rendering_XCustomSprite_idl__
#define __com_sun_star_rendering_XCustomSprite_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_rendering_ViewState_idl__
#include <com/sun/star/rendering/ViewState.idl>
#endif
#ifndef __com_sun_star_rendering_RenderState_idl__
#include <com/sun/star/rendering/RenderState.idl>
#endif
#ifndef __com_sun_star_rendering_XSprite_idl__
#include <com/sun/star/rendering/XSprite.idl>
#endif
module com { module sun { module star { module rendering {
interface XCanvas;
/** Interface to control a custom sprite object on a XSpriteCanvas.<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
*/
interface XCustomSprite : XSprite
{
/** Query a render canvas for this sprite's content.<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.
@return the canvas the sprite content can be rendered into.
*/
XCanvas getContentCanvas();
};
}; }; }; };
#endif
|
