1. Epic GamesDeveloper
  3. FKSphylElem

FKSphylElem

Capsule shape used for collision. Z axis is capsule axis.

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

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/PhysicsEngine/SphylElem.h
Include #include "PhysicsEngine/SphylElem.h"

Syntax

USTRUCT ()  
struct FKSphylElem : public FKShapeElem

Remarks

Capsule shape used for collision. Z axis is capsule axis.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere FVector Center Position of the capsule's origin
Public variable UProperty Category, EditAnywhere float Length This is of line-segment ie. add Radius to both ends to find total length.
Public variable UProperty Category, EditAnywhere float Radius Radius of the capsule
Public variable UProperty Category, EditAnywhere, Meta FRotator Rotation Rotation of the capsule

Constructors

  Type Name Description
Public function    
Public function  

FKSphylElem ( float InRadius,
float InLength
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const FBox

CalcAABB ( const FTransform& BoneTM,
float Scale
)

  
Public function Const void

DrawElemSolid ( FPrimitiveDrawInterface* PDI,
const FTransform& ElemTM,
const FVector& Scale3D,
const FMaterialRenderProxy* MaterialRenderProxy
)

  
Public function Const void

DrawElemSolid ( FPrimitiveDrawInterface* PDI,
const FTransform& ElemTM,
float Scale,
const FMaterialRenderProxy* MaterialRenderProxy
)

  
Public function Const void

DrawElemWire ( FPrimitiveDrawInterface* PDI,
const FTransform& ElemTM,
const FVector& Scale3D,
const FColor Color
)

  
Public function void  
Public function Const float

GetClosestPointAndNormal ( const FVector& WorldPosition,
const FTransform& BodyToWorldTM,
FVector& ClosestWorldPosition,
FVector& Normal
)

 Finds the closest point on the shape given a world position.
Public function Const void

GetElemSolid ( const FTransform& ElemTM,
const FVector& Scale3D,
const FMaterialRenderProxy* MaterialRenderProxy,
int32 ViewIndex,
FMeshElementCollector& Collector
)

  
Public function Const FKSphylElem

GetFinalScaled ( const FVector& Scale3D,
const FTransform& RelativeTM
)

  
Public function Const float

GetScaledCylinderLength ( const FVector& Scale3D
)

 Returns the scaled length of the cylinder part of the Sphyl
Public function Const float

GetScaledHalfLength ( const FVector& Scale3D
)

 Returns half of the total scaled length of the Sphyl, which includes the scaled top and bottom caps
Public function Const float

GetScaledRadius ( const FVector& Scale3D
)

 Returns the scaled radius for this Sphyl, which is determined by the Max scale on X/Y and clamped by half the total length
Public function Const FVector::FReal

GetScaledVolume ( const FVector& Scale3D
)

  
Public function Const float

GetShortestDistanceToPoint ( const FVector& WorldPosition,
const FTransform& BodyToWorldTM
)

 Finds the shortest distance between the element and a world position.
Public function Const FTransform Utility function that builds an FTransform from the current data.
Public function Const FVector::FReal

GetVolume ( const FVector& Scale
)

  
Public function void

ScaleElem ( FVector DeltaSize,
float MinSize
)

  
Public function void

SetTransform ( const FTransform& InTransform
)

  

Overridden from FKShapeElem

  Type Name Description
Public function Virtual Const void

DrawElemWire ( FPrimitiveDrawInterface* PDI,
const FTransform& ElemTM,
float Scale,
const FColor Color
)

  

Constants

Name Description
StaticShapeType  

Deprecated Variables

  Type Name Description
Public variable UProperty FQuat Orientation_DEPRECATED  
Public variable UProperty FMatrix TM_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page