Expansions.Missions.SurfaceVolume Class Reference

Contains the parameters for an area above the surface of the planet, it can have 2 different shapes. More...

Inheritance diagram for Expansions.Missions.SurfaceVolume:

Public Types
enum	VolumeShape { VolumeShape.Cone, VolumeShape.Sphere }

Public Member Functions
void	AjustToBody (float radius, float heightSphere, float heigthConeMin, float heightConeMax, CelestialBody newBody, CelestialBody pastBody)
override bool	Equals (object obj)
string	GetExtraText ()
	Get extra text to be appended at the end of the node label caption. More...
override int	GetHashCode ()
string	GetNodeBodyParameterString ()
	Returns the string to be displayed when the parameter is displayed in the node body More...
Waypoint	GetWaypoint ()
	Get the waypoint marker to show the location of the current test module. More...
Vector3	GetWorldPosition ()
	Get location where the marker for the node should be displayed in world. More...
bool	HasNodeLabel ()
	Should we create a node label for this object or not? More...
bool	HasWaypoint ()
	Should we create a waypoint for this object or not? More...
bool	HasWorldPosition ()
	Does the label represent an actual world position? For example, biomes won't have a world position, but a point in space will. More...
bool	IsInsideVolume (float targetLatitude, float targetLongitude, float targetAltitude)
	Returns true if the target passed in is located inside the volume of the shape. More...
void	Load (ConfigNode node)
	Loads the surface volume values from a node. More...
void	ResetBodyToDefaultValues ()
void	Save (ConfigNode node)
	Saves the current values from the surface volume to a node. More...
List< MEGUIDropDownItem >	SetCelestialBodies ()
	SurfaceVolume (CelestialBody targetBody, double longitude, double latitude, float radius, VolumeShape shape, float heightSphere, float heightConeMin, float heightConeMax)
	Creates the logic class to test a volume above the surface. More...
	SurfaceVolume ()

Public Attributes
double	altitude
	altitude of the volume center point More...
CelestialBody	body
	The Target CelestialBody for the vessel. Would be the one it is landed on, or in Orbit of. More...
float	heightConeMax
	The height of the top part of the cone. More...
float	heightConeMin
	The height of the bottom part of the cone. More...
float	heightSphere
	The height of the sphere volume from the surface of the planet upwards More...
double	latitude
	latitude of the volume center point More...
double	longitude
	longitude of volume center point More...
float	radius
	The radius of the inner cicle of the surface area More...
VolumeShape	shape
	The shape that will be displayed in the gizmo, for now it can only be a Cone or a Sphere More...
bool	showNodeLabel = false

Detailed Description

Contains the parameters for an area above the surface of the planet, it can have 2 different shapes.

Member Enumeration Documentation

enum Expansions.Missions.SurfaceVolume.VolumeShape

Enumerator
Cone
Sphere

Constructor & Destructor Documentation

Expansions.Missions.SurfaceVolume.SurfaceVolume ( CelestialBody  targetBody, double  longitude, double  latitude, float  radius, VolumeShape  shape, float  heightSphere, float  heightConeMin, float  heightConeMax  )

inline

Creates the logic class to test a volume above the surface.

Expansions.Missions.SurfaceVolume.SurfaceVolume ( )

inline

Member Function Documentation

void Expansions.Missions.SurfaceVolume.AjustToBody ( float  radius, float  heightSphere, float  heigthConeMin, float  heightConeMax, CelestialBody  newBody, CelestialBody  pastBody  )

inline

override bool Expansions.Missions.SurfaceVolume.Equals ( object  obj )

inline

string Expansions.Missions.SurfaceVolume.GetExtraText ( )

inline

Get extra text to be appended at the end of the node label caption.

Returns

Text to be appended at the end of the node label caption.

override int Expansions.Missions.SurfaceVolume.GetHashCode ( )

inline

string Expansions.Missions.SurfaceVolume.GetNodeBodyParameterString ( )

inline

Returns the string to be displayed when the parameter is displayed in the node body

Returns

String to be displayed when the parameter is displayed in the node body,

Waypoint Expansions.Missions.SurfaceVolume.GetWaypoint ( )

inline

Get the waypoint marker to show the location of the current test module.

Returns

Waypoint marker representing the current test module.

Vector3 Expansions.Missions.SurfaceVolume.GetWorldPosition ( )

inline

Get location where the marker for the node should be displayed in world.

Returns

Location of the node.

bool Expansions.Missions.SurfaceVolume.HasNodeLabel ( )

inline

Should we create a node label for this object or not?

Returns

True if we should create a node label, false otherwise.

bool Expansions.Missions.SurfaceVolume.HasWaypoint ( )

inline

Should we create a waypoint for this object or not?

Returns

True if we should create a waypoint, false otherwise.

bool Expansions.Missions.SurfaceVolume.HasWorldPosition ( )

inline

Does the label represent an actual world position? For example, biomes won't have a world position, but a point in space will.

Returns

True if the node has a world position, false otherwise.

bool Expansions.Missions.SurfaceVolume.IsInsideVolume ( float  targetLatitude, float  targetLongitude, float  targetAltitude  )

inline

Returns true if the target passed in is located inside the volume of the shape.

Parameters

latitude	The latitude of the target on the Celestial Body.
longitude	The longitude of the target on the Celestial Body.
altitude	The altitude of the target from the surface of the Celestial Body.

Returns

void Expansions.Missions.SurfaceVolume.Load ( ConfigNode  node )

inline

Loads the surface volume values from a node.

Parameters

node

Implements IConfigNode.

void Expansions.Missions.SurfaceVolume.ResetBodyToDefaultValues ( )

inline

void Expansions.Missions.SurfaceVolume.Save ( ConfigNode  node )

inline

Saves the current values from the surface volume to a node.

Implements IConfigNode.

List<MEGUIDropDownItem> Expansions.Missions.SurfaceVolume.SetCelestialBodies ( )

inline

Member Data Documentation

double Expansions.Missions.SurfaceVolume.altitude

altitude of the volume center point

CelestialBody Expansions.Missions.SurfaceVolume.body

The Target CelestialBody for the vessel. Would be the one it is landed on, or in Orbit of.

float Expansions.Missions.SurfaceVolume.heightConeMax

The height of the top part of the cone.

float Expansions.Missions.SurfaceVolume.heightConeMin

The height of the bottom part of the cone.

float Expansions.Missions.SurfaceVolume.heightSphere

The height of the sphere volume from the surface of the planet upwards

double Expansions.Missions.SurfaceVolume.latitude

latitude of the volume center point

double Expansions.Missions.SurfaceVolume.longitude

longitude of volume center point

float Expansions.Missions.SurfaceVolume.radius

The radius of the inner cicle of the surface area

VolumeShape Expansions.Missions.SurfaceVolume.shape

The shape that will be displayed in the gizmo, for now it can only be a Cone or a Sphere

bool Expansions.Missions.SurfaceVolume.showNodeLabel = false

---

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

• KSP/Assets/Expansions/Missions/Scripts/SurfaceVolume.cs