TActorIteratorBase< Derived > Class Template Reference

#include <EngineUtils.h>

Public Member Functions
void	operator++ ()
FORCEINLINE AActor *	operator* () const
FORCEINLINE AActor *	operator-> () const
FORCEINLINE	operator bool () const
void	ClearCurrent ()
int32	GetProgressNumerator () const

Protected Member Functions
	TActorIteratorBase (EActorIteratorType)
	TActorIteratorBase (const UWorld *InWorld, TSubclassOf< AActor > InClass, const EActorIteratorFlags InFlags)
bool	IsActorSuitable (const AActor *Actor) const
bool	CanIterateLevel (const ULevel *Level) const

Friends
bool	operator== (const TActorIteratorBase &Lhs, const TActorIteratorBase &Rhs)
bool	operator!= (const TActorIteratorBase &Lhs, const TActorIteratorBase &Rhs)

Detailed Description

template<typename Derived>
class TActorIteratorBase< Derived >

Template class used to filter actors by certain characteristics

Constructor & Destructor Documentation

TActorIteratorBase() [1/2]

template<typename Derived >

TActorIteratorBase< Derived >::TActorIteratorBase ( EActorIteratorType  )

inlineexplicitprotected

Hide the constructors as construction on this class should only be done by subclasses

TActorIteratorBase() [2/2]

template<typename Derived >

TActorIteratorBase< Derived >::TActorIteratorBase ( const UWorld *  InWorld, TSubclassOf< AActor >  InClass, const EActorIteratorFlags  InFlags  )

inlineprotected

Member Function Documentation

CanIterateLevel()

template<typename Derived >

bool TActorIteratorBase< Derived >::CanIterateLevel ( const ULevel *  Level ) const

inlineprotected

Used to examine whether this level is valid for iteration or not This function should be redefined (thus hiding this one) in a derived class if it wants special level filtering.

Parameters

Level

the level to check for iteration

Returns

true if the level can be iterated, false otherwise

ClearCurrent()

template<typename Derived >

void TActorIteratorBase< Derived >::ClearCurrent ( )

inline

Clears the current Actor in the array (setting it to NULL).

GetProgressNumerator()

template<typename Derived >

int32 TActorIteratorBase< Derived >::GetProgressNumerator ( ) const

inline

Returns the number of actors considered thus far. Can be used in combination with GetProgressDenominator to gauge progress iterating over all actors.

Returns

number of actors considered thus far.

IsActorSuitable()

template<typename Derived >

bool TActorIteratorBase< Derived >::IsActorSuitable ( const AActor *  Actor ) const

inlineprotected

Determines whether this is a valid actor or not. This function should be redefined (thus hiding this one) in a derived class if it wants special actor filtering.

Parameters

Actor

Actor to check

Returns

true

operator bool()

template<typename Derived >

FORCEINLINE TActorIteratorBase< Derived >::operator bool ( ) const

inlineexplicit

Returns whether the iterator has reached the end and no longer points to a suitable actor.

Returns

true if iterator points to a suitable actor, false if it has reached the end

operator*()

template<typename Derived >

FORCEINLINE AActor * TActorIteratorBase< Derived >::operator* ( ) const

inline

Returns the current suitable actor pointed at by the Iterator

Returns

Current suitable actor

operator++()

template<typename Derived >

void TActorIteratorBase< Derived >::operator++ ( )

inline

Iterates to next suitable actor.

operator->()

template<typename Derived >

FORCEINLINE AActor * TActorIteratorBase< Derived >::operator-> ( ) const

inline

Returns the current suitable actor pointed at by the Iterator

Returns

Current suitable actor

Friends And Related Symbol Documentation

operator!=

template<typename Derived >

bool operator!= ( const TActorIteratorBase< Derived > &  Lhs, const TActorIteratorBase< Derived > &  Rhs  )

friend

operator==

template<typename Derived >

bool operator== ( const TActorIteratorBase< Derived > &  Lhs, const TActorIteratorBase< Derived > &  Rhs  )

friend

---

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

• Engine/Source/Runtime/Engine/Public/EngineUtils.h