Click or drag to resize

ILinkCableJoint Interface

Interface for a physical cable link. Such links keep the distance between the object below the maximum, but don't restrict any other movements of the objects relative to each other.

Namespace:  KASAPIv2
Assembly:  KAS-API-v2 (in KAS-API-v2.dll) Version: KAS API v2
Syntax
C#
Copy
public interface ILinkCableJoint : ILinkJoint
Request Example View Source

The ILinkCableJoint type exposes the following members.

Properties
  NameDescription
Public propertycfgMaxCableLength
Maximum allowed distance between the parts to establish a link.
Public propertydeployedCableLength
Maximum possible distance between the source and head/target physical anchors.
Public propertyheadRb
Rigidbody of the physical cable head.
Public propertyisLockedWhenCoupled
Tells if the joint turns rigid when the parts are coupled.
Public propertyrealCableLength
Returns the actual distance between the source and target/head physical anchors.
Top
Methods
  NameDescription
Public methodSetCableLength
Sets the maximum possible distance between the source and the head/target physical anchors.
Public methodSetLockedOnCouple
Defines if the joint should be fixed when the parts are coupled.
Public methodStartPhysicalHead
Attaches the source to the specified physical object (a connector head).
Public methodStopPhysicalHead
Stops handling the physical head.
Top
Remarks

The specifics of this module is that the distance between the linked parts becomes variable. Once the link is created, the distance limit is set to the actual distance between the source and target. This limit won't allow the objects to separate too far from each other, but the objects will be allowed to come closer. The code can adjust the limit once the joint is created.

Due to the specifics of handling this kind of joints in PhysX, the real distance between the objects can become greater than the distance limit. In fact, if there are forces that try to separate the objects, then the actual distance will always be a bit more than the limit. Do not expect this difference to have any meaning, it depends on the PhysX engine and can be anything.

See Also