Files
loongoffice/include/basegfx/tuple/b3ituple.hxx
Tomaž Vajngerl c703b2d22c basegfx: generalise tuples with template class Tuple2D and Tuple3D
B2DTuple2D, B2ITuple2D and B2I64Tuple share a lot in common so
we can generalise it as a template class. The same goes for the
3D variants - B3DTuple and B3ITuple.

This is the initial attempt, but doesn't yet generalise all that
is possible.

Add some tests for the tuple variants that test the behaviour of
overloaded operators and other common methods.

Change-Id: Iee5ed15d58ea88e65ee7854bd05a87ceab22023d
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/117104
Tested-by: Jenkins
Reviewed-by: Tomaž Vajngerl <quikee@gmail.com>
2021-06-17 01:55:56 +02:00

94 lines
3.0 KiB
C++

/* -*- 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 .
*/
#pragma once
#include <sal/types.h>
#include <basegfx/basegfxdllapi.h>
#include <basegfx/tuple/Tuple3D.hxx>
namespace basegfx
{
/** Base class for all Points/Vectors with three sal_Int32 values
This class provides all methods common to Point
and Vector classes which are derived from here.
@derive Use this class to implement Points or Vectors
which are based on three sal_Int32 values
*/
class SAL_WARN_UNUSED BASEGFX_DLLPUBLIC B3ITuple : public Tuple3D<sal_Int32>
{
public:
/** Create a 3D Tuple
The tuple is initialized to (0, 0, 0)
*/
B3ITuple()
: Tuple3D(0, 0, 0)
{}
/** Create a 3D Tuple
@param nX
This parameter is used to initialize the X-coordinate
of the 3D Tuple.
@param nY
This parameter is used to initialize the Y-coordinate
of the 3D Tuple.
@param nZ
This parameter is used to initialize the Z-coordinate
of the 3D Tuple.
*/
B3ITuple(sal_Int32 nX, sal_Int32 nY, sal_Int32 nZ)
: Tuple3D(nX, nY, nZ)
{}
/// Array-access to 3D Tuple
const sal_Int32& operator[] (int nPos) const
{
// Here, normally two if(...)'s should be used. In the assumption that
// both sal_Int32 members can be accessed as an array a shortcut is used here.
// if(0 == nPos) return mnX; if(1 == nPos) return mnY; return mnZ;
return *((&mnX) + nPos);
}
/// Array-access to 3D Tuple
sal_Int32& operator[] (int nPos)
{
// Here, normally two if(...)'s should be used. In the assumption that
// both sal_Int32 members can be accessed as an array a shortcut is used here.
// if(0 == nPos) return mnX; if(1 == nPos) return mnY; return mnZ;
return *((&mnX) + nPos);
}
// operators
B3ITuple operator-(void) const
{
return B3ITuple(-mnX, -mnY, -mnZ);
}
};
} // end of namespace basegfx
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */