1. Epic GamesDeveloper
  3. FCapsule

FCapsule

API > API/Runtime > API/Runtime/Chaos

   
Name FCapsule
Type class
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Capsule.h
Include Path #include "Chaos/Capsule.h"

Syntax

class FCapsule : public Chaos::FImplicitObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FCapsule ( const FVec3& x1,
const FVec3& x2,
const FReal Radius
)

   Chaos/Capsule.h  

FCapsule ( const FCapsule& Other
)

   Chaos/Capsule.h  
  Chaos/Capsule.h  

FCapsule ( FCapsule&& Other
)

   Chaos/Capsule.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FCapsule()

   Chaos/Capsule.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
MSegment TSegment< FRealSingle >   Chaos/Capsule.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TArray< FVec3 > ComputeLocalSamplePoints ( const int32 NumPoints
) const

 Returns sample points centered about the origin. Chaos/Capsule.h  

TArray< FVec3 > ComputeLocalSamplePoints ( const FReal PointsPerUnitArea,
const int32 MinPoints,
const int32 MaxPoints
) const

 Returns sample points centered about the origin. Chaos/Capsule.h  

TArray< FVec3 > ComputeSamplePoints ( const FReal PointsPerUnitArea,
const int32 MinPoints,
const int32 MaxPoints
) const

 Returns sample points at the current location of the cylinder. Chaos/Capsule.h  

TArray< FVec3 > ComputeSamplePoints ( const int32 NumPoints
) const

 Returns sample points at the current location of the cylinder. Chaos/Capsule.h  

int32 FindVertexPlanes ( int32 VertexIndex,
int32* OutVertexPlanes,
int32 MaxVertexPlanes
) const

 Get an array of all the plane indices that belong to a vertex (up to MaxVertexPlanes). Chaos/Capsule.h  

FReal GetArea ()

   Chaos/Capsule.h  

const FVec3 GetAxis()

   Chaos/Capsule.h  

const FVec3f GetAxisf()

   Chaos/Capsule.h  

FVec3 GetCenter()

   Chaos/Capsule.h  

FVec3f GetCenterf()

   Chaos/Capsule.h  

FVec3 GetCenterOfMass()

 Returns the centroid (center of mass). Chaos/Capsule.h  

FVec3f GetCenterOfMassf()

   Chaos/Capsule.h  

FVec3 GetClosestEdgePosition ( int32 PlaneIndexHint,
const FVec3& Position
) const

   Chaos/Capsule.h  

FReal GetHeight()

   Chaos/Capsule.h  

FRealSingle GetHeightf()

   Chaos/Capsule.h  

FMatrix33 GetInertiaTensor ( const FReal Mass
) const

   Chaos/Capsule.h  

const FVec3f GetInsertion()

 Returns the topmost point on the capsule. Chaos/Capsule.h  

int32 GetMostOpposingPlane ( const FVec3& Normal
) const

 Get the index of the plane that most opposes the normal not applicable for capsules Chaos/Capsule.h  

int32 GetMostOpposingPlaneScaled ( const FVec3& Normal,
const FVec3& Scale
) const

   Chaos/Capsule.h  

const FVec3 GetOrigin()

 Returns the bottommost point on the capsule. Chaos/Capsule.h  

const FVec3f GetOriginf()

   Chaos/Capsule.h  

const TPlaneConcrete< FReal, 3 > GetPlane ( int32 FaceIndex
) const

 Get the plane at the specified index (e.g., indices from FindVertexPlanes) Chaos/Capsule.h  

void GetPlaneNX ( const int32 FaceIndex,
FVec3& OutN,
FVec3& OutX
) const

   Chaos/Capsule.h  

int32 GetPlaneVertex ( int32 PlaneIndex,
int32 PlaneVertexIndex
) const

 Get the vertex index of one of the vertices making up the corners of the specified face Used for manifold generation Chaos/Capsule.h  

FRotation3 GetRotationOfMass ()

   Chaos/Capsule.h  

TSegment< FReal > GetSegment()

   Chaos/Capsule.h  

const FVec3 GetVertex ( int32 VertexIndex
) const

 Get the vertex at the specified index (e.g., indices from GetPlaneVertexs) Used for manifold generation Chaos/Capsule.h  

int32 GetVertexPlanes3 ( int32 VertexIndex,
int32& PlaneIndex0,
int32& PlaneIndex1,
int32& PlaneIndex2
) const

 Get up to the 3 plane indices that belong to a vertex Returns the number of planes found. Chaos/Capsule.h  

FReal GetVolume ()

   Chaos/Capsule.h  

FReal GetWindingOrder()

 Returns a winding order multiplier used in the manifold clipping and required when we have negative scales (See ImplicitObjectScaled) Not used for capsules Used for manifold generation Chaos/Capsule.h  

