offapi/com/sun/star/graphic/XPrimitive3D.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com {  module sun {  module star {  module graphic {
  21
  22 /** XPrimitive3D interface
  23
  24     This is the basic interface for graphic 3D primitives. They need to be able
  25     - to provide a decomposition consisting of simpler graphic primitives
  26     - to provide a 3D bound rectangle as a 3D range
  27  */
  28 interface XPrimitive3D : ::com::sun::star::uno::XInterface
  29 {
  30     /** Retrieve decomposed list of simpler primitives
  31
  32         @param aViewParameters
  33         3D View-specific parameter set. The defined but not mandatory
  34         parameters include:
  35
  36         double Time
  37
  38         Defines the point in time for which the geometry is defined. This may
  39         lead to varied results for animated objects. This value is defined in the
  40         range [0.0 .. n[, negative values are not allowed. If not given, a value of
  41         0.0 is implied.
  42      */
  43     sequence< XPrimitive3D > getDecomposition( [in] sequence< ::com::sun::star::beans::PropertyValue > aViewParameters );
  44
  45     /** Retrieve bound rect of primitive
  46
  47         This method calculates the actual bound rect of the area in
  48         <em>world coordinates</em>. Note that for view-dependent primitives,
  49         the necessary pixel adjustments are taken into account. For that reason
  50         the ViewParameters need to be given.
  51
  52         @param aViewParameters
  53         3D View-specific parameter set, same as in getDecomposition.
  54      */
  55     ::com::sun::star::geometry::RealRectangle3D getRange( [in] sequence< ::com::sun::star::beans::PropertyValue > aViewParameters );
  56 };
  57
  58 }; }; }; };
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */