Tanoda
GILES.pb_SceneEditor Class Reference
Inheritance diagram for GILES.pb_SceneEditor:
GILES.pb_ObjectEditor

Public Member Functions

void OnKeyDownBase ()
 
virtual void Update ()
 
virtual void OnGUI ()
 
virtual void OnMouseDown ()
 
virtual void OnMouseMove ()
 
virtual void OnMouseUp ()
 
virtual void OnHandleBegin (pb_Transform transform)
 
virtual void OnHandleMove (pb_Transform transform)
 
virtual void OnHandleFinish ()
 
virtual void OnKeyDown ()
 
virtual void OnFrameSelection ()
 
virtual void OnEnable ()
 
virtual void OnDisabled ()
 
virtual void OnSelectionChange (IEnumerable< GameObject > added)
 
virtual bool EnableCameraControls ()
 
virtual bool IsMouseInUse ()
 

Public Attributes

bool skipOnGUI = false
 

Detailed Description

Scripts wanting to take control of the scene editor must inherit this class. To activate the editor, set it as the current editor in the pb_InputManager class.

Definition at line 15 of file pb_SceneEditor.cs.

Member Function Documentation

◆ EnableCameraControls()

virtual bool GILES.pb_SceneEditor.EnableCameraControls ( )
virtual

Override this to determine when the camera receives full control.

Reimplemented in GILES.pb_ObjectEditor.

Definition at line 192 of file pb_SceneEditor.cs.

◆ IsMouseInUse()

virtual bool GILES.pb_SceneEditor.IsMouseInUse ( )
virtual

Determines if the mouse should send events to the editor mode. Base checks against any registered functions in pb_InputManager and also against any uGUI functions. If this returns true, no mouse events will be sent to inheriting objects.

Definition at line 203 of file pb_SceneEditor.cs.

◆ OnDisabled()

virtual void GILES.pb_SceneEditor.OnDisabled ( )
virtual

Called when an editor is unloaded from the scene. Use this to clean up any temporary resources.

Definition at line 181 of file pb_SceneEditor.cs.

◆ OnEnable()

virtual void GILES.pb_SceneEditor.OnEnable ( )
virtual

Called when an editor is first enabled in the scene. Initialize temporary resources here.

Reimplemented in GILES.pb_ObjectEditor.

Definition at line 176 of file pb_SceneEditor.cs.

◆ OnFrameSelection()

virtual void GILES.pb_SceneEditor.OnFrameSelection ( )
virtual

Called when the user presses the F key to frame the current selection. pb_ObjectEditor forwards this to the scene camera to enable zooming to the current selection.

Reimplemented in GILES.pb_ObjectEditor.

Definition at line 171 of file pb_SceneEditor.cs.

◆ OnGUI()

virtual void GILES.pb_SceneEditor.OnGUI ( )
virtual

OnGUI forwarded from MonoBehaviour.

Reimplemented in GILES.pb_ObjectEditor.

Definition at line 125 of file pb_SceneEditor.cs.

◆ OnHandleBegin()

virtual void GILES.pb_SceneEditor.OnHandleBegin ( pb_Transform  transform)
virtual

OnHandleBegin is called at the start of a handle interaction. transform is the handle's transform prior to any movement.

Reimplemented in GILES.pb_ObjectEditor.

Definition at line 149 of file pb_SceneEditor.cs.

◆ OnHandleFinish()

virtual void GILES.pb_SceneEditor.OnHandleFinish ( )
virtual

Called the handle relinquishes control, either due to a mouse up event or canceled action.

Definition at line 160 of file pb_SceneEditor.cs.

◆ OnHandleMove()

virtual void GILES.pb_SceneEditor.OnHandleMove ( pb_Transform  transform)
virtual

Called any time a handle is moved. OnHandleBegin will always be called prior, and OnHandleFinish will be called post.

Reimplemented in GILES.pb_ObjectEditor.

Definition at line 155 of file pb_SceneEditor.cs.

◆ OnKeyDown()

virtual void GILES.pb_SceneEditor.OnKeyDown ( )
virtual

Called when a user presses a key. Fired once.

Reimplemented in GILES.pb_ObjectEditor.

Definition at line 165 of file pb_SceneEditor.cs.

◆ OnKeyDownBase()

void GILES.pb_SceneEditor.OnKeyDownBase ( )

Definition at line 97 of file pb_SceneEditor.cs.

◆ OnMouseDown()

virtual void GILES.pb_SceneEditor.OnMouseDown ( )
virtual

Called when a valid mouse down event is raised. This is passed down from pb_InputManager, which first checks that the interface doesn't need to intercept this click.

Reimplemented in GILES.pb_ObjectEditor.

Definition at line 131 of file pb_SceneEditor.cs.

◆ OnMouseMove()

virtual void GILES.pb_SceneEditor.OnMouseMove ( )
virtual

Called on any mouse movement. If OnMouseDown was intercepted by pb_InputManager, no movement events will be called until the next valid mouse down event.

Reimplemented in GILES.pb_ObjectEditor.

Definition at line 137 of file pb_SceneEditor.cs.

◆ OnMouseUp()

virtual void GILES.pb_SceneEditor.OnMouseUp ( )
virtual

Called when a valid mouse up event is raised. This is passed down from pb_InputManager, which first checks that the interface doesn't need to intercept this click.

Reimplemented in GILES.pb_ObjectEditor.

Definition at line 143 of file pb_SceneEditor.cs.

◆ OnSelectionChange()

virtual void GILES.pb_SceneEditor.OnSelectionChange ( IEnumerable< GameObject >  added)
virtual

Called when the current selection is modified, either through a new selection or a change in the inspector. This is the same as subscribing to pb_Selection.onSelectionChange.

Reimplemented in GILES.pb_ObjectEditor.

Definition at line 187 of file pb_SceneEditor.cs.

◆ Update()

virtual void GILES.pb_SceneEditor.Update ( )
virtual

Called once per frame.

Definition at line 120 of file pb_SceneEditor.cs.

Member Data Documentation

◆ skipOnGUI

bool GILES.pb_SceneEditor.skipOnGUI = false

Definition at line 28 of file pb_SceneEditor.cs.


The documentation for this class was generated from the following file: