1. Epic GamesDeveloper
  3. TOctree2

TOctree2

An octree.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Math

Inheritance Hierarchy

References

   
Module Core
Header /Engine/Source/Runtime/Core/Public/Math/GenericOctree.h
Include #include "Math/GenericOctree.h"

Syntax

template<typename ElementType, typename OctreeSemantics>  
class TOctree2

Remarks

An octree.

Constructors

  Type Name Description
Public function   DO NOT USE. This constructor is for internal usage only for hot-reload purposes.
Public function  

TOctree2 ( const FVector& InOrigin,
FVector::FReal InExtent
)

 Initialization constructor.

Functions

  Type Name Description
Public function void

AddElement ( typename TCallTraits< ElementType >::ConstReference Element
)

 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 ()

 This function resets the octree to empty.
Public function Const void Writes stats for the octree to the log.
Public function Const void

FindAllElements ( const IterateAllElementsFunc& Func
)

 This function will call the passed in function for all elements in the Octree in node by node in no specified order.
Public function Const void

FindElementsWithBoundsTest ( const FBoxCenterAndExtent& BoxBounds,
const IterateBoundsFunc& Func
)

 This function will traverse the Octree using a fast box-box intersection this should be the preferred way of traversing the tree.
Public function Const void

FindElementsWithPredicate ( const PredicateFunc& Predicate,
const IterateFunc& Func
)

 This function will traverse the Octree starting from the root in depth first order and the predicate can be used to implement custom culling for each node.
Public function Const void

FindFirstElementWithBoundsTest ( const FBoxCenterAndExtent& BoxBounds,
const IterateBoundsFunc& Func
)

 This function will traverse the Octree using a fast box-box intersection and aborts traversal as soon as the Element function returns false.
Public function Const void

FindNearbyElements ( const FVector& Position,
const IterateBoundsFunc& Func
)

 This function will traverse the Octree using a tryint to find nearby nodes that contain any elements.
Public function Const void

FindNodesWithPredicate ( const PredicateFunc& Predicate,
const IterateFunc& Func
)

 This function will traverse the Octree starting from the root in depth first order and the predicate can be used to implement custom culling for each node.
Public function Const const ElementType & Accesses an octree element by ID.
Public function ElementType & Accesses an octree element by ID.
Public function Const TArrayView< const ElementType > Return all elements for a given node.
Public function Const FReal

GetNodeLevelExtent ( int32 Level
)

  
Public function Const int32  
Public function Const FBoxCenterAndExtent  
Public function Const SIZE_T  
Public function Const bool Check if a FOctreeElementId2 is valid.
Public function void Removes an element from the octree.
Protected function void

SetElementId ( const ElementType& Element,
FOctreeElementId2 Id
)

 Redirects SetElementId call to the proper implementation
Public function void  

Typedefs

Name Description
ElementArrayType  
FNodeIndex  
FReal  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page