include/basegfx/range/b1drange.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  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 .
  18  */
  19
  20 #pragma once
  21
  22 #include <basegfx/range/basicrange.hxx>
  23
  24
  25 namespace basegfx
  26 {
  27
  28     /** A one-dimensional interval over doubles
  29
  30         This is a set of real numbers, bounded by a lower and an upper
  31         value. All inbetween values are included in the set (see also
  32         http://en.wikipedia.org/wiki/Interval_%28mathematics%29).
  33
  34         The set is closed, i.e. the upper and the lower bound are
  35         included (if you're used to the notation - we're talking about
  36         [a,b] here, compared to half-open [a,b) or open intervals
  37         (a,b)).
  38
  39         That means, isInside(val) will return true also for values of
  40         val=a or val=b.
  41      */
  42     class B1DRange
  43     {
  44         ::basegfx::BasicRange< double, DoubleTraits >   maRange;
  45
  46     public:
  47         B1DRange() {}
  48
  49         /// Create degenerate interval consisting of a single double number
  50         explicit B1DRange(double fStartValue)
  51         :   maRange(fStartValue)
  52         {
  53         }
  54
  55         /// Create proper interval between the two given double values
  56         B1DRange(double fStartValue1, double fStartValue2)
  57         :   maRange(fStartValue1)
  58         {
  59             expand(fStartValue2);
  60         }
  61
  62         /** Check if the interval set is empty
  63
  64             @return false, if no value is in this set - having a
  65             single value included will already return true.
  66          */
  67         bool isEmpty() const
  68         {
  69             return maRange.isEmpty();
  70         }
  71
  72         bool operator==( const B1DRange& rRange ) const
  73         {
  74             return (maRange == rRange.maRange);
  75         }
  76
  77         bool operator!=( const B1DRange& rRange ) const
  78         {
  79             return (maRange != rRange.maRange);
  80         }
  81
  82         /// get lower bound of the set. returns arbitrary values for empty sets.
  83         double getMinimum() const
  84         {
  85             return maRange.getMinimum();
  86         }
  87
  88         /// get upper bound of the set. returns arbitrary values for empty sets.
  89         double getMaximum() const
  90         {
  91             return maRange.getMaximum();
  92         }
  93
  94         /// return difference between upper and lower value. returns 0 for empty sets.
  95         double getRange() const
  96         {
  97             return maRange.getRange();
  98         }
  99
 100         /// return middle of upper and lower value. returns 0 for empty sets.
 101         double getCenter() const
 102         {
 103             return maRange.getCenter();
 104         }
 105
 106         /// yields true if value is contained in set
 107         bool isInside(double fValue) const
 108         {
 109             return maRange.isInside(fValue);
 110         }
 111
 112         /// yields true if rRange at least partly inside set
 113         bool overlaps(const B1DRange& rRange) const
 114         {
 115             return maRange.overlaps(rRange.maRange);
 116         }
 117
 118         /// yields true if overlaps(rRange) does, and the overlap is larger than infinitesimal
 119         bool overlapsMore(const B1DRange& rRange) const
 120         {
 121             return maRange.overlapsMore(rRange.maRange);
 122         }
 123
 124         /// add fValue to the set, expanding as necessary
 125         void expand(double fValue)
 126         {
 127             maRange.expand(fValue);
 128         }
 129
 130         /// add rRange to the set, expanding as necessary
 131         void expand(const B1DRange& rRange)
 132         {
 133             maRange.expand(rRange.maRange);
 134         }
 135
 136         /// calc set intersection
 137         void intersect(const B1DRange& rRange)
 138         {
 139             maRange.intersect(rRange.maRange);
 140         }
 141
 142         /// clamp value on range
 143         double clamp(double fValue) const
 144         {
 145             return maRange.clamp(fValue);
 146         }
 147     };
 148
 149     /** Write to char stream */
 150     template<typename charT, typename traits>
 151     inline std::basic_ostream<charT, traits>& operator<<(
 152         std::basic_ostream<charT, traits>& stream, const B1DRange& range)
 153     {
 154         return stream << "[" << range.getMinimum() << ", " << range.getMaximum() << "]";
 155     }
 156
 157 } // end of namespace basegfx
 158
 159 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */