Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
FuelFlowOverlay Class Reference
Inheritance diagram for FuelFlowOverlay:

Public Member Functions

void ClearOverlay ()
 Clears and destroys everything the overlay is displaying. More...
 
bool isConsumer (Part part)
 Verify if a part is or would be considered a consumer in the overlay. Note: this method does recalculate the graph. Use RUI.Algorithms.SCCFlowGraphUCFinder.IsEntryPointRequest(Part part) if the overlay is not displaying or if you are using this to check for possible entry points. More...
 
bool isConsumerOrProvider (Part part)
 Verify if a part is or would be considered a consumer or provider in the overlay. Note: this method does recalculate the graph. Use RUI.Algorithms.SCCFlowGraphUCFinder.IsEntryPoint(Part part) if the overlay is not displaying or if you are using this to check for possible entry points. More...
 
bool isProvider (Part part)
 Verify if a part is or would be considered a provider in the overlay. Note: this method does recalculate the graph. Use RUI.Algorithms.SCCFlowGraphUCFinder.IsEntryPointDelivery(Part part) if the overlay is not displaying or if you are using this to check for possible entry points. More...
 
void RedrawOverlay (Part part)
 Redraws flow priority texts. Only applicable if you absolutely want no delay on the text update. More...
 
void RespawnOverlay (Part part)
 If the owerlay is already showing, Does the same thing as SpawnOverlay but delayed one frame. More...
 
void SpawnOverlay (Part part)
 Clears and redraws the overlay from the given part. More...
 

Public Attributes

GameObject gizmoConsumer
 
GameObject gizmoNode
 
GameObject gizmoProvider
 
GameObject gizmoTarget
 
Texture lineArrowTexture
 
Material lineMaterial
 
Texture lineTexture
 

Static Public Attributes

static FuelFlowOverlay instance
 

Properties

bool IsDisplaying [get, set]
 

Member Function Documentation

void FuelFlowOverlay.ClearOverlay ( )
inline

Clears and destroys everything the overlay is displaying.

bool FuelFlowOverlay.isConsumer ( Part  part)
inline

Verify if a part is or would be considered a consumer in the overlay. Note: this method does recalculate the graph. Use RUI.Algorithms.SCCFlowGraphUCFinder.IsEntryPointRequest(Part part) if the overlay is not displaying or if you are using this to check for possible entry points.

Parameters
part
Returns
bool FuelFlowOverlay.isConsumerOrProvider ( Part  part)
inline

Verify if a part is or would be considered a consumer or provider in the overlay. Note: this method does recalculate the graph. Use RUI.Algorithms.SCCFlowGraphUCFinder.IsEntryPoint(Part part) if the overlay is not displaying or if you are using this to check for possible entry points.

Parameters
part
Returns
bool FuelFlowOverlay.isProvider ( Part  part)
inline

Verify if a part is or would be considered a provider in the overlay. Note: this method does recalculate the graph. Use RUI.Algorithms.SCCFlowGraphUCFinder.IsEntryPointDelivery(Part part) if the overlay is not displaying or if you are using this to check for possible entry points.

Parameters
part
Returns
void FuelFlowOverlay.RedrawOverlay ( Part  part)
inline

Redraws flow priority texts. Only applicable if you absolutely want no delay on the text update.

Parameters
part
void FuelFlowOverlay.RespawnOverlay ( Part  part)
inline

If the owerlay is already showing, Does the same thing as SpawnOverlay but delayed one frame.

Parameters
part
void FuelFlowOverlay.SpawnOverlay ( Part  part)
inline

Clears and redraws the overlay from the given part.

Parameters
part

Member Data Documentation

GameObject FuelFlowOverlay.gizmoConsumer
GameObject FuelFlowOverlay.gizmoNode
GameObject FuelFlowOverlay.gizmoProvider
GameObject FuelFlowOverlay.gizmoTarget
FuelFlowOverlay FuelFlowOverlay.instance
static
Texture FuelFlowOverlay.lineArrowTexture
Material FuelFlowOverlay.lineMaterial
Texture FuelFlowOverlay.lineTexture

Property Documentation

bool FuelFlowOverlay.IsDisplaying
getset

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