TOctree_DEPRECATED< ElementType, OctreeSemantics > Class Template Reference

#include <GenericOctree.h>

Classes
class	FNode
class	FNodeReference
class	TConstElementBoxIterator
class	TConstIterator

Public Types
using	FReal = FVector4::FReal
typedef TArray< ElementType, typename OctreeSemantics::ElementAllocator >	ElementArrayType
typedef ElementArrayType::TConstIterator	ElementConstIt
typedef TInlineAllocator< 7 *(14 - 1)+8 >	DefaultStackAllocator

Public Member Functions
void	AddElement (typename TTypeTraits< ElementType >::ConstInitType Element)
void	RemoveElement (FOctreeElementId ElementId)
void	Destroy ()
ElementType &	GetElementById (FOctreeElementId ElementId)
const ElementType &	GetElementById (FOctreeElementId ElementId) const
bool	IsValidElementId (FOctreeElementId ElementId) const
void	DumpStats () const
SIZE_T	GetSizeBytes () const
FReal	GetNodeLevelExtent (int32 Level) const
FBoxCenterAndExtent	GetRootBounds () const
void	ShrinkElements ()
void	ApplyOffset (const FVector &InOffset, bool bGlobalOctree)
	TOctree_DEPRECATED (const FVector &InOrigin, FReal InExtent)
	TOctree_DEPRECATED ()

Protected Member Functions
void	SetElementId (const ElementType &Element, FOctreeElementId Id)

Detailed Description

template<typename ElementType, typename OctreeSemantics>
class TOctree_DEPRECATED< ElementType, OctreeSemantics >

An octree.

Member Typedef Documentation

DefaultStackAllocator

template<typename ElementType , typename OctreeSemantics >

typedef TInlineAllocator<7 * (14 - 1) + 8> TOctree_DEPRECATED< ElementType, OctreeSemantics >::DefaultStackAllocator

The default iterator allocator gives the stack enough inline space to contain a path and its siblings from root to leaf.

ElementArrayType

template<typename ElementType , typename OctreeSemantics >

typedef TArray<ElementType, typename OctreeSemantics::ElementAllocator> TOctree_DEPRECATED< ElementType, OctreeSemantics >::ElementArrayType

ElementConstIt

template<typename ElementType , typename OctreeSemantics >

typedef ElementArrayType::TConstIterator TOctree_DEPRECATED< ElementType, OctreeSemantics >::ElementConstIt

FReal

template<typename ElementType , typename OctreeSemantics >

using TOctree_DEPRECATED< ElementType, OctreeSemantics >::FReal = FVector4::FReal

Constructor & Destructor Documentation

TOctree_DEPRECATED() [1/2]

template<typename ElementType , typename OctreeSemantics >

TOctree_DEPRECATED< ElementType, OctreeSemantics >::TOctree_DEPRECATED ( const FVector &  InOrigin, FReal  InExtent  )

inline

Initialization constructor.

TOctree_DEPRECATED() [2/2]

template<typename ElementType , typename OctreeSemantics >

TOctree_DEPRECATED< ElementType, OctreeSemantics >::TOctree_DEPRECATED ( )

inline

DO NOT USE. This constructor is for internal usage only for hot-reload purposes.

Member Function Documentation

AddElement()

template<typename ElementType , typename OctreeSemantics >

void TOctree_DEPRECATED< ElementType, OctreeSemantics >::AddElement ( typename TTypeTraits< ElementType >::ConstInitType  Element )

inline

Adds an element to the octree.

Parameters

Element

- The element to add.

Returns

An identifier for the element in the octree.

ApplyOffset()

template<typename ElementType , typename OctreeSemantics >

void TOctree_DEPRECATED< ElementType, OctreeSemantics >::ApplyOffset ( const FVector &  InOffset, bool  bGlobalOctree  )

inline

Apply an arbitrary offset to all elements in the tree InOffset - offset to apply bGlobalOctree - hint that this octree is used as a boundless global volume, so only content will be shifted but not origin of the octree

Destroy()

template<typename ElementType , typename OctreeSemantics >

void TOctree_DEPRECATED< ElementType, OctreeSemantics >::Destroy ( )

inline

DumpStats()

template<typename ElementType , typename OctreeSemantics >

void TOctree_DEPRECATED< ElementType, OctreeSemantics >::DumpStats ( ) const

inline

Writes stats for the octree to the log.

GetElementById() [1/2]

template<typename ElementType , typename OctreeSemantics >

ElementType & TOctree_DEPRECATED< ElementType, OctreeSemantics >::GetElementById ( FOctreeElementId  ElementId )

inline

Accesses an octree element by ID.

GetElementById() [2/2]

template<typename ElementType , typename OctreeSemantics >

const ElementType & TOctree_DEPRECATED< ElementType, OctreeSemantics >::GetElementById ( FOctreeElementId  ElementId ) const

inline

Accesses an octree element by ID.

GetNodeLevelExtent()

template<typename ElementType , typename OctreeSemantics >

FReal TOctree_DEPRECATED< ElementType, OctreeSemantics >::GetNodeLevelExtent ( int32  Level ) const

inline

GetRootBounds()

template<typename ElementType , typename OctreeSemantics >

FBoxCenterAndExtent TOctree_DEPRECATED< ElementType, OctreeSemantics >::GetRootBounds ( ) const

inline

GetSizeBytes()

template<typename ElementType , typename OctreeSemantics >

SIZE_T TOctree_DEPRECATED< ElementType, OctreeSemantics >::GetSizeBytes ( ) const

inline

IsValidElementId()

template<typename ElementType , typename OctreeSemantics >

bool TOctree_DEPRECATED< ElementType, OctreeSemantics >::IsValidElementId ( FOctreeElementId  ElementId ) const

inline

Checks if given ElementId represents a valid Octree element

RemoveElement()

template<typename ElementType , typename OctreeSemantics >

void TOctree_DEPRECATED< ElementType, OctreeSemantics >::RemoveElement ( FOctreeElementId  ElementId )

inline

Removes an element from the octree.

Parameters

ElementId

- The element to remove from the octree.

SetElementId()

template<typename ElementType , typename OctreeSemantics >

void TOctree_DEPRECATED< ElementType, OctreeSemantics >::SetElementId ( const ElementType &  Element, FOctreeElementId  Id  )

inlineprotected

ShrinkElements()

template<typename ElementType , typename OctreeSemantics >

void TOctree_DEPRECATED< ElementType, OctreeSemantics >::ShrinkElements ( )

inline

---

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

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