TRangeSet< ElementType > Class Template Reference

#include <RangeSet.h>

Public Member Functions
	TRangeSet ()
	~TRangeSet ()
void	Add (RangeType Range)
void	Merge (const TRangeSet &Other)
void	Empty ()
bool	Contains (ElementValueOrConstRef Element) const
bool	Contains (const RangeType &Range) const
BoundsType	GetMinBound () const
ElementType	GetMinBoundValue () const
BoundsType	GetMaxBound () const
ElementType	GetMaxBoundValue () const
template<typename Allocator >
const void	GetRanges (TArray< RangeType, Allocator > &OutRanges) const
bool	HasMinBound () const
bool	HasMaxBound () const
bool	IsEmpty () const
bool	Overlaps (const RangeType &Range) const
bool	Overlaps (const TRangeSet &Other) const

Friends
class FArchive &	operator<< (class FArchive &Ar, TRangeSet &RangeSet)

Detailed Description

template<typename ElementType>
class TRangeSet< ElementType >

Template for range sets.

Constructor & Destructor Documentation

TRangeSet()

template<typename ElementType >

TRangeSet< ElementType >::TRangeSet ( )

inline

Default constructor.

~TRangeSet()

template<typename ElementType >

TRangeSet< ElementType >::~TRangeSet ( )

inline

Destructor.

Member Function Documentation

Add()

template<typename ElementType >

void TRangeSet< ElementType >::Add ( RangeType  Range )

inline

Adds a range to the set.

This method merges overlapping ranges into a single range (i.e. {[1, 5], [4, 6]} becomes [1, 6]). Adjacent ranges (i.e. {[1, 4), [4, 6)} are also merged.

Parameters

Range

The range to add.

Contains() [1/2]

template<typename ElementType >

bool TRangeSet< ElementType >::Contains ( const RangeType &  Range ) const

inline

Checks whether this set contains the specified range.

Parameters

Range

The range to check.

Returns

true if the set contains the range, false otherwise.

Contains() [2/2]

template<typename ElementType >

bool TRangeSet< ElementType >::Contains ( ElementValueOrConstRef  Element ) const

inline

Checks whether this set contains the specified element.

Parameters

Element

The element to check.

Returns

true if the element is in the set, false otherwise.

Empty()

template<typename ElementType >

void TRangeSet< ElementType >::Empty ( )

inline

Removes a range from the set.

Ranges that overlap with the removed range will be split.

Parameters

Range

The range to remove. Removes all ranges from the set.

GetMaxBound()

template<typename ElementType >

BoundsType TRangeSet< ElementType >::GetMaxBound ( ) const

inline

Gets the range set's uppermost bound.

Returns

Uppermost bound.

See also

GetMaxBoundValue, GetMinBound, HasMaxBound

GetMaxBoundValue()

template<typename ElementType >

ElementType TRangeSet< ElementType >::GetMaxBoundValue ( ) const

inline

Gets the value of the uppermost bound.

Use HasMaxBound() to ensure that this range actually has an upper bound.

Returns

Bound value.

See also

GetMaxBound, GetMinBoundValue, HasMaxBound

GetMinBound()

template<typename ElementType >

BoundsType TRangeSet< ElementType >::GetMinBound ( ) const

inline

Gets the range set's lowest bound.

Returns

Lowest bound.

See also

GetMaxBound, GetMinBoundValue, HasMinBound

GetMinBoundValue()

template<typename ElementType >

ElementType TRangeSet< ElementType >::GetMinBoundValue ( ) const

inline

Gets the value of the lowest bound.

Use HasMinBound() to ensure that this range set actually has a lowest bound.

Returns

Bound value.

See also

GetMaxBoundValue, GetMinBound, HasMinBound

GetRanges()

template<typename ElementType >

template<typename Allocator >

const void TRangeSet< ElementType >::GetRanges ( TArray< RangeType, Allocator > &  OutRanges ) const

inline

Returns a read-only collection of the ranges contained in this set.

Parameters

Allocator	The array allocator to use.
OutRanges	Will contain the collection of ranges.

HasMaxBound()

template<typename ElementType >

bool TRangeSet< ElementType >::HasMaxBound ( ) const

inline

Checks whether the range has an uppermost bound.

Returns

true if the range has an uppermost bound, false otherwise.

See also

GetUpperBound, GetUpperBoundValue, HasMinBound

HasMinBound()

template<typename ElementType >

bool TRangeSet< ElementType >::HasMinBound ( ) const

inline

Checks whether the range has a lowest bound.

Returns

true if the range has a lowest bound, false otherwise.

See also

GetMinBound, GetMinBoundValue, HasMaxBound

IsEmpty()

template<typename ElementType >

bool TRangeSet< ElementType >::IsEmpty ( ) const

inline

Checks whether this range set is empty.

Returns

true if the range set is empty, false otherwise.

Merge()

template<typename ElementType >

void TRangeSet< ElementType >::Merge ( const TRangeSet< ElementType > &  Other )

inline

Merges another range set into this set.

Parameters

Other

The range set to merge.

Overlaps() [1/2]

template<typename ElementType >

bool TRangeSet< ElementType >::Overlaps ( const RangeType &  Range ) const

inline

Checks whether this range set overlaps with the specified range.

Parameters

Range

The range to check.

Returns

true if this set overlaps with the range, false otherwise.

Overlaps() [2/2]

template<typename ElementType >

bool TRangeSet< ElementType >::Overlaps ( const TRangeSet< ElementType > &  Other ) const

inline

Checks whether this range set overlaps with another.

Parameters

Other

The other range set.

Returns

true if the range sets overlap, false otherwise.

Friends And Related Symbol Documentation

operator<<

template<typename ElementType >

class FArchive & operator<< ( class FArchive &  Ar, TRangeSet< ElementType > &  RangeSet  )

friend

Serializes the given range set from or into the specified archive.

Parameters

Ar	The archive to serialize from or into.
RangeSet	The range set to serialize.

Returns

The archive.

---

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

• Engine/Source/Runtime/Core/Public/Math/RangeSet.h