1. Epic GamesDeveloper
  3. FImplicitObject

FImplicitObject

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

Inheritance Hierarchy

References

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

Syntax

class FImplicitObject

Variables

  Type Name Description
Protected variable bool bDoCollide  
Protected variable bool bHasBoundingBox  
Protected variable bool bIsConvex  
Protected variable bool bIsTracked  
Protected variable EImplicitObjectType CollisionType  
Protected variable FReal Margin Note: if you change the size of FImplicitObject or add fields, you will likely need to update the calculation of PadBytes below.
Protected variable EImplicitObjectType Type  

Constructors

  Type Name Description
Public function    
Public function    
Public function  

FImplicitObject ( int32 Flags,
EImplicitObjectType InType
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual Const void  
Public function Virtual Const void  
Public function TargetType *

AsA ()

  
Public function Const const TargetType *

AsA ()

 Dynamic cast to type T_DERIVED. Returns null if T_DERIVED is not a valid cast for this object.
Public function TargetType *  
Public function Const const TargetType *  
Public function Virtual Const const FAABB3  
Public function Virtual Const FAABB3 Calculate the tight-fitting world-space bounding box.
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
)

  
Public function Virtual Const int32

FindClosestFaceAndVertices ( const FVec3& Position,
TArray< FVec3 >& FaceVertices,
FReal SearchDist
)

 Finds the first intersecting face at given position
Public function Const Pair< FVec3, bool >

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

  
Public function Const Pair< FVec3, bool >

FindDeepestIntersection ( const FImplicitObject* Other,
const FParticles* Particles,
const FMatrix33& OtherToLocalTransform,
const FReal Thickness
)

  
Public function Const Pair< FVec3, bool >

FindDeepestIntersection ( const FImplicitObject* Other,
const FBVHParticles* Particles,
const FMatrix33& OtherToLocalTransform,
const FReal Thickness
)

  
Public function Virtual Const FVec3

FindGeometryOpposingNormal ( const FVec3& DenormDir,
int32 FaceIndex,
const FVec3& OriginalNormal
)

 Given a normal and a face index, compute the most opposing normal associated with the underlying geometry features.
Public function Virtual Const int32

FindMostOpposingFace ( const FVec3& Position,
const FVec3& UnitDir,
int32 HintFaceIndex,
FReal SearchDist
)

 Returns the most opposing face.
Public function Virtual Const int32

FindMostOpposingFaceScaled ( const FVec3& Position,
const FVec3& UnitDir,
int32 HintFaceIndex,
FReal SearchDist,
const FVec3& Scale
)

  
Public function Const EImplicitObjectType  
Public function Const bool  
Protected function Static FVec3

GetInnerUnscaledNormal ( const FVec3& OuterNormal,
const FVec3& Scale
)

 Convert a normal in the outer scaled object space into a normal in the inner unscaled object space.
Public function Const FReal  
Public function Virtual Const uint16

GetMaterialIndex ( uint32 HintIndex
)

  
Public function Virtual Const EImplicitObjectType  
Public function T_DERIVED *  
Public function Const const T_DERIVED *  
Public function Const const T_DERIVED &  
Public function T_DERIVED &  
Public function Static int32  
Public function Static int32  
Protected function Static FVec3

GetOuterScaledNormal ( const FVec3& InnerNormal,
const FVec3& Scale
)

 Convert a normal in the inner unscaled object space into a normal in the outer scaled object space.
Public function Const EImplicitObjectType

GetType ()

  
Public function Const uint32  
Public function Static const FName

GetTypeName ( const EImplicitObjectType InType
)

  
Public function Virtual Const FName  
Public function Const bool  
Public function Const bool

IsA ()

 Can this object be cast to type T_DERIVED?
Public function Const bool  
Public function Const bool

IsOverlappingBounds ( const FAABB3& LocalBounds
)

 Whether this implicit (possibly a hierarchy) overlaps the bounds.
Public 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 Const bool This is strictly used for optimization purposes.
Public function Virtual Const bool  
Public function Const FVec3

Normal ( const FVec3& x
)

 Explicitly non-virtual. Must cast to derived types to target their implementation.
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 FString  
Public function 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 FReal

PhiWithNormalScaled ( const FVec3& Pos,
const FVec3& Scale,
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.
Protected function Static FVec3

ScaleNormalizedHelper ( const FVec3& Normal,
const FVec3& Scale
)

 Safely scale a normalized Vec3 - used with both scale and inverse scale.
Public function Static FImplicitObject *  
Public function Virtual void  
Public function Virtual void  
Public function void  
Public function Static FArchive &  
Public function void  
Public function void

SetConvex ( const bool Convex
)

  
Public function void

SetDoCollide ( const bool Collide
)

  
Protected function void

SetMargin ( FReal InMargin
)

 Not all derived types support a margin, and for some it represents some other property (the radius of a sphere for example), so the setter should only be exposed in a derived class if at all (and it may want to change the size of the core shape as well)
Public function Const FReal

SignedDistance ( const FVec3& x
)

 Explicitly non-virtual. Must cast to derived types to target their implementation.
Public function Static constexpr EImplicitObjectType  
Public function Virtual Const FString  
Public function void

Track ( TSerializablePtr< FImplicitObject > This,
const FString& DebugInfo
)

 Turn on memory tracking. Must pass object itself as a serializable ptr so we can save it out.
Public function Const void Visit all the leaf objects in the hierarchy
Public 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.
Public function Const void Visit all the objects in the hierarchy, including inner nodes like Union and Transform
Public 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.
Public function Const void

VisitOverlappingLeafObjects ( const FAABB3& LocalBounds,
const FImplicitHierarchyVisitor& Visitor
)

 Visit all the leaf objects in the hierarchy that overlap the specified local-space bounds.
Public 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.

Typedefs

Name Description
TType  

Constants

Name Description
D  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page