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

Public Member Functions

virtual void Initialize (GAPCelestialBody newGapRef)
 Called after the gizmo is instantiated to initialize its corresponding values. More...
 
virtual bool IsActive ()
 Checks if the gizmo is enabled to be interacted with. More...
 
virtual void OnDestroy ()
 Called before destroying the gizmo. More...
 
virtual void OnLoadPlanet (CelestialBody newCelestialBody)
 Called when a new planet is loaded (To reset any values if needed) More...
 
virtual void OnUpdate ()
 Called every frame. More...
 
virtual 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...
 

Public Attributes

Transform gizmoContainer
 

Protected Member Functions

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

double altitude
 
CelestialBody celestialBody
 
GAPCelestialBody gapRef
 
double latitude
 
double longitude
 

Properties

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...
 

Member Function Documentation

virtual void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.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 in Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Volume, Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Area, Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_PlaceVessel, Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo, and Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo_Icon.

virtual bool Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.IsActive ( )
inlinevirtual
virtual void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.OnDestroy ( )
inlinevirtual

Called before destroying the gizmo.

virtual void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.OnLoadPlanet ( CelestialBody  newCelestialBody)
inlinevirtual
virtual void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.OnUpdate ( )
inlinevirtual
virtual double Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.SetGizmoPosition ( double  newLatitude,
double  newLongitude,
double  newAltitude 
)
inlinevirtual

Sets the GAP gizmo on the celestial body surface from the latitude and longitude values. Altitude is calculated automatically.

Parameters
latitudeThe latitude value
longitudeThe longitude value

Reimplemented in Expansions.Missions.Editor.GAPCelestialBody_InteractiveSurfaceGizmo.

void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.SetInSurfaceFromPoint ( Vector3d  point)
inlineprotected

Sets a transform on the surface of the celestial body

Parameters
pointThe point in the celestial body to target transform position
targetTransformThe transform that will be moved to this new surface position, the rotation will be set as well depending on the curvature of the sphere. If its set to null it will be ignored.
void Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.SetInSurfaceFromPointAtSeaLevel ( Vector3d  point,
double  seaLevel 
)
inlineprotected

Sets a transform on the surface of the celestial body

Parameters
pointThe point in the celestial body to target transform position
targetTransformThe transform that will be moved to this new surface position, the rotation will be set as well depending on the curvature of the sphere. If its set to null it will be ignored.

Member Data Documentation

double Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.altitude
protected
CelestialBody Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.celestialBody
protected
GAPCelestialBody Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.gapRef
protected
Transform Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.gizmoContainer
double Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.latitude
protected
double Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.longitude
protected

Property Documentation

double Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.Altitude
get

Returns the altitude of the terrain under the gizmo position.

double Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.Latitude
get

Returns the latitude of the gizmo in the celestial body.

double Expansions.Missions.Editor.GAPCelestialBody_SurfaceGizmo.Longitude
get

Returns the longitude of the gizmo in the celestial body.


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