Show / Hide Table of Contents

Class Handles

Inheritance
Object
Handles
Inherited Members
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: UnityEditor
Assembly: UnityEditor.dll
Syntax
public sealed class Handles

Properties

| Improve this Doc View Source

centerColor

Declaration
public static Color centerColor { get; }
Property Value
Type Description
Color

color

Declaration
public static Color color { get; set; }
Property Value
Type Description
Color
| Improve this Doc View Source

currentCamera

Declaration
public Camera currentCamera { get; set; }
Property Value
Type Description
Camera

inverseMatrix

Declaration
public static Matrix4x4 inverseMatrix { get; }
Property Value
Type Description
Matrix4x4

lighting

Declaration
public static bool lighting { get; set; }
Property Value
Type Description
Boolean

matrix

Declaration
public static Matrix4x4 matrix { get; set; }
Property Value
Type Description
Matrix4x4
| Improve this Doc View Source

preselectionColor

Declaration
public static Color preselectionColor { get; }
Property Value
Type Description
Color
| Improve this Doc View Source

secondaryColor

Declaration
public static Color secondaryColor { get; }
Property Value
Type Description
Color
| Improve this Doc View Source

selectedColor

Declaration
public static Color selectedColor { get; }
Property Value
Type Description
Color
| Improve this Doc View Source

xAxisColor

Declaration
public static Color xAxisColor { get; }
Property Value
Type Description
Color
| Improve this Doc View Source

yAxisColor

Declaration
public static Color yAxisColor { get; }
Property Value
Type Description
Color
| Improve this Doc View Source

zAxisColor

Declaration
public static Color zAxisColor { get; }
Property Value
Type Description
Color

zTest

Declaration
public static CompareFunction zTest { get; set; }
Property Value
Type Description
CompareFunction

Methods

| Improve this Doc View Source

