Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Math
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
| Type | Name | Description | |
|---|---|---|---|
| DO NOT USE. This constructor is for internal usage only for hot-reload purposes. | |||
TOctree_DEPRECATED
(
const FVector& InOrigin, |
Initialization constructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddElement
(
typename TTypeTraits< ElementType >::ConstInitType Element |
Adds an element to the octree. | |
| void | ApplyOffset
(
const FVector& InOffset, |
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 | |
| void | Destroy () |
||
| void | DumpStats () |
Writes stats for the octree to the log. | |
| ElementType & | GetElementById
(
FOctreeElementId ElementId |
Accesses an octree element by ID. | |
| const ElementType & | GetElementById
(
FOctreeElementId ElementId |
Accesses an octree element by ID. | |
| FReal | GetNodeLevelExtent
(
int32 Level |
||
| FBoxCenterAndExtent | |||
| SIZE_T | GetSizeBytes () |
||
| bool | IsValidElementId
(
FOctreeElementId ElementId |
Checks if given ElementId represents a valid Octree element | |
| void | RemoveElement
(
FOctreeElementId ElementId |
Removes an element from the octree. | |
| void | SetElementId
(
const ElementType& Element, |
Redirects SetElementId call to the proper implementation | |
| void |
Classes
| Type | Name | Description | |
|---|---|---|---|
| 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. |
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 | |
| FReal |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
| DO NOT USE. This constructor is for internal usage only for hot-reload purposes. | |||
TOctree_DEPRECATED
(
const FVector& InOrigin, |
Initialization constructor. |