Scroom::Utils::Segment< T > Class Template Reference

#include <linearsegment.hh>

Inheritance diagram for Scroom::Utils::Segment< T >:

Collaboration diagram for Scroom::Utils::Segment< T >:

Public Types
using	value_type = T

Public Member Functions
	Segment ()
	Segment (value_type start_, value_type size_)
template<bool T_is_int = std::is_same_v<int, std::remove_cv_t<T>>>
	Segment (std::enable_if_t<!T_is_int, Segment< int > const & > other)
Segment	moveTo (value_type p) const
bool	contains (value_type p) const
bool	contains (const Segment< value_type > &other) const
bool	intersects (const Segment< value_type > &other) const
void	reduceSizeToMultipleOf (value_type m)
Segment< value_type >	intersection (const Segment< value_type > &other) const
void	intersect (const Segment< value_type > &other)
Segment< value_type >	before (value_type v) const
Segment< value_type >	after (value_type v) const
value_type	getStart () const
value_type	getEnd () const
value_type	getSize () const
bool	isEmpty () const
bool	operator== (const Segment< value_type > &other) const
bool	operator!= (const Segment< value_type > &other) const
Segment< value_type > &	operator+= (value_type n)
Segment< value_type > &	operator-= (value_type n)
Segment< value_type > &	operator*= (value_type n)
Segment< value_type > &	operator/= (value_type n)
Segment< value_type > &	operator&= (const Segment< value_type > &other)
void	setStart (value_type n)
void	setSize (value_type n)
void	setEnd (value_type n)
template<typename U >
Segment< U >	to () const

Private Member Functions
void	normalize ()

Private Attributes
value_type	start
value_type	size

Member Typedef Documentation

value_type

template<typename T >

using Scroom::Utils::Segment< T >::value_type = T

Constructor & Destructor Documentation

Segment() [1/3]

template<typename T >

Scroom::Utils::Segment< T >::Segment ( )

inline

      : start(0)
      , size(0)
    {
    }

Referenced by Scroom::Utils::Segment< T >::moveTo().

Here is the caller graph for this function:

Segment() [2/3]

template<typename T >

Scroom::Utils::Segment< T >::Segment ( value_type  start_, value_type  size_  )

inline

      : start(start_)
      , size(size_)
    {
      normalize();
    }

Here is the call graph for this function:

Segment() [3/3]

template<typename T >

template<bool T_is_int = std::is_same_v<int, std::remove_cv_t<T>>>

Scroom::Utils::Segment< T >::Segment ( std::enable_if_t<!T_is_int, Segment< int > const & >  other )

inlineexplicit

Implicit conversion from Segment<int> to Segment<T>. If T!=int

      : start(other.getStart())
      , size(other.getSize())
    {
    }

Member Function Documentation

after()

template<typename T >

Segment< value_type > Scroom::Utils::Segment< T >::after ( value_type  v ) const

inline

    {
      if(v > start + size)
      {
        return Segment<value_type>();
      }
      if(v > start)
      {
        return Segment<value_type>(v, start + size - v);
      }
      return *this;
    }

Referenced by Scroom::Utils::Rectangle< T >::below(), Scroom::Utils::Rectangle< T >::below(), Scroom::Utils::Rectangle< T >::rightOf(), and Scroom::Utils::Rectangle< T >::rightOf().

Here is the caller graph for this function:

before()

template<typename T >

Segment< value_type > Scroom::Utils::Segment< T >::before ( value_type  v ) const

inline

    {
      if(v < start)
      {
        return Segment<value_type>();
      }
      if(v < start + size)
      {
        return Segment<value_type>(start, v - start);
      }
      return *this;
    }

Referenced by Scroom::Utils::Rectangle< T >::above(), Scroom::Utils::Rectangle< T >::above(), Scroom::Utils::Rectangle< T >::leftOf(), and Scroom::Utils::Rectangle< T >::leftOf().

Here is the caller graph for this function:

contains() [1/2]

template<typename T >

bool Scroom::Utils::Segment< T >::contains ( const Segment< value_type > &  other ) const

inline

    {
      return getStart() <= other.getStart() && other.getEnd() <= getEnd();
    }

Here is the call graph for this function:

contains() [2/2]

template<typename T >

bool Scroom::Utils::Segment< T >::contains ( value_type  p ) const

inline

{ return start <= p && p < (start + size); }

Referenced by Scroom::Utils::Rectangle< T >::contains(), and Scroom::Utils::Rectangle< T >::contains().

Here is the caller graph for this function:

getEnd()

template<typename T >

value_type Scroom::Utils::Segment< T >::getEnd ( ) const

inline

{ return start + size; }

Referenced by Scroom::Utils::Rectangle< T >::below(), Scroom::Utils::Segment< T >::contains(), Scroom::Utils::Rectangle< T >::getBottom(), Scroom::Utils::Rectangle< T >::getBottomLeft(), Scroom::Utils::Rectangle< T >::getBottomRight(), Scroom::Utils::Rectangle< T >::getRight(), Scroom::Utils::Rectangle< T >::getTopRight(), Scroom::Utils::Segment< T >::intersection(), Scroom::Utils::Segment< T >::intersects(), Scroom::Utils::Rectangle< T >::rightOf(), and Scroom::Utils::Segment< T >::setStart().

Here is the caller graph for this function:

getSize()

template<typename T >

value_type Scroom::Utils::Segment< T >::getSize ( ) const

inline

{ return size; }

Referenced by Scroom::Utils::Rectangle< T >::getHeight(), Scroom::Utils::Rectangle< T >::getSize(), Scroom::Utils::Rectangle< T >::getWidth(), and Scroom::Utils::Segment< T >::isEmpty().

Here is the caller graph for this function:

getStart()

template<typename T >

value_type Scroom::Utils::Segment< T >::getStart ( ) const

inline

{ return start; }

Referenced by Scroom::Utils::Rectangle< T >::above(), Scroom::Utils::Segment< T >::contains(), Scroom::Utils::Rectangle< T >::getBottomLeft(), Scroom::Utils::Rectangle< T >::getLeft(), Scroom::Utils::Rectangle< T >::getTop(), Scroom::Utils::Rectangle< T >::getTopLeft(), Scroom::Utils::Rectangle< T >::getTopRight(), Scroom::Utils::Segment< T >::intersection(), Scroom::Utils::Segment< T >::intersects(), and Scroom::Utils::Rectangle< T >::leftOf().

Here is the caller graph for this function:

intersect()

template<typename T >

void Scroom::Utils::Segment< T >::intersect ( const Segment< value_type > &  other )

inline

{ *this = intersection(other); }

Referenced by Scroom::Utils::Segment< T >::operator&=().

Here is the call graph for this function:

Here is the caller graph for this function:

intersection()

template<typename T >

Segment< value_type > Scroom::Utils::Segment< T >::intersection ( const Segment< value_type > &  other ) const

inline

    {
      const value_type newStart = std::max(getStart(), other.getStart());
      const value_type newEnd = std::min(getEnd(), other.getEnd());
      const value_type newSize = newEnd - newStart;
 
      if(newSize >= 0)
      {
        return Segment<value_type>(newStart, newSize);
      }
 
      return Segment<value_type>(); // empty segment
    }

Referenced by Scroom::Utils::Rectangle< T >::above(), Scroom::Utils::Rectangle< T >::below(), Scroom::Utils::Segment< T >::intersect(), Scroom::Utils::Rectangle< T >::intersection(), Scroom::Utils::Rectangle< T >::leftOf(), and Scroom::Utils::Rectangle< T >::rightOf().

Here is the call graph for this function:

Here is the caller graph for this function:

intersects()

template<typename T >

bool Scroom::Utils::Segment< T >::intersects ( const Segment< value_type > &  other ) const

inline

    {
      return getStart() < other.getEnd() && other.getStart() < getEnd() && !isEmpty() && !other.isEmpty();
    }

Referenced by Scroom::Utils::Rectangle< T >::intersects().

Here is the call graph for this function:

Here is the caller graph for this function:

isEmpty()

template<typename T >

bool Scroom::Utils::Segment< T >::isEmpty ( ) const

inline

{ return isZero(getSize()); }

Referenced by Scroom::Utils::Segment< T >::intersects(), Scroom::Utils::Rectangle< T >::isEmpty(), and Scroom::Utils::Segment< T >::operator==().

Here is the call graph for this function:

Here is the caller graph for this function:

moveTo()

template<typename T >

Segment Scroom::Utils::Segment< T >::moveTo ( value_type  p ) const

inline

{ return Segment(p, size); }

Referenced by Scroom::Utils::Rectangle< T >::moveTo().

Here is the call graph for this function:

Here is the caller graph for this function:

normalize()

template<typename T >

void Scroom::Utils::Segment< T >::normalize ( )

inlineprivate

    {
      if(size < 0)
      {
        start += size;
        size = -size;
      }
    }

Referenced by Scroom::Utils::Segment< T >::Segment(), and Scroom::Utils::Segment< T >::setEnd().

Here is the caller graph for this function:

operator!=()

template<typename T >

bool Scroom::Utils::Segment< T >::operator!= ( const Segment< value_type > &  other ) const

inline

{ return !(*this == other); }

operator&=()

template<typename T >

Segment< value_type > & Scroom::Utils::Segment< T >::operator&= ( const Segment< value_type > &  other )

inline

    {
      intersect(other);
      return *this;
    }

Here is the call graph for this function:

operator*=()

template<typename T >

Segment< value_type > & Scroom::Utils::Segment< T >::operator*= ( value_type  n )

inline

    {
      start *= n;
      size *= n;
      return *this;
    }

operator+=()

template<typename T >

Segment< value_type > & Scroom::Utils::Segment< T >::operator+= ( value_type  n )

inline

    {
      start += n;
      return *this;
    }

operator-=()

template<typename T >

Segment< value_type > & Scroom::Utils::Segment< T >::operator-= ( value_type  n )

inline

    {
      start -= n;
      return *this;
    }

operator/=()

template<typename T >

Segment< value_type > & Scroom::Utils::Segment< T >::operator/= ( value_type  n )

inline

    {
      start /= n;
      size /= n;
      return *this;
    }

operator==()

template<typename T >

bool Scroom::Utils::Segment< T >::operator== ( const Segment< value_type > &  other ) const

inline

    {
      if(isEmpty() != other.isEmpty())
      {
        return false;
      }
 
      if(isEmpty())
      {
        return true;
      }
 
      return areEqual(start, other.start) && areEqual(size, other.size);
    }

Here is the call graph for this function:

reduceSizeToMultipleOf()

template<typename T >

void Scroom::Utils::Segment< T >::reduceSizeToMultipleOf ( value_type  m )

inline

{ size -= size % m; }

Referenced by Scroom::Utils::Rectangle< T >::reduceSizeToMultipleOf().

Here is the caller graph for this function:

setEnd()

template<typename T >

void Scroom::Utils::Segment< T >::setEnd ( value_type  n )

inline

    {
      size = n - start;
      normalize();
    }

Referenced by Scroom::Utils::Rectangle< T >::setBottom(), Scroom::Utils::Rectangle< T >::setRight(), and Scroom::Utils::Segment< T >::setStart().

Here is the call graph for this function:

Here is the caller graph for this function:

setSize()

template<typename T >

void Scroom::Utils::Segment< T >::setSize ( value_type  n )

inline

{ size = n; }

Referenced by Scroom::Utils::Rectangle< T >::setSize().

Here is the caller graph for this function:

setStart()

template<typename T >

void Scroom::Utils::Segment< T >::setStart ( value_type  n )

inline

    {
      const auto end = getEnd();
      start = n;
      setEnd(end);
    }

Referenced by Scroom::Utils::Rectangle< T >::setLeft(), and Scroom::Utils::Rectangle< T >::setTop().

Here is the call graph for this function:

Here is the caller graph for this function:

to()

template<typename T >

template<typename U >

Segment< U > Scroom::Utils::Segment< T >::to ( ) const

inline

    {
      return {
        static_cast<U>(start),
        static_cast<U>(size),
      };
    }

Member Data Documentation

size

template<typename T >

value_type Scroom::Utils::Segment< T >::size

private

Referenced by Scroom::Utils::Segment< T >::after(), Scroom::Utils::Segment< T >::before(), Scroom::Utils::Segment< T >::contains(), Scroom::Utils::Segment< T >::getEnd(), Scroom::Utils::Segment< T >::getSize(), Scroom::Utils::Segment< T >::moveTo(), Scroom::Utils::Segment< T >::normalize(), Scroom::Utils::Segment< T >::operator*=(), Scroom::Utils::Segment< T >::operator/=(), Scroom::Utils::Segment< T >::operator==(), Scroom::Utils::Segment< T >::reduceSizeToMultipleOf(), Scroom::Utils::Segment< T >::setEnd(), Scroom::Utils::Segment< T >::setSize(), and Scroom::Utils::Segment< T >::to().

start

template<typename T >

value_type Scroom::Utils::Segment< T >::start

private

Referenced by Scroom::Utils::Segment< T >::after(), Scroom::Utils::Segment< T >::before(), Scroom::Utils::Segment< T >::contains(), Scroom::Utils::Segment< T >::getEnd(), Scroom::Utils::Segment< T >::getStart(), Scroom::Utils::Segment< T >::normalize(), Scroom::Utils::Segment< T >::operator*=(), Scroom::Utils::Segment< T >::operator+=(), Scroom::Utils::Segment< T >::operator-=(), Scroom::Utils::Segment< T >::operator/=(), Scroom::Utils::Segment< T >::operator==(), Scroom::Utils::Segment< T >::setEnd(), Scroom::Utils::Segment< T >::setStart(), and Scroom::Utils::Segment< T >::to().

---

The documentation for this class was generated from the following file:

• libs/util/inc/scroom/linearsegment.hh