Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Properties | List of all members
IAxisFieldLimits Interface Reference

Interface applied to PartModules so they can expose hard/soft limits for AxisFields to other parts of code More...

Inheritance diagram for IAxisFieldLimits:
Expansions.Serenity.BaseServo Expansions.Serenity.ModuleRoboticRotationServo Expansions.Serenity.ModuleRoboticServoHinge Expansions.Serenity.ModuleRoboticServoPiston Expansions.Serenity.ModuleRoboticServoRotor

Public Member Functions

AxisFieldLimit GetAxisFieldLimit (string fieldName)
 Get an AxisFieldLimit for a specific axisField More...
 
List< AxisFieldLimitGetAxisFieldLimits ()
 Get the list of AxisFieldLimit for AxisFields with hard/soft limits More...
 
Vector2 GetHardLimits (string fieldName)
 Get the HardLimits for the named field More...
 
Vector2 GetSoftLimits (string fieldName)
 Get the SoftLimits for the named field More...
 
bool HasAxisFieldLimit (string fieldName)
 Does this partmodule have an AxisField of this name with hard/soft limits More...
 
bool HasAxisFieldLimits ()
 Does this partmodule have any AxisFields with hard/soft limits More...
 
void SetHardLimits (string fieldName, Vector2 newLimits)
 Set the HardLimits for the named field More...
 
void SetSoftLimits (string fieldName, Vector2 newLimits)
 set the HardLimits for the named field More...
 

Properties

Callback< AxisFieldLimitLimitsChanged [get, set]
 Callback function that should be triggered when an AxisField Limit changes More...
 

Detailed Description

Interface applied to PartModules so they can expose hard/soft limits for AxisFields to other parts of code

Member Function Documentation

AxisFieldLimit IAxisFieldLimits.GetAxisFieldLimit ( string  fieldName)

Get an AxisFieldLimit for a specific axisField

Returns
Should return null if no limited field by that name

Implemented in Expansions.Serenity.BaseServo.

List<AxisFieldLimit> IAxisFieldLimits.GetAxisFieldLimits ( )

Get the list of AxisFieldLimit for AxisFields with hard/soft limits

Implemented in Expansions.Serenity.BaseServo.

Vector2 IAxisFieldLimits.GetHardLimits ( string  fieldName)

Get the HardLimits for the named field

Returns
Should return null if no limited field by that name

Implemented in Expansions.Serenity.BaseServo.

Vector2 IAxisFieldLimits.GetSoftLimits ( string  fieldName)

Get the SoftLimits for the named field

Returns
Should return null if no limited field by that name

Implemented in Expansions.Serenity.BaseServo.

bool IAxisFieldLimits.HasAxisFieldLimit ( string  fieldName)

Does this partmodule have an AxisField of this name with hard/soft limits

Implemented in Expansions.Serenity.BaseServo.

bool IAxisFieldLimits.HasAxisFieldLimits ( )

Does this partmodule have any AxisFields with hard/soft limits

Implemented in Expansions.Serenity.BaseServo.

void IAxisFieldLimits.SetHardLimits ( string  fieldName,
Vector2  newLimits 
)

Set the HardLimits for the named field

Implemented in Expansions.Serenity.BaseServo.

void IAxisFieldLimits.SetSoftLimits ( string  fieldName,
Vector2  newLimits 
)

set the HardLimits for the named field

Implemented in Expansions.Serenity.BaseServo.

Property Documentation

Callback<AxisFieldLimit> IAxisFieldLimits.LimitsChanged
getset

Callback function that should be triggered when an AxisField Limit changes


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