office-gobmx/svx
Noel Grandin 1683847f0f loplugin:constantparam
Change-Id: Ibf1f8b8c01333f87f8e8cd73ccb0d62f30fbcd2b
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/174303
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2024-10-01 11:17:19 +02:00
..
doc
inc loplugin:constantparam 2024-10-01 11:17:11 +02:00
qa enforce null checking of AcquireTheme return 2024-09-09 09:17:13 +02:00
sdi tdf#161826 - Add uniform Glow effect for texts in shapes 2024-08-29 19:59:24 +02:00
source loplugin:constantparam 2024-10-01 11:17:19 +02:00
uiconfig/ui tdf#156543 sw: Added base text mono feature to Asian Phonetic Guide 2024-09-12 21:51:39 +02:00
util
AllLangMoTarget_svx.mk
CppunitTest_svx_core.mk
CppunitTest_svx_dialogs_test.mk
CppunitTest_svx_gallery_test.mk
CppunitTest_svx_removewhichrange.mk
CppunitTest_svx_unit.mk tdf#157543 Add glue points to binary 5-point star 2023-10-02 16:23:26 +02:00
Executable_gengal.mk
IwyuFilter_svx.yaml tdf#146619 Recheck svx/ with IWYU 2023-12-30 22:42:05 +01:00
JunitTest_svx_unoapi.mk
Library_svx.mk tdf#161826 - Add uniform Glow effect for texts in shapes 2024-08-29 19:59:24 +02:00
Library_svxcore.mk annot: new Annotation sdr object, replacing annotation tags 2024-06-11 12:48:48 +02:00
Library_textconversiondlgs.mk
Makefile
Module_svx.mk move theme test from svx to sd - so we can use ThemeColorChange 2023-08-23 09:18:37 +02:00
Package_gengal.mk
README.md Fix typo 2024-09-01 10:59:49 +02:00
UIConfig_svx.mk tdf#161826 - Add uniform Glow effect for texts in shapes 2024-08-29 19:59:24 +02:00
UITest_svx_table.mk uitest: Clean up redundant usage of gb_UITest_use_oneprocess 2023-11-06 09:26:43 +01:00

Graphics Related Helper Code

Contains graphics related helper code. Lots of the draw and impress code is in this shared library.

  • xoutdev

    this is where a lot of the work would happen to move to the canvas. (what does that mean?)

  • svdraw

    transparent gradient stuff. [seriously? surely much more, too]

SdrObject

The shapes you can see in LibreOffice (like rectangle, etc.) are SdrObjects. They are declared as a hierarchy:

SdrObject <- SdrAttrObj <- E3dObject <- E3dCompoundObject <- E3dCubeObj
    ^ ^ ^             ^            ^              | | ^ ^
    | | |             |            |              | | | +--- E3dExtrudeObj
    | | |             |            |              | | +----- E3dLatheObj
    | | |             |            |              | +------- E3dPolygonObj
    | | |             |            |              +--------- E3dSphereObj
    | | |             |            +--- E3dScene...
    | | |             |
    | | |             +--- SdrTextObj <- SdrObjCustomShape...
    | | |                   ^ ^ ^ ^ ^
    | | |                   | | | | +--- SdrEdgeObj...
    | | |                   | | | +----- SdrMeasureObj...
    | | |                   | | +------- SdrPathObj...
    | | |                   | +--------- SdrRectObj...
    | | |                   +----------- SdrTableObj...
    | | +--- SdrObjGroup...
    | + ---- SdrPageObj...
    +------- SdrVirtObj...

The above is incomplete of course.

SdrModel / SdrView

Copied from svdview.hxx:

First of all the app creates a SdrModel. Then it opens a Win and creates a SdrView. ShowSdrPage() announces a page at SdrView. It's possible to show SdrView in any Wins at once.

SdrView can show as many Wins as it wants at once. Pages are announced or checked out with the help of ShowSdrPage()/HideSdrPage(). For every announced page there is a SdrPageView instance in container aPages. If more than one page is showed, you have to pay attention that the offset parameter of ShowSdrPage() is conformed to the size of the page (to prevent overlapping of two pages).

SdrView itself is inherited from many objects in a chain of inheritance (all that starts with SdrPaintView - that is itself inherited from few classes too):

SdrPaintView <- SdrSnapView <- SdrMarkView <- SdrEditView <- SdrPolyEditView
                                                                 ^
+----------------------------------------------------------------+
|
SdrGlueEditView <- SdrObjEditView <- SdrExchangeView <- SdrDragView
                                                                 ^
+----------------------------------------------------------------+
|
SdrCreateView <- SdrView

From SdrView on, it is not flat, but a real hierarchy again.

Drawing Layer / SdrObject(s)

See drawinglayer/README.md for general information about drawinglayer.

Below is the class diagram that comes from https://web.archive.org/web/20160827020830if_/http://www.openoffice.org:80/marketing/ooocon2006/presentations/wednesday_g11.odp slide number 6.

.------- Model --------------.      .------- View -----------------------------------------.
| SdrObject - ViewContact    | 1..* | ViewObjectContact                                    |
|              getChild()    |------|    getPrimitiveList()  -----> Object(s) ---> SdrView |
|              getVOC()      |      |    getRecPrimitiveList()      Contact                |
|              getViewInd... |      |________|_____________________________________________|
| ...ependentPrimitiveList() |               |
|____________________________|            generates
                                             |           ______
                                             V          /      |
                                   .----------------------.    |
                                   | basePrimitive        |    |
                                   |   getRange()         |<---'
                                   |   getDecomposition() |
                                   |______________________|

For SdrObjects, there are own DrawingLayer primitives in svx/source/sdr/primitive2d

The ViewContact / ViewObject / ViewObjectContact are in svx/source/sdr/contact Decomposes the SdrObjects, and does all sort of operations on them.

If the number of visualizable objects (e.g. SdrObjects) is X, and the number of SdrViews is Y, then:

  • there are X ViewContact instances (1:1 relation with a visualizable object)
  • there are Y ObjectContact instances (1:1 relation with an SdrView)
  • there are X*Y ViewObjectContact instances (1:N relation to both visualizable objects and SdrViews)