Legacy Documentation: Version 5.3
LanguageEnglish
  • C#
  • JS

Script language

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

DrawGizmo.DrawGizmo

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 DrawGizmo(gizmo: GizmoType)
public DrawGizmo(GizmoType gizmo);

Parameters

gizmo Flags to denote when the gizmo should be drawn.

Description

Defines when the gizmo should be invoked for drawing.

See Also: GizmoType.

	/// The RenderLightGizmo function will be called if the light is not selected.
	/// The gizmo is drawn when picking.

@DrawGizmo (GizmoType.NotSelected | GizmoType.Pickable) static function RenderLightGizmo (light : Light, gizmoType : GizmoType) { var position = light.transform.position; // Draw the light icon // (A bit above the one drawn by the builtin light gizmo renderer) Gizmos.DrawIcon (position + Vector3.up, "Light Gizmo.tiff");

// Are we selected? Draw a solid sphere surrounding the light if ((gizmoType & GizmoType.SelectedOrChild) != 0) { // Indicate that this is the active object by using a brighter color. if ((gizmoType & GizmoType.Active) != 0) Gizmos.color = Color.red; else Gizmos.color = Color.red * 0.5; Gizmos.DrawSphere (position, light.range); } }

/* // Draw the gizmo if it is selected or a child of the selection. // This is the most common way to render a gizmo @DrawGizmo (GizmoType.SelectedOrChild)

// Draw the gizmo only if it is the active object. @DrawGizmo (GizmoType.Active)] */

public DrawGizmo(gizmo: GizmoType, drawnGizmoType: Type)
public DrawGizmo(GizmoType gizmo, Type drawnGizmoType);

Parameters

gizmo Flags to denote when the gizmo should be drawn.
drawnGizmoType Type of object for which the gizmo should be drawn.

Description

Same as above. drawnGizmoType determines of what type the object we are drawing the gizmo of has to be.

If drawnGizmoType is null, the type will be determined from the first parameter of the draw gizmo method. If drawnGizmoType is not null, it must be the same type as, or a subtype of, the type of the first parameter.