1. Epic GamesDeveloper
  3. UCableComponent

UCableComponent

Component that allows you to specify custom triangle mesh geometry

API > API/Plugins > API/Plugins/CableComponent

Component that allows you to specify custom triangle mesh geometry

   
Name UCableComponent
Type class
Header File /Engine/Plugins/Runtime/CableComponent/Source/CableComponent/Classes/CableComponent.h
Include Path #include "CableComponent.h"

Syntax

UCLASS (MinimalAPI, HideCategories=(Object, Physics, Activation, "Components|Activation"),  
       EditInlineNew, Meta=(BlueprintSpawnableComponent), ClassGroup=Rendering)  
class UCableComponent : public UMeshComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UCableComponent ( const FObjectInitializer& ObjectInitializer
)

   CableComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AttachEndTo FComponentReference Actor or Component that the defines the end position of the cable CableComponent.h
  • EditAnywhere
  • Category="Cable"
AttachEndToSocketName FName Socket name on the AttachEndTo component to attach to CableComponent.h
  • EditAnywhere
  • Category="Cable"
bAttachEnd bool Should we fix the end to something (using AttachEndTo and EndLocation), or leave it free. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Cable"
bAttachStart bool Should we fix the start to something, or leave it free. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Cable"
bEnableCollision bool EXPERIMENTAL. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Cable"
bEnableStiffness bool Add stiffness constraints to cable. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Cable"
bResetAfterTeleport bool Always reset cable particle positions and velocities on a teleport. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Teleport"
bSkipCableUpdateWhenNotOwnerRecentlyRendered bool   CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Cable"
bSkipCableUpdateWhenNotVisible bool   CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Cable"
bTeleportAfterReattach bool Teleport the cable particles on reattaching any end of the cable. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Teleport"
bUseSubstepping bool When false, will still wait for SubstepTime to elapse before updating, but will only run the cable simulation once using all of accumulated simulation time CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Cable"
CableForce FVector Force vector (world space) applied to all particles in cable. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Cable Forces"
CableGravityScale float Scaling applied to world gravity affecting this cable. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Cable Forces"
CableLength float Rest length of the cable CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Cable"
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1000.0")
CableWidth float How wide the cable geometry is CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Cable Rendering"
  • Meta=(ClampMin="0.01", UIMin="0.01", UIMax="50.0")
CollisionFriction float If collision is enabled, control how much sliding friction is applied when cable is in contact. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Cable"
  • Meta=(ClampMin="0.0", ClampMax="1.0", EditCondition="bEnableCollision")
EndLocation FVector End location of cable, relative to AttachEndTo (or AttachEndToSocketName) if specified, otherwise relative to cable component. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Cable"
  • Meta=(MakeEditWidget=true)
NumSegments int32 How many segments the cable has CableComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cable"
  • Meta=(ClampMin="1", UIMin="1", UIMax="20")
NumSides int32 Number of sides of the cable geometry CableComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Cable Rendering"
  • Meta=(ClampMin="1", ClampMax="16")
SolverIterations int32 The number of solver iterations controls how 'stiff' the cable is CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Cable"
  • Meta=(ClampMin="1", ClampMax="16")
SubstepTime float Controls the simulation substep time for the cable CableComponent.h
  • EditAnywhere
  • AdvancedDisplay
  • BlueprintReadOnly
  • Category="Cable"
  • Meta=(ClampMin="0.005", UIMin="0.005", UIMax="0.1")
TeleportDistanceThreshold float Conduct teleportation if the movement of either fixed end point of the cable is greater than this threshold in 1 frame. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Teleport"
  • Meta=(UIMin="0")
TeleportRotationThreshold float Rotation threshold in degrees. CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Teleport"
  • Meta=(UIMin="0")
TileMaterial float How many times to repeat the material along the length of the cable CableComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Cable Rendering"
  • Meta=(UIMin="0.1", UIMax="8")

Protected

Name Type Remarks Include Path Unreal Specifiers
bLastEndAttached bool   CableComponent.h  
bLastStartAttached bool   CableComponent.h  
LastEndLocation FVector   CableComponent.h  
LastEndPoint FVector   CableComponent.h  
LastEndPointTransform FTransform   CableComponent.h  
LastStartPoint FVector   CableComponent.h  
LastTransform FTransform Previous cable state for teleport corrections CableComponent.h  
Particles TArray< FCableParticle > Array of cable particles CableComponent.h  
TimeRemainder float Amount of time 'left over' from last tick CableComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

AActor * GetAttachedActor()

 Gets the Actor that the cable is attached to CableComponent.h
  • BlueprintCallable
  • Category="Cable"

USceneComponent * GetAttachedComponent()

 Gets the specific USceneComponent that the cable is attached to CableComponent.h
  • BlueprintCallable
  • Category="Cable"

void GetCableParticleLocations ( TArray< FVector >& Locations
) const

 Get array of locations of particles (in world space) making up the cable simulation. CableComponent.h
  • BlueprintCallable
  • Category="Cable"

void SetAttachEndTo ( AActor* Actor,
FName ComponentProperty,
FName SocketName
)

 Attaches the end of the cable to a specific Component within an Actor CableComponent.h
  • BlueprintCallable
  • Category="Cable"

void SetAttachEndToComponent ( USceneComponent* Component,
FName SocketName
)

 Attaches the end of the cable to a specific Component CableComponent.h
  • BlueprintCallable
  • Category="Cable"

Overridden from UPrimitiveComponent

Name Remarks Include Path Unreal Specifiers

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   CableComponent.h  

virtual int32 GetNumMaterials()

   CableComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

   CableComponent.h  

virtual bool DoesSocketExist ( FName InSocketName
) const

   CableComponent.h  

virtual FTransform GetSocketTransform ( FName InSocketName,
ERelativeTransformSpace TransformSpace
) const

   CableComponent.h  

virtual bool HasAnySockets()

   CableComponent.h  

virtual void OnVisibilityChanged()

   CableComponent.h  

virtual void QuerySupportedSockets ( TArray< FComponentSocketDescription >& OutSockets
) const

   CableComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

   CableComponent.h  

virtual void CreateRenderState_Concurrent ( FRegisterComponentContext* Context
)

   CableComponent.h  

virtual void OnRegister()

   CableComponent.h  

virtual void SendRenderDynamicData_Concurrent()

   CableComponent.h  

virtual void TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

   CableComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page