Version: 2023.1
LanguageEnglish
  • C#

HandleUtility.PlaceObject

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

Declaration

public static bool PlaceObject(Vector2 guiPosition, out Vector3 position, out Vector3 normal);

Parameters

guiPosition The GUI position in the SceneView. You can pass Event.current.mousePosition to this parameter in most cases.
position Returns the nearest intersected point to a ray cast from the mouse position into the scene.
normal Returns the normal of the nearest intersected point to a ray cast from the mouse position into the scene.

Returns

bool Returns true if the raycast intersected something in the scene; otherwise, false.

Description

Casts a ray against the loaded scenes and returns the nearest intersected point on a collider.

Use this method to match the behavior of drag and drop in the SceneView.

PlaceObject also queries any delegates registered to placeObjectCustomPasses when determining the nearest point.