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

Public Member Functions

override string GetFooterText ()
 This method will prepara the top section of the text in the gap window. More...
 
override void Initialize (GAPCelestialBody newGapRef)
 Called after the gizmo is instantiated to initialize its corresponding values. More...
 
override bool IsActive ()
 Checks if the gizmo is enabled to be interacted with. More...
 
override void OnGAPClick (double newLatitude, double newLongitude)
 Called when GAP window is clicked. More...
 
override void OnGAPDrag (double dragStartLatitude, double dragStartLongitude, double dragLatitude, double dragLongitude)
 Called when there is a drag gesture on the GAP window. More...
 
override void OnGAPDragEnd ()
 Called when the drag gesture over the gap window has ended. More...
 
override void OnGAPOver (double hoverLatitude, double hoverLongitude)
 Called when the mouse is over the GAP window. More...
 
delegate void OnGAPShapeBoundsChange (float minValue, float maxValue)
 
delegate void OnGAPShapeChange (SurfaceVolume.VolumeShape newShape)
 
delegate void OnGAPValueChange (float newRadius)
 
override void OnGizmoHandleSelected (GAPCelestialBodyGizmoHandle selectedHandle)
 Called when a gizmo has been clicked to be interacted with. More...
 
override void OnLoadPlanet (CelestialBody newCelestialBody)
 Called when a new planet is loaded (To reset any values if needed) More...
 
override void OnUpdate ()
 Called every frame. More...
 
void SetConeBounds (float minValue, float maxValue)
 A method for setting the bounds of the cone, it is done on a single method to avoid adjusting components twice More...
 
void UpdateFooterText_Cone ()
 
void UpdateFooterText_Sphere ()
 
- Public Member Functions inherited from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo
virtual Transform GetFocusTarget ()
 
bool IsDragReady ()
 Checks if there is a gizmo handle selected. More...
 
void OnButtonPressed_FocusTarget ()
 The event executed when the Focus Target button is pressed. More...
 
virtual void OnGizmoHandleDrag (double dragStartLatitude, double dragStartLongitude, double dragLatitude, double dragLongitude)
 Called when a handle of the gizmo is getting dragged. More...
 
virtual void OnGizmoHandleDragEnd ()
 Called when the drag gesture over one of the handles has ended. More...
 
virtual void OnGizmoHandleOver (double hoverLatitude, double hoverLongitude)
 Called when the mouse is over a gizmo object. More...
 
delegate void OnPointTranslate (double latitude, double longitude)
 
override double SetGizmoPosition (double newLatitude, double newLongitude, double newAltitude)
 Sets the GAP gizmo on the celestial body surface from the latitude and longitude values. Altitude is calculated automatically. More...
 
bool TrySelectHandle (Collider handleCollider)
 A method to check the status of the gizmo handles. It will compare a collider to see if its a handle, and if it is it will select it if its intended. It uses a collider since the test method is a raycast to the surface of the planet. More...
 
- Public Member Functions inherited from Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo
virtual void OnDestroy ()
 Called before destroying the gizmo. More...
 

Public Attributes

Color colorRadius_Drag
 
Color colorRadius_Idle
 
Color colorRadiusEdge_Highlight
 
Color colorRadiusEdge_Idle
 
Transform containerProjector
 
AnimationCurve curveCylinderBounds
 
AnimationCurve curveSphereHeight
 
GAPUtil_DynamicCylinder dynamicCylinder
 
GameObject dynamicSphere
 
Transform dynamicSpherePivot
 
LineRenderer heightLine
 
Material materialCylinder
 
OnGAPShapeBoundsChange OnGAPGizmoConeBoundsChange
 
OnGAPValueChange OnGAPGizmoHeightSphere
 
OnGAPValueChange OnGAPGizmoRadiusChange
 
OnGAPShapeChange OnGAPGizmoShapeChange
 
Projector projectorRadius
 
- Public Attributes inherited from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo
List< GAPCelestialBodyGizmoHandlegizmoHandles
 
OnPointTranslate OnGAPGizmoTranslate
 
Sprite spriteFocusCelestialBody
 
Sprite spriteFocusTarget
 
- Public Attributes inherited from Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo
Transform gizmoContainer
 

Properties

float HeightConeMax [get, set]
 Returns the height of the top part of the Cone. More...
 
float HeightConeMin [get, set]
 Returns the height of the bottom part of the Cone. More...
 
float HeightSphere [get, set]
 The maximum radius the outer circle can grow to (since the inner circle cant grow larget that the outer, its also restrained) More...
 
float MaxRadius [get, set]
 The maximum radius the circle can grow to. More...
 
float Radius [get, set]
 The radius on the surface of the planet. More...
 
SurfaceVolume.VolumeShape Shape [get, set]
 The shape of the volume More...
 
- Properties inherited from Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo
double Altitude [get]
 Returns the altitude of the terrain under the gizmo position. More...
 
double Latitude [get]
 Returns the latitude of the gizmo in the celestial body. More...
 
