1. Epic GamesDeveloper
  3. TAABBTree

TAABBTree

Unreal Engine C++ API Reference > Runtime > Chaos > Chaos

Inheritance Hierarchy

References

   
Module Chaos
Header /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/AABBTree.h
Include #include "Chaos/AABBTree.h"

Syntax

template<typename TPayloadType, typename TLeafType, bool bMutable, typename T, typename StorageTraits>  
class TAABBTree : public Chaos::ISpatialAcceleration< TPayloadType, FReal, 3 >

Constructors

  Type Name Description
Public function    
Public function  

TAABBTree ( const TParticles& Particles,
int32 InMaxChildrenInLeaf,
int32 InMaxTreeDepth,
T InMaxPayloadBounds,
int32 InMaxNumToProcess,
bool bInDynamicTree,
bool bInUseDirtyTree,
bool bInBuildOverlapCache
)

  
Public function  

TAABBTree ( EmptyInit,
int32 InMaxChildrenInLeaf,
int32 InMaxTreeDepth,
T InMaxPayloadBounds,
int32 InMaxNumToProcess,
bool bInDynamicTree,
bool bInUseDirtyTree,
bool bInBuildOverlapCache
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function int32

AddDirtyElementToGrid ( const TAABB< T, 3 >& NewBounds,
int32 NewDirtyElement
)

  
Public function bool Returns true if there was enough space in the cell to add the new dirty element index or if the element was already added (This second condition should not happen)
Public function void

AddNodesOverlappingLeaves ( const TAABBTreeNode< T >& LeftNode,
const TAABB< T, 3 >& LeftBounds,
const TAABBTreeNode< T >& RightNode,
const TAABB< T, 3 >& RightBounds,
const bool bDirtyFilter
)

 Recursively add overlapping leaves given 2 nodes in the tree
Public function void

AddRootOverlappingLeaves ( const TAABBTreeNode< T >& TreeNode,
const bool bDirtyFilter
)

 Recursively add overlapping leaves given a root node in the tree
Public function int32  
Public function NodeAndLeafIndices

AllocateLeafNodeAndLeaf ( const TPayloadType& Payload,
const TAABB< T, 3 >& NewBounds
)

  
Public function Virtual void Cache for each leaves all the overlapping leaves
Public function Virtual void Contract: bShouldRebuild can only ever be cleared by calling the ClearShouldRebuild method, it can be set at will though.
Public function void Sequential loop over the leaves to fill the overlapping pairs
Public function void

ComputeOverlappingCacheFromRoot ( const bool bDirtyFilter
)

 Simultaneous tree descent to compute the overlapping leaves
Public function Virtual Const TUniquePtr< ISpatialAcceleration< TPayloadType, T, 3 > >

Copy ()

  
Public function void

CopyFrom ( const TAABBTree& Other
)

  
Public function void  
Public function void  
Public function Const FElementsCollection  
Public function void

DeleteDirtyParticleEverywhere ( int32 DeleteDirtyParticleIdx,
int32 DeleteDirtyGridOverflowIdx
)

  
Public function bool Returns true if the dirty particle was in the grid and successfully deleted.
Public function Const bool  
Public function Virtual Const void  
Public function Virtual Const void  
Public function Const void Expensive function: Don't call unless debugging.
Public function bool  
Public function void Fill the overlapping pairs from the previous persistent and not dirty leaves
Public function Virtual Const TArray< TPayloadType >

FindAllIntersections ( const FAABB3& Box
)

 IMPORTANT : (LWC) this API should be typed on Freal not T, as we want the query API to be using the highest precision while maintaining arbitrary internal precision for the acceleration structure ( based on T )
Public function int32

FindBestSibling ( const TAABB< T, 3 >& InNewBounds,
bool& bOutAddToLeaf
)

  
Public function void

FindOverlappingLeaf ( const int32 FirstNode,
const int32 LeafIndex,
TArray< int32 >& NodeStack
)

 Given a first node and a leaf index find the overlapping leaves and update the node stack
Public function const AABBTreeExpensiveStatistics &  
Public function const AABBTreeStatistics & Some useful statistics.
Public function bool

GetAsBoundsArray ( TArray< TAABB< T, 3 > >& AllBounds,
int32 NodeIdx,
int32 ParentNode,
TAABB< T, 3 >& Bounds
)

  
Public function void This is to make sure important parameters are not changed during inopportune times.
Public function Const const TArray< TLeafType > &  
Public function Const const TArray< TAABBTreeNode< T > > &  
Public function int32

GetSiblingIndex ( int32 NodeIdx
)

 Is the input node Child 0 or Child 1?
Public function const int32

GetSubtreeDepth ( const int32 NodeIdx
)

  
Public function Const const TArray< TPayloadBoundsElement< TPayloadType, T > > &  
Public function NodeAndLeafIndices

InsertLeaf ( const TPayloadType& Payload,
const TAABB< T, 3 >& NewBounds
)

 Returns the inserted node and leaf.
Public function Virtual Const bool  
Public function Const int32  
Public function Const void

Overlap ( const FAABB3& QueryBounds,
SQVisitor& Visitor
)

  
Public function Virtual Const void

Overlap ( const FAABB3& QueryBounds,
ISpatialVisitor< TPayloadType, FReal >& Visitor
)

  
Public function Const bool

OverlapFast ( const FAABB3& QueryBounds,
SQVisitor& Visitor
)

  
Public function Virtual void

PrepareCopyTimeSliced ( const ISpatialAcceleration< TPayloadType, T, 3 >& InFrom
)

  
Public function void Print the overlapping leaves data structure
Public function Virtual void

ProgressAsyncTimeSlicing ( bool ForceBuildCompletion
)

  
Public function Virtual void

ProgressCopyTimeSliced ( const ISpatialAcceleration< TPayloadType, T, 3 >& InFrom,
int MaximumBytesToCopy
)

  
Public function void Propagates the leaves dirty flag up to the root node
Public function Const void

Raycast ( const FVec3& Start,
const FVec3& Dir,
const FReal Length,
SQVisitor& Visitor
)

  
Public function Virtual Const void

Raycast ( const FVec3& Start,
const FVec3& Dir,
const FReal Length,
ISpatialVisitor< TPayloadType, FReal >& Visitor
)

  
Public function Const bool

RaycastFast ( const FVec3& Start,
FQueryFastData& CurData,
SQVisitor& Visitor,
const FVec3& Dir,
const FVec3 InvDir,
const bool bParallel
)

  
Public function void

Reinitialize ( const ParticleView& Particles,
int32 InMaxChildrenInLeaf,
int32 InMaxTreeDepth,
T InMaxPayloadBounds,
int32 InMaxNumToProcess,
bool bInDynamicTree,
bool bInbBuildOverlapCache
)

  
Public function Virtual bool

RemoveElement ( const TPayloadType& Payload
)

 Returns true if element was removed successfully.
Public function void

RemoveLeafNode ( int32 LeafNodeIdx,
const TPayloadType& Payload
)

  
Public function Virtual void

Reset ()

  
Public function void

RotateNode ( uint32 NodeIdx,
bool debugAssert
)

 Rotate nodes to decrease tree cost Grandchildren can swap with their aunts
Public function Virtual void  
Public function void  
Public function Virtual bool  
Public function Virtual Const void

Sweep ( const FVec3& Start,
const FVec3& Dir,
const FReal Length,
const FVec3 QueryHalfExtents,
ISpatialVisitor< TPayloadType, FReal >& Visitor
)

  
Public function Const void

Sweep ( const FVec3& Start,
const FVec3& Dir,
const FReal Length,
const FVec3 QueryHalfExtents,
SQVisitor& Visitor
)

  
Public function Const bool

SweepFast ( const FVec3& Start,
FQueryFastData& CurData,
const FVec3 QueryHalfExtents,
SQVisitor& Visitor,
const FVec3& Dir,
const FVec3 InvDir,
const bool bParallel
)

  
Public function void

UpdateAncestorBounds ( int32 NodeIdx,
bool bDoRotation
)

  
Public function int32

UpdateDirtyElementInGrid ( const TAABB< T, 3 >& NewBounds,
int32 DirtyElementIndex,
int32 DirtyGridOverflowIdx
)

  
Public function Virtual bool

UpdateElement ( const TPayloadType& Payload,
const TAABB< T, 3 >& NewBounds,
bool bInHasBounds
)

 Returns true if element was updated, or false when it was added instead.
Public function bool

ValidateBounds ( const TAABB< T, 3 >& Bounds
)

 Returns true if bounds appear valid. Returns false if extremely large values, contains NaN, or is empty.
Public function int32

WhichChildAmI ( int32 NodeIdx
)

 Is the input node Child 0 or Child 1?

Classes

  Type Name Description
Public struct EmptyInit Tag dispatch enable for the below constructor to allow setting up the defaults without an initial set of particles.  
Public struct FElementsCollection    
Public struct NodeAndLeafIndices    

Enums

  Type Name Description
Private enum eTimeSlicePhase    

Typedefs

Name Description
FElement  
FNode  
FNodeIndexAndCost Buffers for calculating the best candidate for tree insertion, reset per-calculation to avoid over allocation Tuple of Node/Index/Cost here avoids cache miss when accessing the node and its cost.
PayloadType  
TType  

Constants

Name Description
D  
DefaultMaxChildrenInLeaf  
DefaultMaxNumToProcess  
DefaultMaxPayloadBounds  
DefaultMaxTreeDepth  
StaticType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.