summaryrefslogtreecommitdiffstats
path: root/include/svx/sdr/contact/viewobjectcontact.hxx
blob: 1be4cac81052929b48cf0cc6cc3e948768867154 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_SVX_SDR_CONTACT_VIEWOBJECTCONTACT_HXX
#define INCLUDED_SVX_SDR_CONTACT_VIEWOBJECTCONTACT_HXX

#include <memory>
#include <svx/svxdllapi.h>
#include <drawinglayer/primitive2d/Primitive2DContainer.hxx>

namespace vcl { class Region; }

namespace sdr::animation {
    class PrimitiveAnimation;
}
namespace drawinglayer::primitive2d { class Primitive2DDecompositionVisitor; }

namespace sdr::contact {

class DisplayInfo;
class ObjectContact;
class ViewContact;
class ViewObjectContactRedirector;

class SVXCORE_DLLPUBLIC ViewObjectContact
{
private:
    // must-exist and constant contacts
    ObjectContact&                                  mrObjectContact;
    ViewContact&                                    mrViewContact;

    // This range defines the object's BoundRect
    basegfx::B2DRange                               maObjectRange;

    // PrimitiveSequence of the ViewContact. This contains all necessary information
    // for the graphical visualisation and needs to be supported by all VCs which
    // can be visualized.
    drawinglayer::primitive2d::Primitive2DContainer  mxPrimitive2DSequence;

    // the PrimitiveAnimation if Primitive2DContainer contains animations
    std::unique_ptr<sdr::animation::PrimitiveAnimation> mpPrimitiveAnimation;

    // possible on-demand calculated GridOffset for non-linear ViewToDevice transformation (calc)
    basegfx::B2DVector                              maGridOffset;

    // used to detect ActionChanged() during primitive construction
    int                                             mnActionChangedCount;

    // This bool gets set when the object gets invalidated by ActionChanged() and
    // can be used from the OC to late-invalidates
    bool                                            mbLazyInvalidate : 1;

protected:
    // make redirector a protected friend, it needs to call createPrimitives as default action
    friend class ViewObjectContactRedirector;

    // Called from getPrimitive2DSequence() when vector has changed. Evaluate object animation
    // and setup accordingly
    void checkForPrimitive2DAnimations();

    // This method is responsible for creating the graphical visualisation data which is
    // stored/cached in the local primitive. Default gets view-independent Primitive
    // from the ViewContact using ViewContact::getViewIndependentPrimitive2DContainer(), takes care of
    // visibility, handles glue and ghosted.
    // This method will not handle included hierarchies and not check geometric visibility.
    virtual void createPrimitive2DSequence(const DisplayInfo& rDisplayInfo, drawinglayer::primitive2d::Primitive2DDecompositionVisitor& rVisitor) const;

    // method for flushing Primitive2DContainer for VOC implementations
    void flushPrimitive2DSequence() { mxPrimitive2DSequence.clear(); }

public:
    // basic constructor.
    ViewObjectContact(ObjectContact& rObjectContact, ViewContact& rViewContact);
    virtual ~ViewObjectContact();

    // access to ObjectContact
    ObjectContact& GetObjectContact() const { return mrObjectContact; }

    // access to ViewContact
    ViewContact& GetViewContact() const { return mrViewContact; }

    // get the object size range
    const basegfx::B2DRange& getObjectRange() const;

    // React on changes of the object of this ViewContact
    virtual void ActionChanged();

    // LazyInvalidate handling
    void triggerLazyInvalidate();

    // Check if this primitive is animated in any OC (View) which means it has
    // generated a PrimitiveAnimation
    bool isAnimated() const { return (nullptr != mpPrimitiveAnimation); }

    // Take some action when new objects are inserted
    void ActionChildInserted(ViewContact& rChild);

    // access to the local primitive. This will ensure that the local primitive is
    // current in comparing the local one with a fresh created incarnation
    // This method will not handle included hierarchies and not check visibility.
    drawinglayer::primitive2d::Primitive2DContainer const & getPrimitive2DSequence(const DisplayInfo& rDisplayInfo) const;

    // test this VOC for visibility concerning model-view stuff like e.g. Layer
    virtual bool isPrimitiveVisible(const DisplayInfo& rDisplayInfo) const;

    // test this VOC for ghosted mode
    virtual bool isPrimitiveGhosted(const DisplayInfo& rDisplayInfo) const;

    // process this primitive: Eventually also recursively travel an existing hierarchy,
    // e.g. for group objects, scenes or pages. This method will test geometrical visibility.
    virtual void getPrimitive2DSequenceHierarchy(DisplayInfo& rDisplayInfo, drawinglayer::primitive2d::Primitive2DDecompositionVisitor& rVisitor) const;

    // just process the sub-hierarchy, used as tooling from getPrimitive2DSequenceHierarchy
    void getPrimitive2DSequenceSubHierarchy(DisplayInfo& rDisplayInfo, drawinglayer::primitive2d::Primitive2DDecompositionVisitor& rVisitor) const;

    // interface to support GridOffset for non-linear ViewToDevice transformation (calc)
    const basegfx::B2DVector& getGridOffset() const;
    void resetGridOffset();
};

}


#endif // INCLUDED_SVX_SDR_CONTACT_VIEWOBJECTCONTACT_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */