svx/source/sdr/contact/viewcontact.cxx

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