TOctree_DEPRECATED | Unreal Engine 5.7 Documentation

An octree.


Name	TOctree_DEPRECATED
Type	class
Header File	/Engine/Source/Runtime/Core/Public/Math/GenericOctree.h
Include Path	#include "Math/GenericOctree.h"

Syntax

template<typename ElementType, typename OctreeSemantics>  
class TOctree_DEPRECATED

Name	Remarks	Include Path	Unreal Specifiers
TOctree_DEPRECATED ()	DO NOT USE. This constructor is for internal usage only for hot-reload purposes.	Math/GenericOctree.h
TOctree_DEPRECATED ( const FVector& InOrigin, FReal InExtent )	Initialization constructor.	Math/GenericOctree.h

Name	Remarks
FNode	A node in the octree.
FNodeReference	A reference to an octree node, its context, and a read lock.
TConstElementBoxIterator	Iterates over the elements in the octree that intersect a bounding box.
TConstIterator	An octree node iterator.

Name	Remarks
COctreeSemanticsV2	Concept definition for the new octree semantics, which adds a new TOctree parameter.

Name	Type	Remarks	Include Path
DefaultStackAllocator	TInlineAllocator< 7 *(14 - 1)+8 >	The default iterator allocator gives the stack enough inline space to contain a path and its siblings from root to leaf.	Math/GenericOctree.h
ElementArrayType	TArray< ElementType, typename OctreeSemantics::ElementAllocator >		Math/GenericOctree.h
ElementConstIt	ElementArrayType::TConstIterator		Math/GenericOctree.h
FReal	FVector4::FReal		Math/GenericOctree.h

Name	Type	Remarks	Include Path
MinLeafExtent	FReal	The extent of a leaf at the maximum allowed depth of the tree.	Math/GenericOctree.h
RootNode	FNode	The octree's root node.	Math/GenericOctree.h
RootNodeContext	FOctreeNodeContext	The octree's root node's context.	Math/GenericOctree.h
TotalSizeBytes	SIZE_T		Math/GenericOctree.h

Name	Remarks	Include Path
void AddElement ( typename TTypeTraits< ElementType >::ConstInitType Element )	Adds an element to the octree.	Math/GenericOctree.h
void ApplyOffset ( const FVector& InOffset, bool bGlobalOctree )	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	Math/GenericOctree.h
void Destroy()		Math/GenericOctree.h
void DumpStats()	Writes stats for the octree to the log.	Math/GenericOctree.h
const ElementType & GetElementById ( FOctreeElementId ElementId ) const	Accesses an octree element by ID.	Math/GenericOctree.h
ElementType & GetElementById ( FOctreeElementId ElementId )	Accesses an octree element by ID.	Math/GenericOctree.h
FReal GetNodeLevelExtent ( int32 Level ) const		Math/GenericOctree.h
FBoxCenterAndExtent GetRootBounds()		Math/GenericOctree.h
SIZE_T GetSizeBytes()		Math/GenericOctree.h
bool IsValidElementId ( FOctreeElementId ElementId ) const	Checks if given ElementId represents a valid Octree element	Math/GenericOctree.h
void RemoveElement ( FOctreeElementId ElementId )	Removes an element from the octree.	Math/GenericOctree.h
void ShrinkElements()		Math/GenericOctree.h

Name	Remarks	Include Path	Unreal Specifiers
void SetElementId ( const ElementType& Element, FOctreeElementId Id )	Redirects SetElementId call to the proper implementation	Math/GenericOctree.h

Name	Remarks	Include Path	Unreal Specifiers
TOctree_DEPRECATED ()	DO NOT USE. This constructor is for internal usage only for hot-reload purposes.	Math/GenericOctree.h
TOctree_DEPRECATED ( const FVector& InOrigin, FReal InExtent )	Initialization constructor.	Math/GenericOctree.h