ILinkRenderer Interface

Interface for a module that takes care of rendering a link and, optionally, manages its colliders.

Namespace: KASAPIv2
Assembly: KAS-API-v2 (in KAS-API-v2.dll) Version: KAS API v2

Syntax

public interface ILinkRenderer

Request Example View Source

The ILinkRenderer type exposes the following members.

Properties

	Name	Description
	cfgRendererName	Unique name of the renderer that is used by the other modules to find this renderer.
	colorOverride	Temporally sets another color to the link meshes.
	isPhysicalCollider	Tells if the link colliders should be active.
	isStarted	Tells if the renderer is started and active.
	shaderNameOverride	Temporally sets another shader to the link meshes.
	sourceTransform	Base position/direction of the connection point at the beginning of the link. The source joint models will be aligned against this transform.
	targetTransform	Base position/direction of the connection point at the end of the link. The target joint models will be aligned against this transform.

Top

Methods

	Name	Description
	CheckColliderHits	Verifies that there are no obstacles between the points.
	GetMeshByName	Returns a mesh, created by the renderer.
	StartRenderer	Starts rendering a link between the objects.
	StopRenderer	Cancels rendering the link.
	UpdateLink	Called when a link representation update is required.

Top

Remarks

The link can be rendered between any two transformations. The renderer is responsible to adjust the representation if the connecting points have moved (UpdateLink).

Reference

KASAPIv2 Namespace