svx/source/engine3d/helperminimaldepth3d.hxx

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