double Longitude [get]
 Returns the longitude of the gizmo in the celestial body. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo
void SetInSurfaceFromPoint (Vector3d point)
 Sets a transform on the surface of the celestial body More...
 
void SetInSurfaceFromPointAtSeaLevel (Vector3d point, double seaLevel)
 Sets a transform on the surface of the celestial body More...
 
- Protected Attributes inherited from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo
GAPCelestialBodyGizmoHandle selectedHandle
 
- Protected Attributes inherited from Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo
double altitude
 
CelestialBody celestialBody
 
GAPCelestialBody gapRef
 
double latitude
 
double longitude
 

Member Function Documentation

override string Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.GetFooterText ( )
inlinevirtual

This method will prepara the top section of the text in the gap window.

Returns
The string to be show on the gap window.

Reimplemented from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo.

override void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.Initialize ( GAPCelestialBody  newGapRef)
inlinevirtual

Called after the gizmo is instantiated to initialize its corresponding values.

Parameters
newGapRefThe reference to the GAPCelestiaBody script, it handles the camera movement etc...

Reimplemented from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo.

override bool Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.IsActive ( )
inlinevirtual

Checks if the gizmo is enabled to be interacted with.

Returns
True if there is a selected handle.

Reimplemented from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo.

override void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGAPClick ( double  newLatitude,
double  newLongitude 
)
inlinevirtual

Called when GAP window is clicked.

Parameters
newLatitudeThe latitude position of the mouse corresponding to the surface of the planet.
newLongitudeThe longitude position of the mouse corresponding to the surface of the planet.

Reimplemented from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo.

override void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGAPDrag ( double  dragStartLatitude,
double  dragStartLongitude,
double  dragLatitude,
double  dragLongitude 
)
inlinevirtual

Called when there is a drag gesture on the GAP window.

Parameters
dragStartLatitudeThe latitude position when the drag gesture started.
dragStartLongitudeThe longitude posiion when the drag gesture started.
dragLatitudeThe latitude position of the mouse corresponding to the surface of the planet.
dragLongitudeThe longiutde position of the mouse corresponding to the surface of the planet.

Reimplemented from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo.

override void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGAPDragEnd ( )
inlinevirtual

Called when the drag gesture over the gap window has ended.

Reimplemented from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo.

override void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGAPOver ( double  hoverLatitude,
double  hoverLongitude 
)
inlinevirtual

Called when the mouse is over the GAP window.

Parameters
hoverLatitudeThe latitude position of the mouse corresponding to the surface of the planet.
hoverLongitudeThe longitude position of the mouse corresponding to the surface of the planet.

Reimplemented from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo.

delegate void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGAPShapeBoundsChange ( float  minValue,
float  maxValue 
)
delegate void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGAPShapeChange ( SurfaceVolume.VolumeShape  newShape)
delegate void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGAPValueChange ( float  newRadius)
override void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGizmoHandleSelected ( GAPCelestialBodyGizmoHandle  selectedHandle)
inlinevirtual

Called when a gizmo has been clicked to be interacted with.

Parameters
selectedHandleThe handle that was selected.

Reimplemented from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo.

override void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnLoadPlanet ( CelestialBody  newCelestialBody)
inlinevirtual

Called when a new planet is loaded (To reset any values if needed)

Parameters
newCelestialBody

Reimplemented from Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo.

override void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnUpdate ( )
inlinevirtual
void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.SetConeBounds ( float  minValue,
float  maxValue 
)
inline

A method for setting the bounds of the cone, it is done on a single method to avoid adjusting components twice

void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.UpdateFooterText_Cone ( )
inline
void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.UpdateFooterText_Sphere ( )
inline

Member Data Documentation

Color Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.colorRadius_Drag
Color Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.colorRadius_Idle
Color Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.colorRadiusEdge_Highlight
Color Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.colorRadiusEdge_Idle
Transform Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.containerProjector
AnimationCurve Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.curveCylinderBounds
AnimationCurve Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.curveSphereHeight
GAPUtil_DynamicCylinder Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.dynamicCylinder
GameObject Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.dynamicSphere
Transform Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.dynamicSpherePivot
LineRenderer Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.heightLine
Material Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.materialCylinder
OnGAPShapeBoundsChange Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGAPGizmoConeBoundsChange
OnGAPValueChange Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGAPGizmoHeightSphere
OnGAPValueChange Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGAPGizmoRadiusChange
OnGAPShapeChange Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.OnGAPGizmoShapeChange
Projector Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.projectorRadius

Property Documentation

float Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.HeightConeMax
getset

Returns the height of the top part of the Cone.

float Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.HeightConeMin
getset

Returns the height of the bottom part of the Cone.

float Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.HeightSphere
getset

The maximum radius the outer circle can grow to (since the inner circle cant grow larget that the outer, its also restrained)

float Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.MaxRadius
getset

The maximum radius the circle can grow to.

float Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.Radius
getset

The radius on the surface of the planet.

SurfaceVolume.VolumeShape Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume.Shape
getset

The shape of the volume


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