TOctree_DEPRECATED

An octree.

Windows
MacOS
Linux

References

Module

Core

Header

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

Include

#include "Math/GenericOctree.h"

Syntax

template<typename ElementType, typename OctreeSemantics>
class TOctree_DEPRECATED

Remarks

An octree.

Constructors

Name Description

Public function

TOctree_DEPRECATED()

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

Public function

TOctree_DEPRECATED

(
    const FVector& InOrigin,
    float InExtent
)

Initialization constructor.

Functions

Name Description

Public function

void

 

AddElement

(
    typename TTypeTraits< ElementType >...
)

Adds an element to the octree.

Public function

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

Public function

void

 

Destroy()

Public function Const

void

 

DumpStats()

Writes stats for the octree to the log.

Public function

ElementType ...

 

GetElementById

(
    FOctreeElementId ElementId
)

Accesses an octree element by ID.

Public function Const

const Elemen...

 

GetElementById

(
    FOctreeElementId ElementId
)

Accesses an octree element by ID.

Public function Const

float

 

GetNodeLevelExtent

(
    int32 Level
)

Public function Const

FBoxCenterAn...

 

GetRootBounds()

Public function Const

SIZE_T

 

GetSizeBytes()

Public function Const

bool

 

IsValidElementId

(
    FOctreeElementId ElementId
)

Checks if given ElementId represents a valid Octree element

Public function

void

 

RemoveElement

(
    FOctreeElementId ElementId
)

Removes an element from the octree.

Protected function

void

 

SetElementId

(
    const ElementType& Element,
    FOctreeElementId Id
)

Redirects SetElementId call to the proper implementation

Public function

void

 

ShrinkElements()

Classes

Name

Description

Public class

FNode

A node in the octree.

Public class

FNodeReference

A reference to an octree node, its context, and a read lock.

Public class

TConstElementBoxIterator

Iterates over the elements in the octree that intersect a bounding box.

Public class

TConstIterator

An octree node iterator.

Typedefs

Name

Description

DefaultStackAllocator

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

ElementArrayType

ElementConstIt

Deprecated Functions

Name Description

Public function

 

TOctree_DEPRECATED()

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

Public function

 

TOctree_DEPRECATED

(
    const FVector& InOrigin,
    float InExtent
)

Initialization constructor.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss