Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo Class Reference
Inheritance diagram for Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo:
Expansions.Missions.Editor.GAPCelestialBodyState_Base

Public Member Functions

void ButtonAction_Recenter ()
 Called when the GAP recenter button is pressed, centers the gizmo in the middle of the GAP window More...
 
override void End ()
 Ends the state, it will destroy the instantiated gizmo. More...
 
override void Init (GAPCelestialBody gapRef)
 Intializes the state, instantiates the Gizmo prefab, sets PQS to enabled and adds the corresponding callbacks to the UI elements. More...
 
GAPCelestialBody_InteractiveSurfaceGizmo InstantiateGizmo (string gizmoName)
 Creates an instance of a gizmo prefab to be interacted with. More...
 
override void LoadPlanet (CelestialBody newCelestialBody)
 Called when a planet is loaded, sets the gizmo over the new planets surface More...
 
override void OnClickUp (RaycastHit?hit)
 Called when the mouse has been clicked over the GAP window, it will place the gizmo on the surface of the celestial body. More...
 
override void OnDrag (PointerEventData.InputButton arg0, Vector2 dragVector)
 Called when the GAP window gets a drag action from the mouse. If selecting a gizmo, it will interact with it accordingly, otherwise the camera will be panned around the celestial body. More...
 
override void OnDragEnd (RaycastHit?hit)
 Called when mouse button is released after dragging More...
 
override void OnMouseOver (Vector2 cameraPoint)
 Called when the mouse is over the GAP window, used to determine if the mouse is hoverin one of the gizmo handles. Also calculates the hovered latitude and longitude values. More...
 
override void UnloadPlanet ()
 Called when a planet is unloaded, does nothing for now More...
 
override void Update ()
 Updates the state, used to scale the gizmo depending on the distance of the camera More...
 
void UpdateFooterText ()
 
- Public Member Functions inherited from Expansions.Missions.Editor.GAPCelestialBodyState_Base
GAPOrbitRenderer CreateSimpleOrbit (AdditionalEntity entityType, string name, Orbit orbit, MapNode.TypeData typeData)
 
void CreateSurfaceAreaGizmo (double latitude, double longitude, double radius)
 
GAPSurfaceIcon CreateSurfaceIcon (AdditionalEntity entityType, string name, MapNode.TypeData typeData, double latitude, double longitude, double altitude)
 
virtual void LateUpdate ()
 Updates the state, its called each frame More...
 
virtual void OnClick (RaycastHit?hit)
 Called when the GAP gets clicked More...
 
void OnFilterButton (AdditionalEntity entityType)
 UI Button events More...
 
void SetFilter (AdditionalEntity entityType, bool displayIcons)
 Icon toggles More...
 

Properties

GAPCelestialBody_SurfaceGizmo GizmoEntity [get]
 

Additional Inherited Members

- Public Types inherited from Expansions.Missions.Editor.GAPCelestialBodyState_Base
enum  AdditionalEntity {
  AdditionalEntity.Kerbal, AdditionalEntity.Asteroid, AdditionalEntity.Vessel, AdditionalEntity.Flag,
  AdditionalEntity.LaunchSite, AdditionalEntity.Objective
}
 
- Protected Attributes inherited from Expansions.Missions.Editor.GAPCelestialBodyState_Base
AdditionalEntity[] entityTypes
 
GAPCelestialBody gapRef
 

Member Function Documentation

void Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.ButtonAction_Recenter ( )
inline

Called when the GAP recenter button is pressed, centers the gizmo in the middle of the GAP window

override void Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.End ( )
inlinevirtual

Ends the state, it will destroy the instantiated gizmo.

Reimplemented from Expansions.Missions.Editor.GAPCelestialBodyState_Base.

override void Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.Init ( GAPCelestialBody  gapRef)
inlinevirtual

Intializes the state, instantiates the Gizmo prefab, sets PQS to enabled and adds the corresponding callbacks to the UI elements.

Parameters
gapRef

Reimplemented from Expansions.Missions.Editor.GAPCelestialBodyState_Base.

GAPCelestialBody_InteractiveSurfaceGizmo Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.InstantiateGizmo ( string  gizmoName)
inline

Creates an instance of a gizmo prefab to be interacted with.

Parameters
gizmoNameThe name of the gizmo in the prefab list.
override void Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.LoadPlanet ( CelestialBody  newCelestialBody)
inlinevirtual

Called when a planet is loaded, sets the gizmo over the new planets surface

Reimplemented from Expansions.Missions.Editor.GAPCelestialBodyState_Base.

override void Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.OnClickUp ( RaycastHit?  hit)
inlinevirtual

Called when the mouse has been clicked over the GAP window, it will place the gizmo on the surface of the celestial body.

Parameters
hit

Reimplemented from Expansions.Missions.Editor.GAPCelestialBodyState_Base.

override void Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.OnDrag ( PointerEventData.InputButton  arg0,
Vector2  dragVector 
)
inlinevirtual

Called when the GAP window gets a drag action from the mouse. If selecting a gizmo, it will interact with it accordingly, otherwise the camera will be panned around the celestial body.

Reimplemented from Expansions.Missions.Editor.GAPCelestialBodyState_Base.

override void Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.OnDragEnd ( RaycastHit?  hit)
inlinevirtual

Called when mouse button is released after dragging

Parameters
hitThe ray is from the gap localspace, it will usually hit the planet sphere collider

Reimplemented from Expansions.Missions.Editor.GAPCelestialBodyState_Base.

override void Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.OnMouseOver ( Vector2  cameraPoint)
inlinevirtual

Called when the mouse is over the GAP window, used to determine if the mouse is hoverin one of the gizmo handles. Also calculates the hovered latitude and longitude values.

Reimplemented from Expansions.Missions.Editor.GAPCelestialBodyState_Base.

override void Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.UnloadPlanet ( )
inlinevirtual

Called when a planet is unloaded, does nothing for now

Reimplemented from Expansions.Missions.Editor.GAPCelestialBodyState_Base.

override void Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.Update ( )
inlinevirtual

Updates the state, used to scale the gizmo depending on the distance of the camera

Reimplemented from Expansions.Missions.Editor.GAPCelestialBodyState_Base.

void Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.UpdateFooterText ( )
inline

Property Documentation

GAPCelestialBody_SurfaceGizmo Expansions.Missions.Editor.GAPCelestialBodyState_SurfaceGizmo.GizmoEntity
get

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