UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Types | Public Member Functions | Public Attributes | List of all members
FOctreeNodeContext Class Reference

#include <GenericOctree.h>

Public Types

enum  { LoosenessDenominator = 16 }
 
using FReal = FVector4::FReal
 

Public Member Functions

 FOctreeNodeContext ()
 
 FOctreeNodeContext (uint32 InInCullBits, uint32 InOutCullBits)
 
 FOctreeNodeContext (const FBoxCenterAndExtent &InBounds)
 
 FOctreeNodeContext (const FBoxCenterAndExtent &InBounds, uint32 InInCullBits, uint32 InOutCullBits)
 
VectorRegister GetChildOffsetVec (int i) const
 
FOctreeNodeContext GetChildContext (FOctreeChildNodeRef ChildRef) const
 
void GetChildContext (FOctreeChildNodeRef ChildRef, FOctreeNodeContext *ChildContext) const
 
FOctreeNodeContext GetChildContext (FOctreeChildNodeRef ChildRef, uint32 InInCullBits, uint32 InOutCullBits) const
 
FOctreeChildNodeSubset GetIntersectingChildren (const FBoxCenterAndExtent &BoundingBox) const
 
FOctreeChildNodeRef GetContainingChild (const FBoxCenterAndExtent &BoundingBox) const
 

Public Attributes

FBoxCenterAndExtent Bounds
 
FReal ChildExtent
 
FReal ChildCenterOffset
 
uint32 InCullBits
 
uint32 OutCullBits
 

Detailed Description

The context of an octree node, derived from the traversal of the tree.

Member Typedef Documentation

◆ FReal

using FOctreeNodeContext::FReal = FVector4::FReal

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

The node bounds are expanded by their extent divided by LoosenessDenominator.

Enumerator
LoosenessDenominator 

Constructor & Destructor Documentation

◆ FOctreeNodeContext() [1/4]

FOctreeNodeContext::FOctreeNodeContext ( )
inline

Default constructor.

◆ FOctreeNodeContext() [2/4]

FOctreeNodeContext::FOctreeNodeContext ( uint32  InInCullBits,
uint32  InOutCullBits 
)
inline

Initialization constructor, this one is used when we done care about the box anymore

◆ FOctreeNodeContext() [3/4]

FOctreeNodeContext::FOctreeNodeContext ( const FBoxCenterAndExtent &  InBounds)
inline

Initialization constructor.

◆ FOctreeNodeContext() [4/4]

FOctreeNodeContext::FOctreeNodeContext ( const FBoxCenterAndExtent &  InBounds,
uint32  InInCullBits,
uint32  InOutCullBits 
)
inline

Initialization constructor.

Member Function Documentation

◆ GetChildContext() [1/3]

FOctreeNodeContext FOctreeNodeContext::GetChildContext ( FOctreeChildNodeRef  ChildRef) const
inline

Child node initialization constructor.

◆ GetChildContext() [2/3]

void FOctreeNodeContext::GetChildContext ( FOctreeChildNodeRef  ChildRef,
FOctreeNodeContext *  ChildContext 
) const
inline

Construct a child context given the child ref. Optimized to remove all LHS.

◆ GetChildContext() [3/3]

FOctreeNodeContext FOctreeNodeContext::GetChildContext ( FOctreeChildNodeRef  ChildRef,
uint32  InInCullBits,
uint32  InOutCullBits 
) const
inline

Child node initialization constructor.

◆ GetChildOffsetVec()

VectorRegister FOctreeNodeContext::GetChildOffsetVec ( int  i) const
inline

◆ GetContainingChild()

FOctreeChildNodeRef FOctreeNodeContext::GetContainingChild ( const FBoxCenterAndExtent &  BoundingBox) const
inline

Determines which of the octree node's children contain the whole bounding box, if any.

Parameters
BoundingBox- The bounding box to check for intersection with.
Returns
The octree's node that the bounding box is farthest from the outside edge of, or an invalid node ref if it's not contained by any of the children.

◆ GetIntersectingChildren()

FOctreeChildNodeSubset FOctreeNodeContext::GetIntersectingChildren ( const FBoxCenterAndExtent &  BoundingBox) const
inline

Determines which of the octree node's children intersect with a bounding box.

Parameters
BoundingBox- The bounding box to check for intersection with.
Returns
A subset of the children's nodes that intersect the bounding box.

Member Data Documentation

◆ Bounds

FBoxCenterAndExtent FOctreeNodeContext::Bounds

The bounds of the node.

◆ ChildCenterOffset

FReal FOctreeNodeContext::ChildCenterOffset

The offset of the childrens' centers from the center of this node.

◆ ChildExtent

FReal FOctreeNodeContext::ChildExtent

The extent of the node's children.

◆ InCullBits

uint32 FOctreeNodeContext::InCullBits

Bits used for culling, semantics left up to the caller (except that it is always set to zero at the root). This does not consume storage because it is leftover in the padding.

◆ OutCullBits

uint32 FOctreeNodeContext::OutCullBits

Bits used for culling, semantics left up to the caller (except that it is always set to zero at the root). This does not consume storage because it is leftover in the padding.

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