Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

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

Handles.CubeCap

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

Sumbission failed

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

Close

Cancel

public static function CubeCap(controlID: int, position: Vector3, rotation: Quaternion, size: float): void;
public static void CubeCap(int controlID, Vector3 position, Quaternion rotation, float size);

Parameters

controlID The control ID for the handle.
position The world-space position of the handle's start point.
rotation The rotation of the handle.
size The size of the handle in world-space units.

Description

Draw a cube. Pass this into handle functions.

Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles.


Cube Cap on the Scene View.

To use this example, save this script into the Assets/Editor folder:


        
using UnityEngine;
using UnityEditor;

[CustomEditor( typeof( DummyCubeCap ) )] public class CubeCapEditor : Editor { public float cubeSize = 1;

void OnSceneGUI( ) { DummyCubeCap t = target as DummyCubeCap;

Handles.color = Color.red; Handles.CubeCap( 0, t.transform.position + new Vector3( 5, 0, 0 ), t.transform.rotation, cubeSize );

Handles.color = Color.green; Handles.CubeCap( 0, t.transform.position + new Vector3( 0, 5, 0 ), t.transform.rotation, cubeSize );

Handles.color = Color.blue; Handles.CubeCap( 0, t.transform.position + new Vector3( 0, 0, 5 ), t.transform.rotation, cubeSize ); } }

... and attach this script to the object where you'd like to view CubeCaps in the editor:


        
using UnityEngine;

[ExecuteInEditMode] public class DummyCubeCap : MonoBehaviour { public void Start( ) { Debug.Log( "I have CubeCap Handles attached to this transform!" ); } }