ArrowCap(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("Use ArrowHandleCap instead")]
public static void ArrowCap(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

ArrowHandleCap(Int32, Vector3, Quaternion, Single, EventType)

Declaration
public static void ArrowHandleCap(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
EventType eventType
| Improve this Doc View Source

BeginGUI()

Declaration
public static void BeginGUI()
| Improve this Doc View Source

BeginGUI(Rect)

Declaration
[Obsolete("Please use BeginGUI() with GUILayout.BeginArea(position) / GUILayout.EndArea()")]
public static void BeginGUI(Rect position)
Parameters
Type Name Description
Rect position
| Improve this Doc View Source

Button(Vector3, Quaternion, Single, Single, Handles.CapFunction)

Declaration
public static bool Button(Vector3 position, Quaternion direction, float size, float pickSize, Handles.CapFunction capFunction)
Parameters
Type Name Description
Vector3 position
Quaternion direction
Single size
Single pickSize
Handles.CapFunction capFunction
Returns
Type Description
Boolean
| Improve this Doc View Source

Button(Vector3, Quaternion, Single, Single, Handles.DrawCapFunction)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static bool Button(Vector3 position, Quaternion direction, float size, float pickSize, Handles.DrawCapFunction capFunc)
Parameters
Type Name Description
Vector3 position
Quaternion direction
Single size
Single pickSize
Handles.DrawCapFunction capFunc
Returns
Type Description
Boolean
| Improve this Doc View Source

CircleCap(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("Use CircleHandleCap instead")]
public static void CircleCap(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

CircleHandleCap(Int32, Vector3, Quaternion, Single, EventType)

Declaration
public static void CircleHandleCap(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
EventType eventType
| Improve this Doc View Source

ClearCamera(Rect, Camera)

Declaration
public static void ClearCamera(Rect position, Camera camera)
Parameters
Type Name Description
Rect position
Camera camera
| Improve this Doc View Source

ConeCap(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("Use ConeHandleCap instead")]
public static void ConeCap(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

ConeHandleCap(Int32, Vector3, Quaternion, Single, EventType)

Declaration
public static void ConeHandleCap(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
EventType eventType
| Improve this Doc View Source

CubeCap(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("Use CubeHandleCap instead")]
public static void CubeCap(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

CubeHandleCap(Int32, Vector3, Quaternion, Single, EventType)

Declaration
public static void CubeHandleCap(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
EventType eventType
| Improve this Doc View Source

CylinderCap(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("Use CylinderHandleCap instead")]
public static void CylinderCap(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

CylinderHandleCap(Int32, Vector3, Quaternion, Single, EventType)

Declaration
public static void CylinderHandleCap(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
EventType eventType
| Improve this Doc View Source

Disc(Int32, Quaternion, Vector3, Vector3, Single, Boolean, Single)

Declaration
public static Quaternion Disc(int id, Quaternion rotation, Vector3 position, Vector3 axis, float size, bool cutoffPlane, float snap)
Parameters
Type Name Description
Int32 id
Quaternion rotation
Vector3 position
Vector3 axis
Single size
Boolean cutoffPlane
Single snap
Returns
Type Description
Quaternion
| Improve this Doc View Source

Disc(Quaternion, Vector3, Vector3, Single, Boolean, Single)

Declaration
public static Quaternion Disc(Quaternion rotation, Vector3 position, Vector3 axis, float size, bool cutoffPlane, float snap)
Parameters
Type Name Description
Quaternion rotation
Vector3 position
Vector3 axis
Single size
Boolean cutoffPlane
Single snap
Returns
Type Description
Quaternion
| Improve this Doc View Source

DoPositionHandle(Vector3, Quaternion)

Declaration
public static Vector3 DoPositionHandle(Vector3 position, Quaternion rotation)
Parameters
Type Name Description
Vector3 position
Quaternion rotation
Returns
Type Description
Vector3
| Improve this Doc View Source

DoRotationHandle(Quaternion, Vector3)

Declaration
public static Quaternion DoRotationHandle(Quaternion rotation, Vector3 position)
Parameters
Type Name Description
Quaternion rotation
Vector3 position
Returns
Type Description
Quaternion
| Improve this Doc View Source

DoScaleHandle(Vector3, Vector3, Quaternion, Single)

Declaration
public static Vector3 DoScaleHandle(Vector3 scale, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Vector3 scale
Vector3 position
Quaternion rotation
Single size
Returns
Type Description
Vector3
| Improve this Doc View Source

DotCap(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("Use DotHandleCap instead")]
public static void DotCap(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

DotHandleCap(Int32, Vector3, Quaternion, Single, EventType)

Declaration
public static void DotHandleCap(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
EventType eventType
| Improve this Doc View Source

DrawAAConvexPolygon(Vector3[])

Declaration
public static void DrawAAConvexPolygon(params Vector3[] points)
Parameters
Type Name Description
Vector3[] points
| Improve this Doc View Source

DrawAAPolyLine(Single, Int32, Vector3[])

Declaration
public static void DrawAAPolyLine(float width, int actualNumberOfPoints, params Vector3[] points)
Parameters
Type Name Description
Single width
Int32 actualNumberOfPoints
Vector3[] points
| Improve this Doc View Source

DrawAAPolyLine(Single, Vector3[])

Declaration
public static void DrawAAPolyLine(float width, params Vector3[] points)
Parameters
Type Name Description
Single width
Vector3[] points
| Improve this Doc View Source

DrawAAPolyLine(Texture2D, Single, Vector3[])

Declaration
public static void DrawAAPolyLine(Texture2D lineTex, float width, params Vector3[] points)
Parameters
Type Name Description
Texture2D lineTex
Single width
Vector3[] points
| Improve this Doc View Source

DrawAAPolyLine(Texture2D, Vector3[])

Declaration
public static void DrawAAPolyLine(Texture2D lineTex, params Vector3[] points)
Parameters
Type Name Description
Texture2D lineTex
Vector3[] points
| Improve this Doc View Source

DrawAAPolyLine(Vector3[])

Declaration
public static void DrawAAPolyLine(params Vector3[] points)
Parameters
Type Name Description
Vector3[] points
| Improve this Doc View Source

DrawArrow(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("DrawArrow has been renamed to ArrowCap.")]
public static void DrawArrow(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

DrawBezier(Vector3, Vector3, Vector3, Vector3, Color, Texture2D, Single)

Declaration
public static void DrawBezier(Vector3 startPosition, Vector3 endPosition, Vector3 startTangent, Vector3 endTangent, Color color, Texture2D texture, float width)
Parameters
Type Name Description
Vector3 startPosition
Vector3 endPosition
Vector3 startTangent
Vector3 endTangent
Color color
Texture2D texture
Single width
| Improve this Doc View Source

DrawCamera(Rect, Camera)

Declaration
public static void DrawCamera(Rect position, Camera camera)
Parameters
Type Name Description
Rect position
Camera camera
| Improve this Doc View Source

DrawCamera(Rect, Camera, DrawCameraMode)

Declaration
public static void DrawCamera(Rect position, Camera camera, [DefaultValue("UnityEditor.DrawCameraMode.Normal")] DrawCameraMode drawMode)
Parameters
Type Name Description
Rect position
Camera camera
DrawCameraMode drawMode
| Improve this Doc View Source

DrawCone(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("DrawCone has been renamed to ConeCap.")]
public static void DrawCone(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

DrawCube(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("DrawCube has been renamed to CubeCap.")]
public static void DrawCube(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

DrawCylinder(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("DrawCylinder has been renamed to CylinderCap.")]
public static void DrawCylinder(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

DrawDottedLine(Vector3, Vector3, Single)

Declaration
public static void DrawDottedLine(Vector3 p1, Vector3 p2, float screenSpaceSize)
Parameters
Type Name Description
Vector3 p1
Vector3 p2
Single screenSpaceSize
| Improve this Doc View Source

DrawDottedLines(Vector3[], Int32[], Single)

Declaration
public static void DrawDottedLines(Vector3[] points, int[] segmentIndices, float screenSpaceSize)
Parameters
Type Name Description
Vector3[] points
Int32[] segmentIndices
Single screenSpaceSize
| Improve this Doc View Source

DrawDottedLines(Vector3[], Single)

Declaration
public static void DrawDottedLines(Vector3[] lineSegments, float screenSpaceSize)
Parameters
Type Name Description
Vector3[] lineSegments
Single screenSpaceSize
| Improve this Doc View Source

DrawGizmos(Camera)

Declaration
public static void DrawGizmos(Camera camera)
Parameters
Type Name Description
Camera camera
| Improve this Doc View Source

DrawLine(Vector3, Vector3)

Declaration
public static void DrawLine(Vector3 p1, Vector3 p2)
Parameters
Type Name Description
Vector3 p1
Vector3 p2
| Improve this Doc View Source

DrawLines(Vector3[])

Declaration
public static void DrawLines(Vector3[] lineSegments)
Parameters
Type Name Description
Vector3[] lineSegments
| Improve this Doc View Source

DrawLines(Vector3[], Int32[])

Declaration
public static void DrawLines(Vector3[] points, int[] segmentIndices)
Parameters
Type Name Description
Vector3[] points
Int32[] segmentIndices
| Improve this Doc View Source

DrawPolyLine(Vector3[])

Declaration
public static void DrawPolyLine(params Vector3[] points)
Parameters
Type Name Description
Vector3[] points
| Improve this Doc View Source

DrawRectangle(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("DrawRectangle has been renamed to RectangleCap.")]
public static void DrawRectangle(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

DrawSelectionFrame(Int32, Vector3, Quaternion, Single, EventType)

Declaration
public static void DrawSelectionFrame(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
EventType eventType
| Improve this Doc View Source

DrawSolidArc(Vector3, Vector3, Vector3, Single, Single)

Declaration
public static void DrawSolidArc(Vector3 center, Vector3 normal, Vector3 from, float angle, float radius)
Parameters
Type Name Description
Vector3 center
Vector3 normal
Vector3 from
Single angle
Single radius
| Improve this Doc View Source

DrawSolidDisc(Vector3, Vector3, Single)

Declaration
public static void DrawSolidDisc(Vector3 center, Vector3 normal, float radius)
Parameters
Type Name Description
Vector3 center
Vector3 normal
Single radius
| Improve this Doc View Source

DrawSolidRectangleWithOutline(Rect, Color, Color)

Declaration
public static void DrawSolidRectangleWithOutline(Rect rectangle, Color faceColor, Color outlineColor)
Parameters
Type Name Description
Rect rectangle
Color faceColor
Color outlineColor
| Improve this Doc View Source

DrawSolidRectangleWithOutline(Vector3[], Color, Color)

Declaration
public static void DrawSolidRectangleWithOutline(Vector3[] verts, Color faceColor, Color outlineColor)
Parameters
Type Name Description
Vector3[] verts
Color faceColor
Color outlineColor
| Improve this Doc View Source

DrawSphere(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("DrawSphere has been renamed to SphereCap.")]
public static void DrawSphere(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

DrawWireArc(Vector3, Vector3, Vector3, Single, Single)

Declaration
public static void DrawWireArc(Vector3 center, Vector3 normal, Vector3 from, float angle, float radius)
Parameters
Type Name Description
Vector3 center
Vector3 normal
Vector3 from
Single angle
Single radius
| Improve this Doc View Source

DrawWireCube(Vector3, Vector3)

Declaration
public static void DrawWireCube(Vector3 center, Vector3 size)
Parameters
Type Name Description
Vector3 center
Vector3 size
| Improve this Doc View Source

DrawWireDisc(Vector3, Vector3, Single)

Declaration
public static void DrawWireDisc(Vector3 center, Vector3 normal, float radius)
Parameters
Type Name Description
Vector3 center
Vector3 normal
Single radius
| Improve this Doc View Source

EndGUI()

Declaration
public static void EndGUI()
| Improve this Doc View Source

FreeMoveHandle(Int32, Vector3, Quaternion, Single, Vector3, Handles.CapFunction)

Declaration
public static Vector3 FreeMoveHandle(int controlID, Vector3 position, Quaternion rotation, float size, Vector3 snap, Handles.CapFunction capFunction)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
Vector3 snap
Handles.CapFunction capFunction
Returns
Type Description
Vector3
| Improve this Doc View Source

FreeMoveHandle(Vector3, Quaternion, Single, Vector3, Handles.CapFunction)

Declaration
public static Vector3 FreeMoveHandle(Vector3 position, Quaternion rotation, float size, Vector3 snap, Handles.CapFunction capFunction)
Parameters
Type Name Description
Vector3 position
Quaternion rotation
Single size
Vector3 snap
Handles.CapFunction capFunction
Returns
Type Description
Vector3
| Improve this Doc View Source

FreeMoveHandle(Vector3, Quaternion, Single, Vector3, Handles.DrawCapFunction)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static Vector3 FreeMoveHandle(Vector3 position, Quaternion rotation, float size, Vector3 snap, Handles.DrawCapFunction capFunc)
Parameters
Type Name Description
Vector3 position
Quaternion rotation
Single size
Vector3 snap
Handles.DrawCapFunction capFunc
Returns
Type Description
Vector3
| Improve this Doc View Source

FreeRotateHandle(Int32, Quaternion, Vector3, Single)

Declaration
public static Quaternion FreeRotateHandle(int id, Quaternion rotation, Vector3 position, float size)
Parameters
Type Name Description
Int32 id
Quaternion rotation
Vector3 position
Single size
Returns
Type Description
Quaternion
| Improve this Doc View Source

FreeRotateHandle(Quaternion, Vector3, Single)

Declaration
public static Quaternion FreeRotateHandle(Quaternion rotation, Vector3 position, float size)
Parameters
Type Name Description
Quaternion rotation
Vector3 position
Single size
Returns
Type Description
Quaternion
| Improve this Doc View Source

GetMainGameViewSize()

Declaration
public static Vector2 GetMainGameViewSize()
Returns
Type Description
Vector2
| Improve this Doc View Source

Label(Vector3, String)

Declaration
public static void Label(Vector3 position, string text)
Parameters
Type Name Description
Vector3 position
String text
| Improve this Doc View Source

Label(Vector3, String, GUIStyle)

Declaration
public static void Label(Vector3 position, string text, GUIStyle style)
Parameters
Type Name Description
Vector3 position
String text
GUIStyle style
| Improve this Doc View Source

Label(Vector3, GUIContent)

Declaration
public static void Label(Vector3 position, GUIContent content)
Parameters
Type Name Description
Vector3 position
GUIContent content
| Improve this Doc View Source

Label(Vector3, GUIContent, GUIStyle)

Declaration
public static void Label(Vector3 position, GUIContent content, GUIStyle style)
Parameters
Type Name Description
Vector3 position
GUIContent content
GUIStyle style
| Improve this Doc View Source

Label(Vector3, Texture)

Declaration
public static void Label(Vector3 position, Texture image)
Parameters
Type Name Description
Vector3 position
Texture image
| Improve this Doc View Source

MakeBezierPoints(Vector3, Vector3, Vector3, Vector3, Int32)

Declaration
public static Vector3[] MakeBezierPoints(Vector3 startPosition, Vector3 endPosition, Vector3 startTangent, Vector3 endTangent, int division)
Parameters
Type Name Description
Vector3 startPosition
Vector3 endPosition
Vector3 startTangent
Vector3 endTangent
Int32 division
Returns
Type Description
Vector3[]
| Improve this Doc View Source

PositionHandle(Vector3, Quaternion)

Declaration
public static Vector3 PositionHandle(Vector3 position, Quaternion rotation)
Parameters
Type Name Description
Vector3 position
Quaternion rotation
Returns
Type Description
Vector3
| Improve this Doc View Source

RadiusHandle(Quaternion, Vector3, Single)

Declaration
public static float RadiusHandle(Quaternion rotation, Vector3 position, float radius)
Parameters
Type Name Description
Quaternion rotation
Vector3 position
Single radius
Returns
Type Description
Single
| Improve this Doc View Source

RadiusHandle(Quaternion, Vector3, Single, Boolean)

Declaration
public static float RadiusHandle(Quaternion rotation, Vector3 position, float radius, bool handlesOnly)
Parameters
Type Name Description
Quaternion rotation
Vector3 position
Single radius
Boolean handlesOnly
Returns
Type Description
Single
| Improve this Doc View Source

RectangleCap(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("Use RectangleHandleCap instead")]
public static void RectangleCap(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

RectangleHandleCap(Int32, Vector3, Quaternion, Single, EventType)

Declaration
public static void RectangleHandleCap(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
EventType eventType
| Improve this Doc View Source

RotationHandle(Quaternion, Vector3)

Declaration
public static Quaternion RotationHandle(Quaternion rotation, Vector3 position)
Parameters
Type Name Description
Quaternion rotation
Vector3 position
Returns
Type Description
Quaternion
| Improve this Doc View Source

ScaleHandle(Vector3, Vector3, Quaternion, Single)

Declaration
public static Vector3 ScaleHandle(Vector3 scale, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Vector3 scale
Vector3 position
Quaternion rotation
Single size
Returns
Type Description
Vector3
| Improve this Doc View Source

ScaleSlider(Single, Vector3, Vector3, Quaternion, Single, Single)

Declaration
public static float ScaleSlider(float scale, Vector3 position, Vector3 direction, Quaternion rotation, float size, float snap)
Parameters
Type Name Description
Single scale
Vector3 position
Vector3 direction
Quaternion rotation
Single size
Single snap
Returns
Type Description
Single
| Improve this Doc View Source

ScaleValueHandle(Int32, Single, Vector3, Quaternion, Single, Handles.CapFunction, Single)

Declaration
public static float ScaleValueHandle(int controlID, float value, Vector3 position, Quaternion rotation, float size, Handles.CapFunction capFunction, float snap)
Parameters
Type Name Description
Int32 controlID
Single value
Vector3 position
Quaternion rotation
Single size
Handles.CapFunction capFunction
Single snap
Returns
Type Description
Single
| Improve this Doc View Source

ScaleValueHandle(Single, Vector3, Quaternion, Single, Handles.CapFunction, Single)

Declaration
public static float ScaleValueHandle(float value, Vector3 position, Quaternion rotation, float size, Handles.CapFunction capFunction, float snap)
Parameters
Type Name Description
Single value
Vector3 position
Quaternion rotation
Single size
Handles.CapFunction capFunction
Single snap
Returns
Type Description
Single
| Improve this Doc View Source

ScaleValueHandle(Single, Vector3, Quaternion, Single, Handles.DrawCapFunction, Single)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static float ScaleValueHandle(float value, Vector3 position, Quaternion rotation, float size, Handles.DrawCapFunction capFunc, float snap)
Parameters
Type Name Description
Single value
Vector3 position
Quaternion rotation
Single size
Handles.DrawCapFunction capFunc
Single snap
Returns
Type Description
Single
| Improve this Doc View Source

SelectionFrame(Int32, Vector3, Quaternion, Single)

Declaration
public static void SelectionFrame(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

SetCamera(Camera)

Declaration
public static void SetCamera(Camera camera)
Parameters
Type Name Description
Camera camera
| Improve this Doc View Source

SetCamera(Rect, Camera)

Declaration
public static void SetCamera(Rect position, Camera camera)
Parameters
Type Name Description
Rect position
Camera camera
| Improve this Doc View Source

Slider(Int32, Vector3, Vector3, Single, Handles.CapFunction, Single)

Declaration
public static Vector3 Slider(int controlID, Vector3 position, Vector3 direction, float size, Handles.CapFunction capFunction, float snap)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Vector3 direction
Single size
Handles.CapFunction capFunction
Single snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider(Int32, Vector3, Vector3, Vector3, Single, Handles.CapFunction, Single)

Declaration
public static Vector3 Slider(int controlID, Vector3 position, Vector3 offset, Vector3 direction, float size, Handles.CapFunction capFunction, float snap)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Vector3 offset
Vector3 direction
Single size
Handles.CapFunction capFunction
Single snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider(Vector3, Vector3)

Declaration
public static Vector3 Slider(Vector3 position, Vector3 direction)
Parameters
Type Name Description
Vector3 position
Vector3 direction
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider(Vector3, Vector3, Single, Handles.CapFunction, Single)

Declaration
public static Vector3 Slider(Vector3 position, Vector3 direction, float size, Handles.CapFunction capFunction, float snap)
Parameters
Type Name Description
Vector3 position
Vector3 direction
Single size
Handles.CapFunction capFunction
Single snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider(Vector3, Vector3, Single, Handles.DrawCapFunction, Single)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static Vector3 Slider(Vector3 position, Vector3 direction, float size, Handles.DrawCapFunction drawFunc, float snap)
Parameters
Type Name Description
Vector3 position
Vector3 direction
Single size
Handles.DrawCapFunction drawFunc
Single snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Int32, Vector3, Vector3, Vector3, Vector3, Single, Handles.CapFunction, Vector2)

Declaration
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap)
Parameters
Type Name Description
Int32 id
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.CapFunction capFunction
Vector2 snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Int32, Vector3, Vector3, Vector3, Vector3, Single, Handles.CapFunction, Vector2, Boolean)

Declaration
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap, [DefaultValue("false")] bool drawHelper)
Parameters
Type Name Description
Int32 id
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.CapFunction capFunction
Vector2 snap
Boolean drawHelper
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Int32, Vector3, Vector3, Vector3, Vector3, Single, Handles.DrawCapFunction, Vector2)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.DrawCapFunction drawFunc, Vector2 snap)
Parameters
Type Name Description
Int32 id
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.DrawCapFunction drawFunc
Vector2 snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Int32, Vector3, Vector3, Vector3, Vector3, Single, Handles.DrawCapFunction, Vector2, Boolean)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.DrawCapFunction drawFunc, Vector2 snap, [DefaultValue("false")] bool drawHelper)
Parameters
Type Name Description
Int32 id
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.DrawCapFunction drawFunc
Vector2 snap
Boolean drawHelper
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Int32, Vector3, Vector3, Vector3, Vector3, Vector3, Single, Handles.CapFunction, Vector2)

Declaration
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 offset, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap)
Parameters
Type Name Description
Int32 id
Vector3 handlePos
Vector3 offset
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.CapFunction capFunction
Vector2 snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Int32, Vector3, Vector3, Vector3, Vector3, Vector3, Single, Handles.CapFunction, Vector2, Boolean)

Declaration
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 offset, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap, [DefaultValue("false")] bool drawHelper)
Parameters
Type Name Description
Int32 id
Vector3 handlePos
Vector3 offset
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.CapFunction capFunction
Vector2 snap
Boolean drawHelper
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Int32, Vector3, Vector3, Vector3, Vector3, Vector3, Single, Handles.DrawCapFunction, Vector2)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 offset, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.DrawCapFunction drawFunc, Vector2 snap)
Parameters
Type Name Description
Int32 id
Vector3 handlePos
Vector3 offset
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.DrawCapFunction drawFunc
Vector2 snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Int32, Vector3, Vector3, Vector3, Vector3, Vector3, Single, Handles.DrawCapFunction, Vector2, Boolean)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 offset, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.DrawCapFunction drawFunc, Vector2 snap, [DefaultValue("false")] bool drawHelper)
Parameters
Type Name Description
Int32 id
Vector3 handlePos
Vector3 offset
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.DrawCapFunction drawFunc
Vector2 snap
Boolean drawHelper
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Vector3, Vector3, Vector3, Vector3, Single, Handles.CapFunction, Single)

Declaration
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, float snap)
Parameters
Type Name Description
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.CapFunction capFunction
Single snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Vector3, Vector3, Vector3, Vector3, Single, Handles.CapFunction, Single, Boolean)

Declaration
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, float snap, [DefaultValue("false")] bool drawHelper)
Parameters
Type Name Description
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.CapFunction capFunction
Single snap
Boolean drawHelper
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Vector3, Vector3, Vector3, Vector3, Single, Handles.CapFunction, Vector2)

Declaration
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap)
Parameters
Type Name Description
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.CapFunction capFunction
Vector2 snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Vector3, Vector3, Vector3, Vector3, Single, Handles.CapFunction, Vector2, Boolean)

Declaration
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap, [DefaultValue("false")] bool drawHelper)
Parameters
Type Name Description
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.CapFunction capFunction
Vector2 snap
Boolean drawHelper
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Vector3, Vector3, Vector3, Vector3, Single, Handles.DrawCapFunction, Single)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.DrawCapFunction drawFunc, float snap)
Parameters
Type Name Description
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.DrawCapFunction drawFunc
Single snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Vector3, Vector3, Vector3, Vector3, Single, Handles.DrawCapFunction, Single, Boolean)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.DrawCapFunction drawFunc, float snap, [DefaultValue("false")] bool drawHelper)
Parameters
Type Name Description
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.DrawCapFunction drawFunc
Single snap
Boolean drawHelper
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Vector3, Vector3, Vector3, Vector3, Single, Handles.DrawCapFunction, Vector2)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.DrawCapFunction drawFunc, Vector2 snap)
Parameters
Type Name Description
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.DrawCapFunction drawFunc
Vector2 snap
Returns
Type Description
Vector3
| Improve this Doc View Source

Slider2D(Vector3, Vector3, Vector3, Vector3, Single, Handles.DrawCapFunction, Vector2, Boolean)

Declaration
[Obsolete("DrawCapFunction is obsolete. Use the version with CapFunction instead. Example: Change SphereCap to SphereHandleCap.")]
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.DrawCapFunction drawFunc, Vector2 snap, [DefaultValue("false")] bool drawHelper)
Parameters
Type Name Description
Vector3 handlePos
Vector3 handleDir
Vector3 slideDir1
Vector3 slideDir2
Single handleSize
Handles.DrawCapFunction drawFunc
Vector2 snap
Boolean drawHelper
Returns
Type Description
Vector3
| Improve this Doc View Source

SnapValue(Single, Single)

Declaration
public static float SnapValue(float val, float snap)
Parameters
Type Name Description
Single val
Single snap
Returns
Type Description
Single
| Improve this Doc View Source

SphereCap(Int32, Vector3, Quaternion, Single)

Declaration
[Obsolete("Use SphereHandleCap instead")]
public static void SphereCap(int controlID, Vector3 position, Quaternion rotation, float size)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
| Improve this Doc View Source

SphereHandleCap(Int32, Vector3, Quaternion, Single, EventType)

Declaration
public static void SphereHandleCap(int controlID, Vector3 position, Quaternion rotation, float size, EventType eventType)
Parameters
Type Name Description
Int32 controlID
Vector3 position
Quaternion rotation
Single size
EventType eventType

Extension Methods

MustExtensions.MustBeEqual<T>(T, T)
MustExtensions.MustBeEqual<T>(T, T, String)
MustExtensions.MustNotBeEqual<T>(T, T)
MustExtensions.MustNotBeEqual<T>(T, T, String)
MustExtensions.MustBeNull<T>(T)
MustExtensions.MustBeNull<T>(T, String)
MustExtensions.MustNotBeNull<T>(T)
MustExtensions.MustNotBeNull<T>(T, String)
  • Improve this Doc
  • View Source
Back to top Generated by DocFX