Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > CableComponent > UCableComponent

Light Theme

Dark Theme

UCableComponent

Component that allows you to specify custom triangle mesh geometry

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UMeshComponent

UCableComponent

References

Module	CableComponent
Header	/Engine/Plugins/Runtime/CableComponent/Source/CableComponent/Classes/CableComponent.h
Include	#include "CableComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Object, Physics, Activation, "Components|Activation"), EditInlineNew,
Meta=(BlueprintSpawnableComponent), ClassGroup=Rendering)
class UCableComponent : public UMeshComponent

Remarks

Component that allows you to specify custom triangle mesh geometry

Variables

	Name	Description
FComponentRefer...	AttachEndTo	Actor or Component that the defines the end position of the cable
FName	AttachEndToSocketName	Socket name on the AttachEndTo component to attach to
bool	bAttachEnd	Should we fix the end to something (using AttachEndTo and EndLocation), or leave it free.
bool	bAttachStart	Should we fix the start to something, or leave it free.
bool	bEnableCollision	EXPERIMENTAL.
bool	bEnableStiffness	Add stiffness constraints to cable.
FVector	CableForce	Force vector (world space) applied to all particles in cable.
float	CableGravityScale	Scaling applied to world gravity affecting this cable.
float	CableLength	Rest length of the cable
float	CableWidth	How wide the cable geometry is
float	CollisionFriction	If collision is enabled, control how much sliding friction is applied when cable is in contact.
FVector	EndLocation	End location of cable, relative to AttachEndTo (or AttachEndToSocketName) if specified, otherwise relative to cable component.
int32	NumSegments	How many segments the cable has
int32	NumSides	Number of sides of the cable geometry
int32	SolverIterations	The number of solver iterations controls how 'stiff' the cable is
float	SubstepTime	Controls the simulation substep time for the cable
float	TileMaterial	How many times to repeat the material along the length of the cable

Constructors

	Name	Description
	UCableComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
AActor *	GetAttachedActor()	Gets the Actor that the cable is attached to
USceneCompon...	GetAttachedComponent()	Gets the specific USceneComponent that the cable is attached to
void	GetCableParticleLocations ( TArray< FVector >& Locations )	Get array of locations of particles (in world space) making up the cable simulation.
void	SetAttachEndTo ( AActor* Actor, FName ComponentProperty, FName SocketName )	Attaches the end of the cable to a specific Component within an Actor
void	SetAttachEndToComponent ( USceneComponent* Component, FName SocketName )	Attaches the end of the cable to a specific Component

Overridden from UPrimitiveComponent

		Name	Description
	FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
	int32	GetNumMaterials()	Return number of material elements in this primitive

Overridden from USceneComponent

	Name	Description
FBoxSphereBo...	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
bool	DoesSocketExist ( FName InSocketName )	Return true if socket with the given name exists
FTransform	GetSocketTransform ( FName InSocketName, ERelativeTransformSpace TransformSp... )	Get world-space socket transform.
bool	HasAnySockets()	Returns true if this component has any sockets
void	QuerySupportedSockets ( TArray< FComponentSocketDescription... )	Get a list of sockets this component contains

Overridden from UActorComponent

	Name	Description
void	ApplyWorldOffset ( const FVector& InOffset, bool bWorldShift )	Called by owner actor on position shifting Component should update all relevant data structures to reflect new actor location
void	CreateRenderState_Concurrent ( FRegisterComponentContext* Con... )	Used to create any rendering thread information for this component
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	SendRenderDynamicData_Concurrent()	Called to send dynamic data for this component to the rendering thread
void	TickComponent ( float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction* T... )	Function called every frame on this ActorComponent.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss