UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FOctreeChildNodeRef Class Reference

#include <GenericOctree.h>

Public Member Functions

 FOctreeChildNodeRef (int8 InX, int8 InY, int8 InZ)
 
 FOctreeChildNodeRef (int8 InIndex=0)
 
UE_FORCEINLINE_HINT void Advance ()
 
UE_FORCEINLINE_HINT bool IsNULL () const
 
UE_FORCEINLINE_HINT void SetNULL ()
 
UE_FORCEINLINE_HINT int32 X () const
 
UE_FORCEINLINE_HINT int32 Y () const
 
UE_FORCEINLINE_HINT int32 Z () const
 

Public Attributes

int8 Index
 

Detailed Description

A reference to a child of an octree node.

Constructor & Destructor Documentation

◆ FOctreeChildNodeRef() [1/2]

FOctreeChildNodeRef::FOctreeChildNodeRef ( int8  InX,
int8  InY,
int8  InZ 
)
inline

Initialization constructor.

◆ FOctreeChildNodeRef() [2/2]

FOctreeChildNodeRef::FOctreeChildNodeRef ( int8  InIndex = 0)
inline

Initialized the reference with a child index.

Member Function Documentation

◆ Advance()

UE_FORCEINLINE_HINT void FOctreeChildNodeRef::Advance ( )
inline

Advances the reference to the next child node. If this was the last node remain, Index will be 8 which represents null.

◆ IsNULL()

UE_FORCEINLINE_HINT bool FOctreeChildNodeRef::IsNULL ( ) const
inline
Returns
true if the reference isn't set.

◆ SetNULL()

UE_FORCEINLINE_HINT void FOctreeChildNodeRef::SetNULL ( )
inline

◆ X()

UE_FORCEINLINE_HINT int32 FOctreeChildNodeRef::X ( ) const
inline

◆ Y()

UE_FORCEINLINE_HINT int32 FOctreeChildNodeRef::Y ( ) const
inline

◆ Z()

UE_FORCEINLINE_HINT int32 FOctreeChildNodeRef::Z ( ) const
inline

Member Data Documentation

◆ Index

int8 FOctreeChildNodeRef::Index

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