1. Epic GamesDeveloper
  3. FKSphylElem

FKSphylElem

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

API > API/Runtime > API/Runtime/Engine

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

   
Name FKSphylElem
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/PhysicsEngine/SphylElem.h
Include Path #include "PhysicsEngine/SphylElem.h"

Syntax

USTRUCT ()  
struct FKSphylElem : public FKShapeElem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  PhysicsEngine/SphylElem.h  

FKSphylElem ( float InRadius,
float InLength
)

   PhysicsEngine/SphylElem.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FKSphylElem()

   PhysicsEngine/SphylElem.h  

Constants

Name Type Remarks Include Path
StaticShapeType EAggCollisionShape::Type   PhysicsEngine/SphylElem.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Center FVector Position of the capsule's origin PhysicsEngine/SphylElem.h
  • Category=Capsule
  • EditAnywhere
Length float This is of line-segment ie. add Radius to both ends to find total length. PhysicsEngine/SphylElem.h
  • Category=Capsule
  • EditAnywhere
Radius float Radius of the capsule PhysicsEngine/SphylElem.h
  • Category=Capsule
  • EditAnywhere
Rotation FRotator Rotation of the capsule PhysicsEngine/SphylElem.h
  • Category=Capsule
  • EditAnywhere
  • Meta=(ClampMin="-360", ClampMax="360")

Functions

Public

Name Remarks Include Path Unreal Specifiers

FBox CalcAABB ( const FTransform& BoneTM,
float Scale
) const

   PhysicsEngine/SphylElem.h  

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

   PhysicsEngine/SphylElem.h  

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

   PhysicsEngine/SphylElem.h  

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

   PhysicsEngine/SphylElem.h  

void FixupDeprecated ( FArchive& Ar
)

   PhysicsEngine/SphylElem.h  

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

 Finds the closest point on the shape given a world position. PhysicsEngine/SphylElem.h  

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

   PhysicsEngine/SphylElem.h  

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

   PhysicsEngine/SphylElem.h  

float GetScaledCylinderLength ( const FVector& Scale3D
) const

 Returns the scaled length of the cylinder part of the Sphyl PhysicsEngine/SphylElem.h  

float GetScaledHalfLength ( const FVector& Scale3D
) const

 Returns half of the total scaled length of the Sphyl, which includes the scaled top and bottom caps PhysicsEngine/SphylElem.h  

float GetScaledRadius ( const FVector& Scale3D
) const

 Returns the scaled radius for this Sphyl, which is determined by the Max scale on X/Y and clamped by half the total length PhysicsEngine/SphylElem.h  

FVector::FReal GetScaledVolume ( const FVector& Scale3D
) const

   PhysicsEngine/SphylElem.h  

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

 Finds the shortest distance between the element and a world position. PhysicsEngine/SphylElem.h  

FVector::FReal GetVolume ( const FVector& Scale
) const

   PhysicsEngine/SphylElem.h  

void ScaleElem ( FVector DeltaSize,
float MinSize
)

   PhysicsEngine/SphylElem.h  

void SetTransform ( const FTransform& InTransform
)

   PhysicsEngine/SphylElem.h  

Overridden from FKShapeElem

Name Remarks Include Path Unreal Specifiers

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

   PhysicsEngine/SphylElem.h  

virtual FTransform GetTransform()

 Utility function that builds an FTransform from the current data. PhysicsEngine/SphylElem.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
Orientation_DEPRECATED FQuat   PhysicsEngine/SphylElem.h  
TM_DEPRECATED FMatrix   PhysicsEngine/SphylElem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page