const FVec3 GetX1()

   Chaos/Capsule.h  

const FVec3f GetX1f()

   Chaos/Capsule.h  

FVec3 GetX2()

   Chaos/Capsule.h  

FVec3f GetX2f()

   Chaos/Capsule.h  

int32 NumPlanes()

 Capsules have no planes Used for manifold generation Chaos/Capsule.h  

int32 NumPlaneVertices ( int32 PlaneIndex
) const

 The number of vertices that make up the corners of the specified face In the case of a capsule the segment will act as a degenerate face Used for manifold generation Chaos/Capsule.h  

void SerializeImp ( FArchive& Ar
)

   Chaos/Capsule.h  

FReal SignedDistance ( const FVec3& x
) const

 Explicitly non-virtual. Must cast to derived types to target their implementation. Chaos/Capsule.h  

FVec3 Support ( const FVec3& Direction,
const FReal Thickness,
int32& VertexIndex
) const

   Chaos/Capsule.h  

FVec3 SupportCore ( const FVec3& Direction,
const FReal InMargin,
FReal* OutSupportDelta,
int32& VertexIndex
) const

   Chaos/Capsule.h  

FVec3f SupportCore ( const FVec3f& Direction,
const FRealSingle InMargin,
FRealSingle* OutSupportDelta,
int32& VertexIndex
) const

   Chaos/Capsule.h  

FVec3 SupportCoreScaled ( const FVec3& Direction,
const FReal InMargin,
const FVec3& Scale,
FReal* OutSupportDelta,
int32& VertexIndex
) const

   Chaos/Capsule.h  

VectorRegister4Float SupportCoreSimd ( const VectorRegister4Float& Direction,
const FReal InMargin
) const

   Chaos/Capsule.h  

FVec3f Supportf ( const FVec3f& Direction,
const FRealSingle Thickness,
int32& VertexIndex
) const

   Chaos/Capsule.h  

Overridden from FImplicitObject

Name Remarks Include Path Unreal Specifiers

virtual const FAABB3 BoundingBox()

   Chaos/Capsule.h  

virtual FAABB3 CalculateTransformedBounds ( const FRigidTransform3& Transform
) const

 Calculate the tight-fitting world-space bounding box. Chaos/Capsule.h  

virtual Chaos::FImplicitObjectPtr CopyGeometry()

   Chaos/Capsule.h  

virtual Chaos::FImplicitObjectPtr CopyGeometryWithScale ( const FVec3& Scale
) const

   Chaos/Capsule.h  

virtual FReal GetRadius()

   Chaos/Capsule.h  

virtual FRealSingle GetRadiusf()

   Chaos/Capsule.h  

virtual uint32 GetTypeHash()

   Chaos/Capsule.h  

virtual FName GetTypeName ()

   Chaos/Capsule.h  

virtual FReal PhiWithNormal ( const FVec3& x,
FVec3& Normal
) const

 Find the closest point on the surface, and return the separating distance and axis. Chaos/Capsule.h  

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

 This gives derived types a way to avoid calling PhiWithNormal todo: this api is confusing. Chaos/Capsule.h  

virtual void Serialize ( FChaosArchive& Ar
)

   Chaos/Capsule.h  

virtual FString ToString()

   Chaos/Capsule.h  

Static

Name Remarks Include Path Unreal Specifiers

static FReal GetArea ( const FReal Height,
const FReal Radius
)

   Chaos/Capsule.h  

static FMatrix33 GetInertiaTensor ( const FReal Mass,
const FReal Height,
const FReal Radius
)

   Chaos/Capsule.h  

static FRotation3 GetRotationOfMass ( const FVec3& Axis
)

   Chaos/Capsule.h  

static const FName GetTypeName ( const EImplicitObjectType InType
)

   Chaos/Capsule.h  

static FReal GetVolume ( const FReal Height,
const FReal Radius
)

   Chaos/Capsule.h  

static FCapsule NewFromOriginAndAxis ( const FVec3& Origin,
const FVec3& Axis,
const FReal Height,
const FReal Radius
)

   Chaos/Capsule.h  

static bool RaycastFast ( FReal MRadius,
FReal MHeight,
const FVec3& MVector,
const FVec3& X1,
const FVec3& X2,
const FVec3& StartPoint,
const FVec3& Dir,
const FReal Length,
const FReal Thickness,
FReal& OutTime,
FVec3& OutPosition,
FVec3& OutNormal,
int32& OutFaceIndex
)

   Chaos/Capsule.h  

static EImplicitObjectType StaticType()

   Chaos/Capsule.h  

Operators

Name Remarks Include Path Unreal Specifiers

FCapsule & operator= ( FCapsule&& InSteal
)

   Chaos/Capsule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page