svx/source/sdr/contact/viewcontact.cxx

   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 #include <svx/sdr/contact/viewcontact.hxx>
  21 #include <svx/sdr/contact/viewobjectcontact.hxx>
  22 #include <svx/sdr/contact/objectcontact.hxx>
  23 #include <basegfx/polygon/b2dpolygon.hxx>
  24 #include <basegfx/polygon/b2dpolygontools.hxx>
  25 #include <basegfx/color/bcolor.hxx>
  26 #include <drawinglayer/primitive2d/polygonprimitive2d.hxx>
  27 #include <basegfx/matrix/b2dhommatrix.hxx>
  28 #include <sdr/contact/objectcontactofpageview.hxx>
  29 #include <tools/debug.hxx>
  30
  31 namespace sdr { namespace contact {
  32
  33 // Create a Object-Specific ViewObjectContact, set ViewContact and
  34 // ObjectContact. Always needs to return something. Default is to create
  35 // a standard ViewObjectContact containing the given ObjectContact and *this
  36 ViewObjectContact& ViewContact::CreateObjectSpecificViewObjectContact(ObjectContact& rObjectContact)
  37 {
  38     return *(new ViewObjectContact(rObjectContact, *this));
  39 }
  40
  41 ViewContact::ViewContact()
  42 :   maViewObjectContactVector(),
  43     mxViewIndependentPrimitive2DSequence()
  44 {
  45 }
  46
  47 ViewContact::~ViewContact()
  48 {
  49     deleteAllVOCs();
  50 }
  51
  52 void ViewContact::deleteAllVOCs()
  53 {
  54     // get rid of all VOCs
  55     // #i84257# To avoid that each 'delete pCandidate' again uses
  56     // the local RemoveViewObjectContact with a search and removal in the
  57     // vector, simply copy and clear local vector.
  58     std::vector< ViewObjectContact* > aLocalVOCList(maViewObjectContactVector);
  59     maViewObjectContactVector.clear();
  60
  61     while(!aLocalVOCList.empty())
  62     {
  63         ViewObjectContact* pCandidate = aLocalVOCList.back();
  64         aLocalVOCList.pop_back();
  65         DBG_ASSERT(pCandidate, "Corrupted ViewObjectContactList in VC (!)");
  66
  67         // ViewObjectContacts only make sense with View and Object contacts.
  68         // When the contact to the SdrObject is deleted like in this case,
  69         // all ViewObjectContacts can be deleted, too.
  70         delete pCandidate;
  71     }
  72
  73     // assert when there were new entries added during deletion
  74     DBG_ASSERT(maViewObjectContactVector.empty(), "Corrupted ViewObjectContactList in VC (!)");
  75 }
  76
  77 // get a Object-specific ViewObjectContact for a specific
  78 // ObjectContact (->View). Always needs to return something.
  79 ViewObjectContact& ViewContact::GetViewObjectContact(ObjectContact& rObjectContact)
  80 {
  81     ViewObjectContact* pRetval = nullptr;
  82     const sal_uInt32 nCount(maViewObjectContactVector.size());
  83
  84     // first search if there exists a VOC for the given OC
  85     for(sal_uInt32 a(0); !pRetval && a < nCount; a++)
  86     {
  87         ViewObjectContact* pCandidate = maViewObjectContactVector[a];
  88         DBG_ASSERT(pCandidate, "Corrupted ViewObjectContactList (!)");
  89
  90         if(&(pCandidate->GetObjectContact()) == &rObjectContact)
  91         {
  92             pRetval = pCandidate;
  93         }
  94     }
  95
  96     if(!pRetval)
  97     {
  98         // create a new one. It's inserted to the local list from the
  99         // ViewObjectContact constructor via AddViewObjectContact()
 100         pRetval = &CreateObjectSpecificViewObjectContact(rObjectContact);
 101     }
 102
 103     return *pRetval;
 104 }
 105
 106 // A new ViewObjectContact was created and shall be remembered.
 107 void ViewContact::AddViewObjectContact(ViewObjectContact& rVOContact)
 108 {
 109     maViewObjectContactVector.push_back(&rVOContact);
 110 }
 111
 112 // A ViewObjectContact was deleted and shall be forgotten.
 113 void ViewContact::RemoveViewObjectContact(ViewObjectContact& rVOContact)
 114 {
 115     std::vector< ViewObjectContact* >::iterator aFindResult = std::find(maViewObjectContactVector.begin(), maViewObjectContactVector.end(), &rVOContact);
 116
 117     if(aFindResult != maViewObjectContactVector.end())
 118     {
 119         maViewObjectContactVector.erase(aFindResult);
 120     }
 121 }
 122
 123 // Test if this ViewContact has ViewObjectContacts at all. This can
 124 // be used to test if this ViewContact is visualized ATM or not
 125 bool ViewContact::HasViewObjectContacts() const
 126 {
 127     const sal_uInt32 nCount(maViewObjectContactVector.size());
 128
 129     for(sal_uInt32 a(0); a < nCount; a++)
 130     {
 131         if(!maViewObjectContactVector[a]->GetObjectContact().IsPreviewRenderer())
 132         {
 133             return true;
 134         }
 135     }
 136     return false;
 137 }
 138
 139 // Test if this ViewContact has ViewObjectContacts at all. This can
 140 // be used to test if this ViewContact is visualized ATM or not
 141 bool ViewContact::isAnimatedInAnyViewObjectContact() const
 142 {
 143     const sal_uInt32 nCount(maViewObjectContactVector.size());
 144
 145     for(sal_uInt32 a(0); a < nCount; a++)
 146     {
 147         if(maViewObjectContactVector[a]->isAnimated())
 148         {
 149             return true;
 150         }
 151     }
 152
 153     return false;
 154 }
 155
 156 // Access to possible sub-hierarchy and parent. GetObjectCount() default is 0L
 157 // and GetViewContact default pops up an assert since it's an error if
 158 // GetObjectCount has a result != 0 and it's not overridden.
 159 sal_uInt32 ViewContact::GetObjectCount() const
 160 {
 161     // no sub-objects
 162     return 0;
 163 }
 164
 165 ViewContact& ViewContact::GetViewContact(sal_uInt32 /*nIndex*/) const
 166 {
 167     // This is the default implementation; call would be an error
 168     OSL_FAIL("ViewContact::GetViewContact: This call needs to be overridden when GetObjectCount() can return results != 0 (!)");
 169     return (ViewContact&)(*this);
 170 }
 171
 172 ViewContact* ViewContact::GetParentContact() const
 173 {
 174     // default has no parent
 175     return nullptr;
 176 }
 177
 178 void ViewContact::ActionChildInserted(ViewContact& rChild)
 179 {
 180     // propagate change to all exsisting visualisations which
 181     // will force a VOC for the new child and invalidate its range
 182     const sal_uInt32 nCount(maViewObjectContactVector.size());
 183
 184     for(sal_uInt32 a(0); a < nCount; a++)
 185     {
 186         ViewObjectContact* pCandidate = maViewObjectContactVector[a];
 187         DBG_ASSERT(pCandidate, "ViewContact::GetViewObjectContact() invalid ViewObjectContactList (!)");
 188
 189         // take action at all VOCs. At the VOCs ObjectContact the initial
 190         // rectangle will be invalidated at the associated OutputDevice.
 191         pCandidate->ActionChildInserted(rChild);
 192     }
 193 }
 194
 195 // React on changes of the object of this ViewContact
 196 void ViewContact::ActionChanged()
 197 {
 198     // propagate change to all existing VOCs. This will invalidate
 199     // all drawn visualisations in all known views
 200     const sal_uInt32 nCount(maViewObjectContactVector.size());
 201
 202     for(sal_uInt32 a(0); a < nCount; a++)
 203     {
 204         ViewObjectContact* pCandidate = maViewObjectContactVector[a];
 205         DBG_ASSERT(pCandidate, "ViewContact::GetViewObjectContact() invalid ViewObjectContactList (!)");
 206
 207         pCandidate->ActionChanged();
 208     }
 209 }
 210
 211 // access to SdrObject and/or SdrPage. May return 0L like the default
 212 // implementations do. Override as needed.
 213 SdrObject* ViewContact::TryToGetSdrObject() const
 214 {
 215     return nullptr;
 216 }
 217
 218 // primitive stuff
 219
 220 drawinglayer::primitive2d::Primitive2DContainer ViewContact::createViewIndependentPrimitive2DSequence() const
 221 {
 222     // This is the default implementation and should never be called (see header). If this is called,
 223     // someone implemented a ViewContact (VC) visualisation object without defining the visualisation by
 224     // providing a sequence of primitives -> which cannot be correct.
 225     // Since we have no access to any known model data here, the default implementation creates a yellow placeholder
 226     // hairline polygon with a default size of (1000, 1000, 5000, 3000)
 227     OSL_FAIL("ViewContact::createViewIndependentPrimitive2DSequence(): Never call the fallback base implementation, this is always an error (!)");
 228     const basegfx::B2DPolygon aOutline(basegfx::tools::createPolygonFromRect(basegfx::B2DRange(1000.0, 1000.0, 5000.0, 3000.0)));
 229     const basegfx::BColor aYellow(1.0, 1.0, 0.0);
 230     const drawinglayer::primitive2d::Primitive2DReference xReference(
 231         new drawinglayer::primitive2d::PolygonHairlinePrimitive2D(aOutline, aYellow));
 232
 233     return drawinglayer::primitive2d::Primitive2DContainer { xReference };
 234 }
 235
 236 drawinglayer::primitive2d::Primitive2DContainer const & ViewContact::getViewIndependentPrimitive2DContainer() const
 237 {
 238     // local up-to-date checks. Create new list and compare.
 239     drawinglayer::primitive2d::Primitive2DContainer xNew(createViewIndependentPrimitive2DSequence());
 240
 241     if(!xNew.empty())
 242     {
 243         // allow evtl. embedding in object-specific infos, e.g. Name, Title, Description
 244         xNew = embedToObjectSpecificInformation(xNew);
 245     }
 246
 247     if(mxViewIndependentPrimitive2DSequence != xNew)
 248     {
 249         // has changed, copy content
 250         const_cast< ViewContact* >(this)->mxViewIndependentPrimitive2DSequence = xNew;
 251     }
 252
 253     // return current Primitive2DContainer
 254     return mxViewIndependentPrimitive2DSequence;
 255 }
 256
 257 // add Gluepoints (if available)
 258 drawinglayer::primitive2d::Primitive2DContainer ViewContact::createGluePointPrimitive2DSequence() const
 259 {
 260     // default returns empty reference
 261     return drawinglayer::primitive2d::Primitive2DContainer();
 262 }
 263
 264 drawinglayer::primitive2d::Primitive2DContainer ViewContact::embedToObjectSpecificInformation(const drawinglayer::primitive2d::Primitive2DContainer& rSource) const
 265 {
 266     // nothing to do for default
 267     return rSource;
 268 }
 269
 270 basegfx::B2DRange ViewContact::getRange( const drawinglayer::geometry::ViewInformation2D& /*rViewInfo2D*/ ) const
 271 {
 272     // Return empty range.
 273     return basegfx::B2DRange();
 274 }
 275
 276 void ViewContact::flushViewObjectContacts(bool bWithHierarchy)
 277 {
 278     if(bWithHierarchy)
 279     {
 280         // flush DrawingLayer hierarchy
 281         const sal_uInt32 nCount(GetObjectCount());
 282
 283         for(sal_uInt32 a(0); a < nCount; a++)
 284         {
 285             ViewContact& rChild = GetViewContact(a);
 286             rChild.flushViewObjectContacts(bWithHierarchy);
 287         }
 288     }
 289
 290     // delete local VOCs
 291     deleteAllVOCs();
 292 }
 293
 294 }}
 295
 296 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */