1. Epic GamesDeveloper
  3. FImplicitObjectUnion

FImplicitObjectUnion

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

Inheritance Hierarchy

References

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

Syntax

class FImplicitObjectUnion : public Chaos::FImplicitObject

Variables

  Type Name Description
Protected variable TUniquePtr< Private::FImplicitBVH > BVH BVH is only created when there are many objects.
Protected variable friend FImplicitObject  
Protected variable FFLags Flags  
Protected variable FAABB3 MLocalBoundingBox  
Protected variable TArray< TUniquePtr< FImplicitObject > > MObjects  
Protected variable uint16 NumLeafObjects  

Constructors

  Type Name Description
Protected function   Needed for serialization.
Public function    
Public function    
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void  
Public function Virtual void  
Public function void  
Protected function void  
Protected function void  
Public function Const void

ForEachObject ( TFunctionRef< bool(const FImplicitObject&, const FRigidTransform3&)> Lambda
)

 The lambda returns TRUE if an object was found and iteration should stop.
Public function Const const Private::FImplicitBVH *

GetBVH ()

  
Public function Const int32 The total number of leaf objects in the hierarchy.
Public function Const int32 The total number of root objects in the hierarchy (same as GetObjects().Num())
Public function TArray< TUniquePtr< FImplicitObject > > &  
Public function Const const TArray< TUniquePtr< FImplicitObject > > &  
Protected function void  
Protected function void  
Public function void

RemoveAt ( int32 RemoveIndex
)

  
Public function void

SetAllowBVH ( const bool bInAllowBVH
)

 Enable BVH suport for this Union. This should only be done for the root Union in a hierarchy.
Protected function void

SetNumLeafObjects ( const int32 InNumLeafObjects
)

  
Public function Static constexpr EImplicitObjectType  

Overridden from FImplicitObject

  Type Name Description
Public function Virtual Const void  
Public function Virtual Const void  
Public function Virtual Const const FAABB3  
Public function Virtual Const TUniquePtr< FImplicitObject >

Copy ()

  
Public function Virtual Const TUniquePtr< FImplicitObject >

CopyWithScale ( const FVec3& Scale
)

  
Public function Virtual Const TUniquePtr< FImplicitObject >  
Public function Virtual Const TUniquePtr< FImplicitObject >

DeepCopyWithScale ( const FVec3& Scale
)

  
Public function Virtual Const FImplicitObject * Not all implicit objects can be duplicated, up to user code to use this in cases that make sense.
Public function Virtual Const void

FindAllIntersectingObjects ( TArray< Pair< const FImplicitObject*, FRigidTransform3 >>& Out,
const FAABB3& LocalBounds
)

  
Protected function Virtual Const Pair< FVec3, bool >

FindClosestIntersectionImp ( const FVec3& StartPoint,
const FVec3& EndPoint,
const FReal Thickness
)

  
Public function Virtual Const uint32  
Protected function Virtual Const bool

IsOverlappingBoundsImpl ( const FAABB3& LocalBounds
)

 This should not be public, but it needs to be callable by derived classes on another instance.
Public function Virtual Const bool  
Public function Virtual Const bool

Overlap ( const FVec3& Point,
const FReal Thickness
)

 This gives derived types a way to do an overlap check without calling PhiWithNormal todo: this api is confusing.
Public function Virtual Const FReal

PhiWithNormal ( const FVec3& x,
FVec3& Normal
)

 Find the closest point on the surface, and return the separating distance and axis.
Public function Virtual Const bool

Raycast ( const FVec3& StartPoint,
const FVec3& Dir,
const FReal Length,
const FReal Thickness,
FReal& OutTime,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex
)

 This gives derived types a way to avoid calling PhiWithNormal todo: this api is confusing.
Public function Virtual void  
Protected function Virtual Const void

VisitLeafObjectsImpl ( const FRigidTransform3& ObjectTransform,
const int32 RootObjectIndex,
int32& ObjectIndex,
int32& LeafObjectIndex,
const FImplicitHierarchyVisitor& VisitorFunc
)

 This should not be public, but it needs to be callable by derived classes on another instance.
Protected function Virtual Const bool

VisitObjectsImpl ( const FRigidTransform3& ObjectTransform,
const int32 RootObjectIndex,
int32& ObjectIndex,
int32& LeafObjectIndex,
const FImplicitHierarchyVisitorBool& VisitorFunc
)

 This should not be public, but it needs to be callable by derived classes on another instance.
Protected function Virtual Const void

VisitOverlappingLeafObjectsImpl ( const FAABB3& LocalBounds,
const FRigidTransform3& ObjectTransform,
const int32 RootObjectIndex,
int32& ObjectIndex,
int32& LeafObjectIndex,
const FImplicitHierarchyVisitor& VisitorFunc
)

 This should not be public, but it needs to be callable by derived classes on another instance.

Classes

  Type Name Description
Protected struct FFLags    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page