Click or drag to resize

ILinkJointCreateJoint Method

Sets up a physical joint between the source and target.

Namespace:  KASAPIv2
Assembly:  KAS-API-v2 (in KAS-API-v2.dll) Version: KAS API v2
Syntax
C#
bool CreateJoint(
	ILinkSource source,
	ILinkTarget target
)
Request Example View Source

Parameters

source
Type: KASAPIv2ILinkSource
The link's source. This part owns the joint module.
target
Type: KASAPIv2ILinkTarget
The link's target.

Return Value

Type: Boolean
true if joint was successfully created or updated.
Remarks

This method can be called either to establish a new joint or to restore an existing link on load.

This method will call the CheckConstraints(ILinkSource, ILinkTarget) method to ensure there are no errors. If there are some, then the link is not created and the errors are reported to the logs.

See Also