include/svx/helperhittest3d.hxx

   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 #ifndef INCLUDED_SVX_HELPERHITTEST3D_HXX
  21 #define INCLUDED_SVX_HELPERHITTEST3D_HXX
  22
  23 #include <svx/svxdllapi.h>
  24 #include <sal/types.h>
  25 #include <vector>
  26
  27
  28 // predefines
  29
  30 namespace basegfx {
  31     class B2DPoint;
  32 }
  33
  34 namespace drawinglayer { namespace geometry {
  35     class ViewInformation3D;
  36 }}
  37
  38 class E3dCompoundObject;
  39 class E3dScene;
  40
  41
  42
  43 /** support for getting a ViewInformation3D for a given CompoudObject3D
  44     with correct ObjectTransformation filled out
  45
  46     @param o_rViewInformation3D
  47     The ViewInformation3D created which will be overwritten
  48
  49     @param rCandidate
  50     The E3dCompoundObject for which the ViewInformation3D shall be
  51     prepared
  52
  53     @return
  54     A pointer to the found and used root scene. This is also a hint
  55     if the operation succeeded or not, since when object has no root
  56     scene (is not inserted to a model), an empty ViewInformation3D
  57     will be used
  58 */
  59 E3dScene* fillViewInformation3DForCompoundObject(
  60     drawinglayer::geometry::ViewInformation3D& o_rViewInformation3D,
  61     const E3dCompoundObject& rCandidate);
  62
  63 /** support for getting all from a 2d position hit objects in a 3d scene
  64     in a depth sorted array
  65
  66     @param rPoint
  67     2D Point in view coordinates
  68
  69     @param rScene
  70     The 3D Scene for HitTest
  71
  72     @param o_rResult
  73     Output parameter which contains all hit 3D objects inside rScene. This
  74     vector will be changed in any case. If it's empty, no hit exists. If it's
  75     not empty, the first object is the object closest to the viewer
  76
  77 */
  78 SVX_DLLPUBLIC void getAllHit3DObjectsSortedFrontToBack(
  79     const basegfx::B2DPoint& rPoint,
  80     const E3dScene& rScene,
  81     ::std::vector< const E3dCompoundObject* >& o_rResult);
  82
  83 /** support for checking if the single given 3d object is hit at position
  84
  85     @param rPoint
  86     2D Point in view coordinates
  87
  88     @param rCandidate
  89     The 3D Object which needs checking
  90
  91     @return
  92     true if hit, false if not
  93 */
  94 bool checkHitSingle3DObject(
  95     const basegfx::B2DPoint& rPoint,
  96     const E3dCompoundObject& rCandidate);
  97
  98
  99
 100 #endif // INCLUDED_SVX_HELPERHITTEST3D_HXX
 101
 102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */