FDefaultSpatialPartitionCollection

The default spatial partition collection to manage dynamic and static objects.

API > API/Runtime > API/Runtime/ChaosSpatialPartitions

The default spatial partition collection to manage dynamic and static objects. Static object updates are handled by moving objects between clean/dirty states where the structures can be fully rebuilt at a larger cost. This is meant to be the default implementation for Chaos.

   
Name FDefaultSpatialPartitionCollection
Type class
Header File /Engine/Source/Runtime/Experimental/ChaosSpatialPartitions/Public/ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h
Include Path #include "ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h"

Syntax

class FDefaultSpatialPartitionCollection : public ISpatialPartition

Implements Interfaces

  • ISpatialPartition

Constructors

Name Remarks Include Path Unreal Specifiers
  ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  
  ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FDefaultSpatialPartitionCollection()

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

Structs

Name Remarks
FConfig  
FEntry  
TInternalVisitor  

Typedefs

Name Type Remarks Include Path
FEntryArray Chaos::THandleArray< FEntry >   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h
FEntryHandle typename FEntryArray::FHandle   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h
FInternalOverlapVisitor TInternalVisitor< FOverlapVisitor, FOverlapQueryRuntimeData >   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h
FInternalRaycastVisitor TInternalVisitor< FRaycastVisitor, FRaycastQueryRuntimeData >   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h
FInternalSweepVisitor TInternalVisitor< FSweepVisitor, FSweepQueryRuntimeData >   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
DirtyStaticEntries TArray< FEntryHandle >   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  
DynamicGlobal FNSquaredAabb   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  
DynamicTree FDynamicAabbTree   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  
Entries FEntryArray   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  
StaticDirty FDynamicAabbTree   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  
StaticGlobal FNSquaredAabb   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  
StaticRebuildContext TUniquePtr< FStaticAabbTree::FRebuildContext >   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  
StaticTree FStaticAabbTree   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

Functions

Public

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void Insert ( const FUserDataType& UserData,
const FAABB3& Aabb,
const FSpatialClassification& Classification,
FSpatialHandle& OutHandle
)

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

virtual bool NeedsRebuilding()

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

virtual void Overlap ( const FOverlapQueryData& QueryData,
FOverlapVisitor& Visitor,
ESpatialCategoryMask CategoryMask
) const

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

virtual void Raycast ( const FRaycastQueryData& QueryData,
FRaycastVisitor& Visitor,
ESpatialCategoryMask CategoryMask
) const

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

virtual ERebuildStatus Rebuild()

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

virtual void Remove ( FSpatialHandle& InOutHandle
)

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

virtual void Sweep ( const FSweepQueryData& QueryData,
FSweepVisitor& Visitor,
ESpatialCategoryMask CategoryMask
) const

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

virtual void Update ( const FUserDataType& UserData,
const FAABB3& Aabb,
const FSpatialClassification& Classification,
FSpatialHandle& InOutHandle
)

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

Static

Name Remarks Include Path Unreal Specifiers

static EVisitResult Query ( const SpatialPartitionType& SpatialPartition,
FOverlapQueryRuntimeData& QueryRuntimeData,
FOverlapVisitor& Visitor
)

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

static EVisitResult Query ( const SpatialPartitionType& SpatialPartition,
FSweepQueryRuntimeData& QueryRuntimeData,
FSweepVisitor& Visitor
)

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

static EVisitResult Query ( const SpatialPartitionType& SpatialPartition,
FRaycastQueryRuntimeData& QueryRuntimeData,
FRaycastVisitor& Visitor
)

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

static EInternalCategory SetOrClearFlag ( const EInternalCategory Flags,
const EInternalCategory Flag,
bool bState
)

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

static EInternalCategory ToInternalCategory ( const ESpatialCategory& Category,
const bool bDirty,
const bool bGlobal
)

   ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

Operators

Name Remarks Include Path Unreal Specifiers
  ChaosSpatialPartitions/Collections/DefaultSpatialPartitionCollection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page