svx/source/engine3d/helperminimaldepth3d.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: helperminimaldepth3d.hxx,v $
  10  * $Revision: 1.1.2.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SVX_HELPERMINIMALDEPTH_HXX
  32 #define INCLUDED_SVX_HELPERMINIMALDEPTH_HXX
  33
  34 #include <sal/types.h>
  35
  36 //////////////////////////////////////////////////////////////////////////////
  37 // predefines
  38
  39 class E3dCompoundObject;
  40 class E3dScene;
  41
  42 //////////////////////////////////////////////////////////////////////////////
  43 /** support extracting the minimal depth of a 3d object in it's scene
  44
  45     @param rObject
  46     The 3D Object from which the minimal depth needs to be calculated. The scene
  47     is defined by the object already
  48
  49     @return
  50     The minimal depth of this object in unified ViewCoordinates. This is the
  51     Z-Coordinate of one object point in the range of [0.0 .. 1.0]. ViewCoordinates
  52     means the transformations (esp. rotation) of the scene are taken into account
  53
  54 */
  55 // support extracting the minimal depth of a 3d object in it's scene
  56
  57 double getMinimalDepthInViewCoordinates(const E3dCompoundObject& rObject);
  58
  59 //////////////////////////////////////////////////////////////////////////////
  60
  61 #endif // INCLUDED_SVX_HELPERMINIMALDEPTH_HXX
  62
  63 // eof