include/drawinglayer/primitive3d/hiddengeometryprimitive3d.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_DRAWINGLAYER_PRIMITIVE3D_HIDDENGEOMETRYPRIMITIVE3D_HXX
  21 #define INCLUDED_DRAWINGLAYER_PRIMITIVE3D_HIDDENGEOMETRYPRIMITIVE3D_HXX
  22
  23 #include <drawinglayer/drawinglayerdllapi.h>
  24
  25 #include <drawinglayer/primitive3d/groupprimitive3d.hxx>
  26
  27 //////////////////////////////////////////////////////////////////////////////
  28
  29 namespace drawinglayer
  30 {
  31     namespace primitive3d
  32     {
  33         // This primitive is used to represent geometry for non-visible objects,
  34         // e.g. a 3D cube without fill attributes. To still be able to use
  35         // primitives for HitTest functionality, the 3d decompositions produce
  36         // an as much as possible simplified fill geometry encapsulated in this
  37         // primtive when there is no fill geometry. Currently, the 3d hit test
  38         // uses only areas, so maybe in a further enchanced version this will change
  39         // to 'if neither filled nor lines' creation criteria. The whole primitive
  40         // decomposes to nothing, so no one not knowing it will be influenced. Only
  41         // helper processors for hit test (and maybe BoundRect extractors) will
  42         // use it and it's children subcontent.
  43         class DRAWINGLAYER_DLLPUBLIC HiddenGeometryPrimitive3D : public GroupPrimitive3D
  44         {
  45         public:
  46             explicit HiddenGeometryPrimitive3D(const Primitive3DSequence& rChildren);
  47
  48             // despite returning an empty decomposition since it's no visualisation data,
  49             // range calculation is intended to use hidden geometry, so
  50             // the local implementation will return the children's range
  51             virtual basegfx::B3DRange getB3DRange(const geometry::ViewInformation3D& rViewInformation) const;
  52
  53             /// The default implementation returns an empty sequence
  54             virtual Primitive3DSequence get3DDecomposition(const geometry::ViewInformation3D& rViewInformation) const;
  55
  56             // provide unique ID
  57             DeclPrimitive3DIDBlock()
  58         };
  59     } // end of namespace primitive3d
  60 } // end of namespace drawinglayer
  61
  62 //////////////////////////////////////////////////////////////////////////////
  63
  64 #endif //INCLUDED_DRAWINGLAYER_PRIMITIVE3D_HIDDENGEOMETRYPRIMITIVE3D_HXX
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */