Legacy Documentation: Version 2017.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Handles.CapFunction

Other Versions
Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public delegate CapFunction(controlID: int, position: Vector3, rotation: Quaternion, size: float, eventType: EventType): void;
public delegate void CapFunction(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType);

Parameters

controlID The control ID for the handle.
position The position of the handle in the space of Handles.matrix.
rotation The rotation of the handle in the space of Handles.matrix.
size The size of the handle in world-space units.
eventType Event type for the handle to act upon. By design it handles EventType.Layout and EventType.Repaint events.

Description

The function to use for drawing the handle e.g. Handles.RectangleCap.

Custom CapFunction has two responsibilities:
1. For EventType.Layout event, call HandleUtility.AddControl to inform Unity about the distance of the handle from mouse position.
2. For EventType.Repaint event, render the actual handle.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2017 Unity Technologies. Publication: 2017.1-001R. Built: 2017-10-06.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information