Class CapsuleComponent

A capsule generally used for simple collision. Bounds are rendered as lines in the editor.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
PrimitiveComponent
ShapeComponent
CapsuleComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class CapsuleComponent : ShapeComponent

Properties

| Improve this Doc View Source

CapsuleHalfHeight

Half-height, from center of capsule to the end of top or bottom hemisphere.

Declaration
public float CapsuleHalfHeight { get; }
Property Value
Type Description
System.Single
Remarks

This cannot be less than CapsuleRadius.

| Improve this Doc View Source

CapsuleRadius

Radius of cap hemispheres and center cylinder.

Declaration
public float CapsuleRadius { get; }
Property Value
Type Description
System.Single
Remarks

This cannot be more than CapsuleHalfHeight.

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static CapsuleComponent DefaultObject { get; }
Property Value
Type Description
CapsuleComponent
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

GetScaledCapsuleHalfHeight()

Returns the capsule half-height scaled by the component scale.

Declaration
public float GetScaledCapsuleHalfHeight()
Returns
Type Description
System.Single
Remarks

This includes both the cylinder and hemisphere cap. @return The capsule half-height scaled by the component scale.

| Improve this Doc View Source

GetScaledCapsuleHalfHeight_WithoutHemisphere()

Returns the capsule half-height minus radius (to exclude the hemisphere), scaled by the component scale.

Declaration
public float GetScaledCapsuleHalfHeight_WithoutHemisphere()
Returns
Type Description
System.Single
Remarks

From the center of the capsule this is the vertical distance along the straight cylindrical portion to the point just before the curve of top hemisphere begins. @return The capsule half-height minus radius, scaled by the component scale.

| Improve this Doc View Source

GetScaledCapsuleRadius()

Returns the capsule radius scaled by the component scale.

Declaration
public float GetScaledCapsuleRadius()
Returns
Type Description
System.Single
Remarks

@return The capsule radius scaled by the component scale.

| Improve this Doc View Source

GetScaledCapsuleSize()

Returns the capsule radius and half-height scaled by the component scale.

Declaration
public (float, float) GetScaledCapsuleSize()
Returns
Type Description
System.ValueTuple<System.Single, System.Single>
Remarks

Half-height includes the hemisphere end cap. @param OutRadius Radius of the capsule, scaled by the component scale. @param OutHalfHeight Half-height of the capsule, scaled by the component scale. Includes the hemisphere end cap. @return The capsule radius and half-height scaled by the component scale.

| Improve this Doc View Source

GetScaledCapsuleSize_WithoutHemisphere()

Returns the capsule radius and half-height scaled by the component scale.

Declaration
public (float, float) GetScaledCapsuleSize_WithoutHemisphere()
Returns
Type Description
System.ValueTuple<System.Single, System.Single>
Remarks

Half-height excludes the hemisphere end cap. @param OutRadius Radius of the capsule, ignoring component scaling. @param OutHalfHeightWithoutHemisphere Half-height of the capsule, scaled by the component scale. Excludes the hemisphere end cap. @return The capsule radius and half-height scaled by the component scale.

| Improve this Doc View Source

GetShapeScale()

Get the scale used by this shape.

Declaration
public float GetShapeScale()
Returns
Type Description
System.Single
Remarks

This is a uniform scale that is the minimum of any non-uniform scaling. @return the scale used by this shape.

| Improve this Doc View Source

GetUnscaledCapsuleHalfHeight()

Returns the capsule half-height, ignoring component scaling.

Declaration
public float GetUnscaledCapsuleHalfHeight()
Returns
Type Description
System.Single
Remarks

This includes the hemisphere end cap. @return The capsule radius, ignoring component scaling.

| Improve this Doc View Source

GetUnscaledCapsuleHalfHeight_WithoutHemisphere()

Returns the capsule half-height minus radius (to exclude the hemisphere), ignoring component scaling.

Declaration
public float GetUnscaledCapsuleHalfHeight_WithoutHemisphere()
Returns
Type Description
System.Single
Remarks

This excludes the hemisphere end cap. From the center of the capsule this is the vertical distance along the straight cylindrical portion to the point just before the curve of top hemisphere begins. @return The capsule half-height minus radius, ignoring component scaling.

| Improve this Doc View Source

GetUnscaledCapsuleRadius()

Returns the capsule radius, ignoring component scaling.

Declaration
public float GetUnscaledCapsuleRadius()
Returns
Type Description
System.Single
Remarks

@return the capsule radius, ignoring component scaling.

| Improve this Doc View Source

GetUnscaledCapsuleSize()

Returns the capsule radius and half-height scaled by the component scale.

Declaration
public (float, float) GetUnscaledCapsuleSize()
Returns
Type Description
System.ValueTuple<System.Single, System.Single>
Remarks

Half-height includes the hemisphere end cap. @param OutRadius Radius of the capsule, scaled by the component scale. @param OutHalfHeight Half-height of the capsule, scaled by the component scale. Includes the hemisphere end cap. @return The capsule radius and half-height scaled by the component scale.

| Improve this Doc View Source

GetUnscaledCapsuleSize_WithoutHemisphere()

Returns the capsule radius and half-height, ignoring component scaling.

Declaration
public (float, float) GetUnscaledCapsuleSize_WithoutHemisphere()
Returns
Type Description
System.ValueTuple<System.Single, System.Single>
Remarks

Half-height excludes the hemisphere end cap. @param OutRadius Radius of the capsule, ignoring component scaling. @param OutHalfHeightWithoutHemisphere Half-height of the capsule, scaled by the component scale. Excludes the hemisphere end cap. @return The capsule radius and half-height (excluding hemisphere end cap), ignoring component scaling.

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static CapsuleComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
CapsuleComponent
| Improve this Doc View Source

SetCapsuleHalfHeight(Single, Boolean)

Set the capsule half-height.

Declaration
public void SetCapsuleHalfHeight(float HalfHeight, bool bUpdateOverlaps)
Parameters
Type Name Description
System.Single HalfHeight
System.Boolean bUpdateOverlaps
Remarks

This is the unscaled half-height, before component scale is applied. If this capsule collides, updates touching array for owner actor. @param HalfHeight : half-height, from capsule center to end of top or bottom hemisphere. @param bUpdateOverlaps: if true and this shape is registered and collides, updates touching array for owner actor.

| Improve this Doc View Source

SetCapsuleRadius(Single, Boolean)

Set the capsule radius.

Declaration
public void SetCapsuleRadius(float Radius, bool bUpdateOverlaps)
Parameters
Type Name Description
System.Single Radius
System.Boolean bUpdateOverlaps
Remarks

This is the unscaled radius, before component scale is applied. If this capsule collides, updates touching array for owner actor. @param Radius : radius of end-cap hemispheres and center cylinder. @param bUpdateOverlaps: if true and this shape is registered and collides, updates touching array for owner actor.

| Improve this Doc View Source

SetCapsuleSize(Single, Single, Boolean)

Change the capsule size.

Declaration
public void SetCapsuleSize(float InRadius, float InHalfHeight, bool bUpdateOverlaps)
Parameters
Type Name Description
System.Single InRadius
System.Single InHalfHeight
System.Boolean bUpdateOverlaps
Remarks

This is the unscaled size, before component scale is applied. @param InRadius : radius of end-cap hemispheres and center cylinder. @param InHalfHeight : half-height, from capsule center to end of top or bottom hemisphere. @param bUpdateOverlaps: if true and this shape is registered and collides, updates touching array for owner actor.

Operators

| Improve this Doc View Source

Implicit(IntPtr to CapsuleComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator CapsuleComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
CapsuleComponent