summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/graphic/XPrimitive2D.idl
blob: d6a230d722d807b6501acd374b7f716edc294f99 (plain)
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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_graphic_XPrimitive2D_idl__
#define __com_sun_star_graphic_XPrimitive2D_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/beans/PropertyValue.idl>
#include <com/sun/star/geometry/RealRectangle2D.idl>

module com {  module sun {  module star {  module graphic {

/** XPrimitive2D interface

    This is the basic interface for 2D graphic primitives. They need to be able
    - to provide a decomposition consisting of simpler graphic primitives
    - to provide a 2D bound rectangle as a 2D range
 */
interface XPrimitive2D : ::com::sun::star::uno::XInterface
{
    /** Retrieve decomposed list of simpler primitives

        @param aViewParameters
        2D View-specific parameter set. The defined but not mandatory
        parameters include:

        ::com::sun::star::geometry::AffineMatrix2D ObjectTransformation

        A transformation matrix which maps between object coordinates
        (which is equal to object's local coordinates) to world
        coordinates. If not defined, the identity transformation is
        implied.

        ::com::sun::star::geometry::AffineMatrix2D ViewTransformation

        A transformation matrix which maps between world coordinates
        to view coordinates, i.e. usually the actual pixel on
        screen. If not defined, the identity transformation is
        implied.

        ::com::sun::star::geometry::RealRectangle2D Viewport

        Defines the visible part of the view in world coordinates. May be used
        to optimize decompositions, e.g. for 3D scenes only the visible part
        needs to be created. If not given, an empty Viewport is implied which
        means all is visible.

        double Time

        Defines the point in time for which the geometry is defined. This may
        lead to varied results for animated objects. This value is defined in the
        range [0.0 .. n[, negative values are not allowed. If not given, a value of
        0.0 is implied.

        ::com::sun::star::drawing::XDrawPage VisualizedPage

        The page object this is displayed on. Used to e.g. resolve
        page number placeholders and the like.
     */
    sequence< XPrimitive2D > getDecomposition( [in] sequence< ::com::sun::star::beans::PropertyValue > aViewParameters );

    /** Retrieve bound rect of primitive

        This method calculates the actual bound rect of the area in
        <em>world coordinates</em>. Note that for view-dependent primitives,
        the necessary pixel adjustments are taken into account. For that reason
        the ViewParameters need to be given.

        @param aViewParameters
        2D View-specific parameter set, same as in getDecomposition.
     */
    ::com::sun::star::geometry::RealRectangle2D getRange( [in] sequence< ::com::sun::star::beans::PropertyValue > aViewParameters );
};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */