Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
Expansions.Serenity.RobotArmFX.RobotArmScannerFX Class Referenceabstract
Inheritance diagram for Expansions.Serenity.RobotArmFX.RobotArmScannerFX:
IConfigNode Expansions.Serenity.RobotArmFX.RobotArmFXDrill Expansions.Serenity.RobotArmFX.RobotArmFXLaser Expansions.Serenity.RobotArmFX.RobotArmFXSpectrometer

Public Member Functions

virtual void Load (ConfigNode node)
 
abstract void OnEffectStart ()
 Called to set up effects just as animation starts. More...
 
abstract void OnEffectStop ()
 Called to stop effects just as animation ends or if there's an problem and the arm has to retract in the middle of the animation. More...
 
virtual void OnStart (Part part)
 Called to Initialize things when the RobotArm is started. More...
 
abstract void OnUpdate (float animationTime, float distanceFromSurface, Vector3 instrumentTargetPosition)
 Called to update effects as the animation plays. More...
 
 RobotArmScannerFX ()
 Constructor. More...
 
virtual void Save (ConfigNode node)
 

Static Public Member Functions

static RobotArmScannerFX CreateInstanceOfRobotArmScannerFX (string className)
 Creates a new part module adjuster. More...
 

Public Attributes

string className = string.Empty
 Class name of the effect to be instantiated. More...
 
float effectStartTime = 0
 Start time of the effect in the animation timescale. More...
 
float effectStopTime = 1
 Stop time of the effect in the animation timescale. More...
 

Properties

bool IsReady [get, set]
 Is the effect ready to go. More...
 
Part Part [get, set]
 

Constructor & Destructor Documentation

Expansions.Serenity.RobotArmFX.RobotArmScannerFX.RobotArmScannerFX ( )
inline

Constructor.

Member Function Documentation

static RobotArmScannerFX Expansions.Serenity.RobotArmFX.RobotArmScannerFX.CreateInstanceOfRobotArmScannerFX ( string  className)
inlinestatic

Creates a new part module adjuster.

Parameters
classNameClass name of the new module adjuster.
Returns
Returns the new module adjuster.
virtual void Expansions.Serenity.RobotArmFX.RobotArmScannerFX.Load ( ConfigNode  node)
inlinevirtual
abstract void Expansions.Serenity.RobotArmFX.RobotArmScannerFX.OnEffectStart ( )
pure virtual
abstract void Expansions.Serenity.RobotArmFX.RobotArmScannerFX.OnEffectStop ( )
pure virtual

Called to stop effects just as animation ends or if there's an problem and the arm has to retract in the middle of the animation.

Implemented in Expansions.Serenity.RobotArmFX.RobotArmFXDrill, Expansions.Serenity.RobotArmFX.RobotArmFXLaser, and Expansions.Serenity.RobotArmFX.RobotArmFXSpectrometer.

virtual void Expansions.Serenity.RobotArmFX.RobotArmScannerFX.OnStart ( Part  part)
inlinevirtual

Called to Initialize things when the RobotArm is started.

Parameters
partPart that this effect will be played on.

Reimplemented in Expansions.Serenity.RobotArmFX.RobotArmFXDrill, Expansions.Serenity.RobotArmFX.RobotArmFXLaser, and Expansions.Serenity.RobotArmFX.RobotArmFXSpectrometer.

abstract void Expansions.Serenity.RobotArmFX.RobotArmScannerFX.OnUpdate ( float  animationTime,
float  distanceFromSurface,
Vector3  instrumentTargetPosition 
)
pure virtual

Called to update effects as the animation plays.

Parameters
animationTimeTime that has passed for the scan animation.
distanceFromSurfaceDistance that the scanner head will stop at from the surface.
instrumentTargetPositionTarget position that the instrument should be pointing at.

Implemented in Expansions.Serenity.RobotArmFX.RobotArmFXDrill, Expansions.Serenity.RobotArmFX.RobotArmFXLaser, and Expansions.Serenity.RobotArmFX.RobotArmFXSpectrometer.

virtual void Expansions.Serenity.RobotArmFX.RobotArmScannerFX.Save ( ConfigNode  node)
inlinevirtual

Member Data Documentation

string Expansions.Serenity.RobotArmFX.RobotArmScannerFX.className = string.Empty

Class name of the effect to be instantiated.

float Expansions.Serenity.RobotArmFX.RobotArmScannerFX.effectStartTime = 0

Start time of the effect in the animation timescale.

float Expansions.Serenity.RobotArmFX.RobotArmScannerFX.effectStopTime = 1

Stop time of the effect in the animation timescale.

Property Documentation

bool Expansions.Serenity.RobotArmFX.RobotArmScannerFX.IsReady
getset

Is the effect ready to go.

Part Expansions.Serenity.RobotArmFX.RobotArmScannerFX.Part
getset

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