Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Classes | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
Expansions.Missions.Editor.ActionPaneDisplay Class Reference
Inheritance diagram for Expansions.Missions.Editor.ActionPaneDisplay:
Expansions.Missions.Editor.ActionPaneDisplay_BiSelector Expansions.Missions.Editor.ActionPaneDisplay_CelestialBody Expansions.Missions.Editor.GAPPartPicker Expansions.Missions.Editor.GAPPrefabDisplay Expansions.Missions.Editor.GAPVesselDisplay Expansions.Missions.Editor.GAPCelestialBody

Classes

class  DragEvent
 
class  MouseOverEvent
 
class  RaycastEvent
 

Public Member Functions

Button AddToolbarButton (string id, string icon, string toolTip)
 Creates a gap toolbar button control More...
 
Toggle AddToolbarToggle (string id, string icon, string toolTip, bool startState=false)
 Creates a gap toolbar toggle control More...
 
virtual void Clean ()
 Clean this GAP Display More...
 
void ClearToolbar ()
 Clean the GAP tool bar controls More...
 
virtual void Destroy ()
 Destroy this GAP Display More...
 
bool GetMousePointOnCamera (Vector2 mousePosition, Camera canvasCamera, ref Vector2 point)
 Gets the mouse position relative to the GAP display camera, used for ray cast objects displayed in the render texture More...
 
Button GetToolbarButton (string id)
 Get a tool bar button More...
 
virtual void OnBeginDrag (PointerEventData eventData)
 Event triggered on drag begin More...
 
override void OnDeselect (BaseEventData eventData)
 Event triggered on UI selectable deselect More...
 
virtual void OnDisplayClickUp (RaycastHit?hit)
 
virtual void OnDisplayDragEnd (RaycastHit?hit)
 
virtual void OnDrag (PointerEventData eventData)
 Event triggered on pointer drag More...
 
virtual void OnEndDrag (PointerEventData eventData)
 Event triggered on drag end More...
 
virtual void OnPointerClick (PointerEventData eventData)
 Event triggered on pointer click this gameobject rect More...
 
override void OnPointerEnter (PointerEventData eventData)
 Event triggered on pointer enter this gameobject rect More...
 
override void OnPointerExit (PointerEventData eventData)
 Event triggered on pointer exit this gameobject rect More...
 
override void OnPointerUp (PointerEventData eventData)
 
override void OnSelect (BaseEventData eventData)
 Event triggered on UI selecteable select More...
 
bool Raycast (Vector3 cameraPoint, out RaycastHit hit, int layerMask=-1)
 Help function, makes a ray cast from the supplied camera point using the gap display camera, layer mask and hit distance values More...
 
virtual void Setup (Camera displayCamera, int layerMask)
 Setups the Action Pane display More...
 
void UpdateDisplayArea ()
 Updates the render texture display area maintaining the game aspect ratio More...
 

Public Attributes

RaycastEvent DisplayClick
 Event that triggers on the display click, sends a hitinfo if an object was clicked on More...
 
RaycastEvent DisplayClickUp
 Event that triggers on the display click when the button is up, sends a hitinfo if an object was clicked on More...
 
DragEvent DisplayDrag
 Event that triggers a mouse drag, sends the button and mouse delta information More...
 
RaycastEvent DisplayDragEnd
 Event that triggers on the display click when the button is up, sends a hitinfo if an object was clicked on More...
 
RawImage displayImage
 Raw image that displays the render texture More...
 
MouseOverEvent MouseOver
 Event that trigger when the mouse is over the GAP display image More...
 
RectTransform rectTransform
 Rect transform cache More...
 

Protected Member Functions

override void Awake ()
 
void ClearToolbarEvents ()
 Clear the tool bar controls events More...
 
virtual void OnDisplayClick (RaycastHit?hit)
 
virtual void OnDisplayDrag (PointerEventData.InputButton button, Vector2 delta)
 
virtual void OnMouseOver (Vector2 position)
 
virtual void Update ()
 

Protected Attributes

Camera displayCamera
 
RenderTexture displayTexture
 
float hitDistance
 
bool isDragging = false
 
bool isMouseOver = false
 
bool isSelected = false
 
int layerMask
 
DictionaryValueList< string,
MonoBehaviour > 
toolbarControls
 

Properties

RenderTexture DisplayTexture [get]
 

Member Function Documentation

Button Expansions.Missions.Editor.ActionPaneDisplay.AddToolbarButton ( string  id,
string  icon,
string  toolTip 
)
inline

Creates a gap toolbar button control

Parameters
iconIcon of this control
toolTipTooltip of this control
Returns
Toggle Expansions.Missions.Editor.ActionPaneDisplay.AddToolbarToggle ( string  id,
string  icon,
string  toolTip,
bool  startState = false 
)
inline

Creates a gap toolbar toggle control

Parameters
icon
iconIcon of this control
toolTipTooltip of this control
Returns
override void Expansions.Missions.Editor.ActionPaneDisplay.Awake ( )
inlineprotected
virtual void Expansions.Missions.Editor.ActionPaneDisplay.Clean ( )
inlinevirtual
void Expansions.Missions.Editor.ActionPaneDisplay.ClearToolbar ( )
inline

Clean the GAP tool bar controls

void Expansions.Missions.Editor.ActionPaneDisplay.ClearToolbarEvents ( )
inlineprotected

Clear the tool bar controls events

virtual void Expansions.Missions.Editor.ActionPaneDisplay.Destroy ( )
inlinevirtual
bool Expansions.Missions.Editor.ActionPaneDisplay.GetMousePointOnCamera ( Vector2  mousePosition,
Camera  canvasCamera,
ref Vector2  point 
)
inline

Gets the mouse position relative to the GAP display camera, used for ray cast objects displayed in the render texture

Parameters
mousePosition
canvasCamera
point
Returns
Button Expansions.Missions.Editor.ActionPaneDisplay.GetToolbarButton ( string  id)
inline

Get a tool bar button

Parameters
id
Returns
virtual void Expansions.Missions.Editor.ActionPaneDisplay.OnBeginDrag ( PointerEventData  eventData)
inlinevirtual

Event triggered on drag begin

Parameters
eventData
override void Expansions.Missions.Editor.ActionPaneDisplay.OnDeselect ( BaseEventData  eventData)
inline

Event triggered on UI selectable deselect

Parameters
eventData
virtual void Expansions.Missions.Editor.ActionPaneDisplay.OnDisplayClick ( RaycastHit?  hit)
inlineprotectedvirtual
virtual void Expansions.Missions.Editor.ActionPaneDisplay.OnDisplayClickUp ( RaycastHit?  hit)
inlinevirtual
virtual void Expansions.Missions.Editor.ActionPaneDisplay.OnDisplayDrag ( PointerEventData.InputButton  button,
Vector2  delta 
)
inlineprotectedvirtual
virtual void Expansions.Missions.Editor.ActionPaneDisplay.OnDisplayDragEnd ( RaycastHit?  hit)
inlinevirtual
virtual void Expansions.Missions.Editor.ActionPaneDisplay.OnDrag ( PointerEventData  eventData)
inlinevirtual

Event triggered on pointer drag

Parameters
eventData
virtual void Expansions.Missions.Editor.ActionPaneDisplay.OnEndDrag ( PointerEventData  eventData)
inlinevirtual

Event triggered on drag end

Parameters
eventData
virtual void Expansions.Missions.Editor.ActionPaneDisplay.OnMouseOver ( Vector2  position)
inlineprotectedvirtual
virtual void Expansions.Missions.Editor.ActionPaneDisplay.OnPointerClick ( PointerEventData  eventData)
inlinevirtual

Event triggered on pointer click this gameobject rect

Parameters
eventData
override void Expansions.Missions.Editor.ActionPaneDisplay.OnPointerEnter ( PointerEventData  eventData)
inline

Event triggered on pointer enter this gameobject rect

Parameters
eventData
override void Expansions.Missions.Editor.ActionPaneDisplay.OnPointerExit ( PointerEventData  eventData)
inline

Event triggered on pointer exit this gameobject rect

Parameters
eventData
override void Expansions.Missions.Editor.ActionPaneDisplay.OnPointerUp ( PointerEventData  eventData)
inline
override void Expansions.Missions.Editor.ActionPaneDisplay.OnSelect ( BaseEventData  eventData)
inline

Event triggered on UI selecteable select

Parameters
eventData
bool Expansions.Missions.Editor.ActionPaneDisplay.Raycast ( Vector3  cameraPoint,
out RaycastHit  hit,
int  layerMask = -1 
)
inline

Help function, makes a ray cast from the supplied camera point using the gap display camera, layer mask and hit distance values

Parameters
cameraPoint
hit
layerMaskoverrides the layer mask used to raycast in the GAP
Returns
virtual void Expansions.Missions.Editor.ActionPaneDisplay.Setup ( Camera  displayCamera,
int  layerMask 
)
inlinevirtual

Setups the Action Pane display

Parameters
displayCameraCamera used to display the Action Pane contents
maskLayer mask used for the click raycast

Reimplemented in Expansions.Missions.Editor.GAPPrefabDisplay, and Expansions.Missions.Editor.GAPVesselDisplay.

virtual void Expansions.Missions.Editor.ActionPaneDisplay.Update ( )
inlineprotectedvirtual
void Expansions.Missions.Editor.ActionPaneDisplay.UpdateDisplayArea ( )
inline

Updates the render texture display area maintaining the game aspect ratio

Member Data Documentation

Camera Expansions.Missions.Editor.ActionPaneDisplay.displayCamera
protected
RaycastEvent Expansions.Missions.Editor.ActionPaneDisplay.DisplayClick

Event that triggers on the display click, sends a hitinfo if an object was clicked on

RaycastEvent Expansions.Missions.Editor.ActionPaneDisplay.DisplayClickUp

Event that triggers on the display click when the button is up, sends a hitinfo if an object was clicked on

DragEvent Expansions.Missions.Editor.ActionPaneDisplay.DisplayDrag

Event that triggers a mouse drag, sends the button and mouse delta information

RaycastEvent Expansions.Missions.Editor.ActionPaneDisplay.DisplayDragEnd

Event that triggers on the display click when the button is up, sends a hitinfo if an object was clicked on

RawImage Expansions.Missions.Editor.ActionPaneDisplay.displayImage

Raw image that displays the render texture

RenderTexture Expansions.Missions.Editor.ActionPaneDisplay.displayTexture
protected
float Expansions.Missions.Editor.ActionPaneDisplay.hitDistance
protected
bool Expansions.Missions.Editor.ActionPaneDisplay.isDragging = false
protected
bool Expansions.Missions.Editor.ActionPaneDisplay.isMouseOver = false
protected
bool Expansions.Missions.Editor.ActionPaneDisplay.isSelected = false
protected
int Expansions.Missions.Editor.ActionPaneDisplay.layerMask
protected
MouseOverEvent Expansions.Missions.Editor.ActionPaneDisplay.MouseOver

Event that trigger when the mouse is over the GAP display image

RectTransform Expansions.Missions.Editor.ActionPaneDisplay.rectTransform

Rect transform cache

DictionaryValueList<string, MonoBehaviour> Expansions.Missions.Editor.ActionPaneDisplay.toolbarControls
protected

Property Documentation

RenderTexture Expansions.Missions.Editor.ActionPaneDisplay.DisplayTexture
get

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