Version 7.6.3.2-android, tag libreoffice-7.6.3.2-android
[LibreOffice.git] / include / vcl / canvastools.hxx
blob778a092261a15a61f5f4bd001fbf52c2340e2480
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_VCL_CANVASTOOLS_HXX
21 #define INCLUDED_VCL_CANVASTOOLS_HXX
23 #include <com/sun/star/uno/Reference.hxx>
24 #include <com/sun/star/uno/Sequence.hxx>
25 #include <basegfx/numeric/ftools.hxx>
26 #include <basegfx/range/b2irectangle.hxx>
28 #include <vcl/dllapi.h>
30 class Point;
31 class Size;
32 namespace tools { class Rectangle; }
33 class BitmapEx;
34 class Color;
36 namespace basegfx
38 class B2DVector;
39 class B2DPoint;
40 class B2DRange;
41 class B2IPoint;
42 class B2IRange;
43 class B2DSize;
46 namespace com::sun::star::geometry
48 struct RealSize2D;
49 struct IntegerPoint2D;
50 struct IntegerSize2D;
51 struct IntegerRectangle2D;
54 namespace com::sun::star::rendering
56 class XBitmap;
57 class XIntegerReadOnlyBitmap;
60 namespace com::sun::star::rendering { class XColorSpace; }
62 namespace vcl::unotools
64 // Bitmap conversions
67 /** Create an XBitmap from VCL BitmapEx
69 css::uno::Reference< css::rendering::XBitmap >
70 VCL_DLLPUBLIC xBitmapFromBitmapEx( const ::BitmapEx& inputBitmap );
72 /** Create a BitmapEx from an XBitmap
74 ::BitmapEx VCL_DLLPUBLIC bitmapExFromXBitmap( const css::uno::Reference< css::rendering::XIntegerReadOnlyBitmap >& xInputBitmap );
76 // Color conversions (vcl/tools Color <-> canvas standard color space)
79 /** Create a device-specific color sequence from VCL/Tools color
81 Note that this method assumes a color space equivalent to
82 the one returned from createStandardColorSpace()
84 css::uno::Sequence< double >
85 VCL_DLLPUBLIC colorToStdColorSpaceSequence( const Color& rColor );
87 /** Convert color to device color sequence
89 @param rColor
90 Color to convert
92 @param xColorSpace
93 Color space to convert into
95 css::uno::Sequence< double >
96 VCL_DLLPUBLIC colorToDoubleSequence( const Color& rColor,
97 const css::uno::Reference< css::rendering::XColorSpace >& xColorSpace );
99 /** Convert from standard device color space to VCL/Tools color
101 Note that this method assumes a color space equivalent to
102 the one returned from createStandardColorSpace()
104 Color VCL_DLLPUBLIC stdColorSpaceSequenceToColor(
105 const css::uno::Sequence< double >& rColor );
107 /** Convert color to device color sequence
109 @param rColor
110 Color sequence to convert from
112 @param xColorSpace
113 Color space to convert from
115 Color VCL_DLLPUBLIC doubleSequenceToColor( const css::uno::Sequence< double >& rColor,
116 const css::uno::Reference< css::rendering::XColorSpace >& xColorSpace );
118 /// Convert [0,1] double value to [0,255] int
119 inline sal_Int8 toByteColor( double val )
121 return sal::static_int_cast<sal_Int8>(
122 basegfx::fround(val*255.0));
125 /// Convert [0,255] int value to [0,1] double value
126 inline double toDoubleColor( sal_uInt8 val )
128 return val / 255.0;
131 /// Create a standard color space suitable for VCL RGB color
132 css::uno::Reference< css::rendering::XColorSpace> VCL_DLLPUBLIC createStandardColorSpace();
134 // Geometry conversions (vcl/tools <-> x)
137 // geometry::Real
138 css::geometry::RealSize2D VCL_DLLPUBLIC size2DFromSize( const Size& );
140 Size VCL_DLLPUBLIC sizeFromRealSize2D( const css::geometry::RealSize2D& );
142 // geometry::Integer
143 css::geometry::IntegerSize2D VCL_DLLPUBLIC integerSize2DFromSize( const Size& );
145 Size VCL_DLLPUBLIC sizeFromIntegerSize2D( const css::geometry::IntegerSize2D& );
146 Point VCL_DLLPUBLIC pointFromIntegerPoint2D( const css::geometry::IntegerPoint2D& );
147 tools::Rectangle VCL_DLLPUBLIC rectangleFromIntegerRectangle2D( const css::geometry::IntegerRectangle2D& );
149 // basegfx::B2D
150 Size VCL_DLLPUBLIC sizeFromB2DSize( const basegfx::B2DVector& );
151 Point VCL_DLLPUBLIC pointFromB2DPoint( const basegfx::B2DPoint& );
152 tools::Rectangle VCL_DLLPUBLIC rectangleFromB2DRectangle( const basegfx::B2DRange& );
154 VCL_DLLPUBLIC basegfx::B2DSize b2DSizeFromSize(const Size& rSize);
155 VCL_DLLPUBLIC basegfx::B2DVector b2DVectorFromSize(const Size& rSize);
156 basegfx::B2DPoint VCL_DLLPUBLIC b2DPointFromPoint( const Point& );
157 basegfx::B2DRange VCL_DLLPUBLIC b2DRectangleFromRectangle( const tools::Rectangle& );
159 // basegfx::B2I
160 Point VCL_DLLPUBLIC pointFromB2IPoint( const basegfx::B2IPoint& );
161 tools::Rectangle VCL_DLLPUBLIC rectangleFromB2IRectangle( const basegfx::B2IRange& );
162 basegfx::B2IPoint VCL_DLLPUBLIC b2IPointFromPoint(const Point&);
163 basegfx::B2IRectangle VCL_DLLPUBLIC b2IRectangleFromRectangle(const tools::Rectangle&);
167 #endif // INCLUDED_VCL_CANVASTOOLS_HXX
169 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */