Click or drag to resize

ILinkRendererStartRenderer Method

Starts rendering a link between the objects.

Namespace:  KASAPIv2
Assembly:  KAS-API-v2 (in KAS-API-v2.dll) Version: KAS API v2
Syntax
C#
void StartRenderer(
	Transform source,
	Transform target
)
Request Example View Source

Parameters

source
Type: UnityEngineTransform
The source node.
target
Type: UnityEngineTransform
The target node.
Remarks

This method only indicates that the link is to be drawn between the specified points. The renderer is allowed to draw meshes even when not started. E.g. if there are constant parts of the link like the joint pivots.

The ends of the link are not required to be located at the surface of the owning parts. It's up to the renderer to decide how to draw the link.

It's OK to call this method multiple times with different or the same source/target arguments: the renderer must accept the values and update accordingly. However, this operation is rated as performance expensive, so the callers are discouraged to invoke this method too frequently (e.g. on every frame update).

See Also