GeInterval.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
#ifndef OD_GE_INTERVAL_H
#define OD_GE_INTERVAL_H 
 
#include "Ge/GeExport.h"
#include "TD_PackPush.h"

class GE_TOOLKIT_EXPORT OdGeInterval
{
public:
  OdGeInterval(double tol = 1.e-12)
    : m_LowerParam(0.0)
    , m_UpperParam(0.0)
    , m_Tol(tol)
    , m_bBoundedBelow(false)
    , m_bBoundedAbove(false)
  {
  }
  
  OdGeInterval(double lower, double upper, double tol = 1.e-12)
    : m_LowerParam(lower)
    , m_UpperParam(upper)
    , m_Tol(tol)
    , m_bBoundedBelow(true)
    , m_bBoundedAbove(true)
  {
  }
 
  
  OdGeInterval(
    bool boundedBelow,
    double bound,
    double tol = 1.e-12);

  double lowerBound() const {
    ODA_ASSERT_ONCE(m_bBoundedBelow);
    return m_LowerParam;
  }

  double upperBound() const {
    ODA_ASSERT_ONCE(m_bBoundedAbove);
    return m_UpperParam;
  }

  double middle() const {
    return 0.5 * (m_LowerParam + m_UpperParam);
  }

    double element() const;

  void getBounds(
    double& lower,
    double& upper) const
  {
    lower = m_LowerParam;
    upper = m_UpperParam;
  }
    
  double getEnd(
    int index) const
  {
    ODA_ASSERT(index == 0 || index == 1);
    return index == 0 ? m_LowerParam : m_UpperParam;
  }

  double length() const
  {
    return (isBounded() ? (m_UpperParam - m_LowerParam) : -1.0);
  }
  
  double tolerance() const
  {
    return m_Tol;
  }

  double eval(
    double ratio) const
  {
    ODA_ASSERT(isBounded());
    return m_LowerParam * (1.0 - ratio) + m_UpperParam * ratio;
  }

  OdGeInterval& set(
    double lower,
    double upper)
  {
    setLower(lower);
    return setUpper(upper);
  }
  
  OdGeInterval& set(
    bool boundedBelow,
    double bound);
  
  OdGeInterval& set()
  {
    m_LowerParam = m_UpperParam = 0.0;
    m_bBoundedBelow = m_bBoundedAbove = false;
    return *this;
  }

  OdGeInterval& setUpper(
    double upper)
  {
    m_UpperParam = upper;
    m_bBoundedAbove = true;
    return *this;
  }
    
  OdGeInterval& setLower(
    double lower)
  {
    m_LowerParam = lower;
    m_bBoundedBelow = true;
    return *this;
  }

  OdGeInterval& setTolerance(
    double tol)
  {
    m_Tol = tol;
    return *this;
  }

  OdGeInterval& scale(double factor);

  OdGeInterval& swap();

  void getMerge(
    const OdGeInterval& otherInterval,
    OdGeInterval& result) const;
    
  int subtract(
    const OdGeInterval& otherInterval,
    OdGeInterval& lInterval,
    OdGeInterval& rInterval) const;

  bool intersectWith(
    const OdGeInterval& otherInterval,
    OdGeInterval& result) const;

  bool finiteIntersectWith(const OdGeInterval& range, OdGeInterval& result) const;
    
  bool isBounded() const
  {
    return (m_bBoundedAbove && m_bBoundedBelow);
  }
    
  bool isBoundedAbove() const
  {
    return m_bBoundedAbove;
  }

  bool isBoundedBelow() const
  {
    return m_bBoundedBelow;
  }

  bool isUnBounded() const
  {
    return (!m_bBoundedAbove || !m_bBoundedBelow);
  }
  
  bool isSingleton() const;

  bool isDisjoint(
    const OdGeInterval& otherInterval) const;

  bool contains(
    const OdGeInterval& otherInterval) const;
  
  bool contains(
    double value) const
  {
    return ((!m_bBoundedBelow || m_LowerParam - m_Tol <= value)
      && (!m_bBoundedAbove || m_UpperParam + m_Tol >= value));
  }

  double clamp(
    double value) const
  {
    if (m_bBoundedAbove)
      value = odmin(value, m_UpperParam);
    if (m_bBoundedBelow)
      value = odmax(value, m_LowerParam);
    return value;
  }

  bool isContinuousAtUpper(
    const OdGeInterval& otherInterval) const;

  bool isOverlapAtUpper(
    const OdGeInterval& otherInterval,
    OdGeInterval& overlap) const;

  bool operator ==(
    const OdGeInterval& otherInterval) const;
  
  bool operator !=(
    const OdGeInterval& otherInterval) const;
    
  bool isEqualAtUpper(
    const OdGeInterval& otherInterval) const;

  bool isEqualAtUpper(
    double value) const;
    
  bool isEqualAtLower(
    const OdGeInterval& otherInterval) const;
  
  bool isEqualAtLower(
    double value) const;

  bool isPeriodicallyOn(
    double period,
    double& value);
//DOM-IGNORE-BEGIN
 
  friend 
    bool operator > (
    double value,
    const OdGeInterval& interval);
  bool operator > (
    double value) const;
  bool operator > (
    const OdGeInterval& otherInterval) const;
  friend 
    bool operator >= (
    double value,
    const OdGeInterval& interval);
  bool operator >= (
    double value) const;
  bool operator >= (
    const OdGeInterval& otherInterval) const;
  friend 
    bool operator < (
    double value,
    const OdGeInterval& interval);
  bool operator < (
    double value) const;
  bool operator < (
    const OdGeInterval& otherInterval) const;
  friend 
    bool operator <= (
    double value,
    const OdGeInterval& interval);
  bool operator <= (
    double value) const;
  bool operator <= (
    const OdGeInterval& otherInterval) const;
 
private:
  double m_LowerParam;
  double m_UpperParam;
  double m_Tol;
  bool m_bBoundedBelow;
  bool m_bBoundedAbove;
//DOM-IGNORE-END
};
 
#include "TD_PackPop.h"
#endif // OD_GE_INTERVAL_H