16
0
mirror of https://github.com/MaSzyna-EU07/maszyna.git synced 2026-07-22 06:59:18 +02:00

AirCoupler - comments update.

This commit is contained in:
Kamil Lewan
2017-10-27 11:05:17 +02:00
parent 899381ae32
commit a4c30a4837
2 changed files with 22 additions and 23 deletions

View File

@@ -19,10 +19,10 @@ AirCoupler::~AirCoupler()
{ {
} }
// zwraca 1, jeśli istnieje model prosty, 2 gdy skośny
/** /**
* Returns 0 when straight model exists, * \return 1 when \(straight\) TModel3d \c ModelOn exists
* 2 when oblique model exists, and 0 when neither of them exist. * \return 2 when \(slanted\) TModel3d \c ModelxOn exists
* \return 0 when neither of them exist
*/ */
int AirCoupler::GetStatus() int AirCoupler::GetStatus()
{ {
@@ -31,9 +31,8 @@ int AirCoupler::GetStatus()
return 0; return 0;
} }
// zerowanie wskaźników
/** /**
* Reset pointers. * Reset pointers and variables.
*/ */
void AirCoupler::Clear() void AirCoupler::Clear()
{ {
@@ -43,25 +42,23 @@ void AirCoupler::Clear()
On = false; On = false;
xOn = false; xOn = false;
} }
// wyszukanie submodeli
/** /**
* Looks for submodels. * Looks for submodels in the model and updates pointers.
*/ */
void AirCoupler::Init(std::string const &asName, TModel3d *Model) void AirCoupler::Init(std::string const &asName, TModel3d *Model)
{ {
if (!Model) if (!Model)
return; // nie ma w czym szukać return;
// polaczony na wprost ModelOn = Model->GetFromName(asName + "_on"); // Straight connect.
/** Straight connect. */ ModelOff = Model->GetFromName(asName + "_off"); // Not connected. Hung up.
ModelOn = Model->GetFromName(asName + "_on"); ModelxOn = Model->GetFromName(asName + "_xon"); // Slanted connect.
// odwieszony
/** Not connected. Hung up. */
ModelOff = Model->GetFromName(asName + "_off");
// polaczony na skos
/** Oblique connect. */
ModelxOn = Model->GetFromName(asName + "_xon");
} }
/**
* Gets name of submodel \(from cParser \b *Parser\),
* looks for it in the TModel3d \b *Model and update pointers.
* If submodel is not found, reset pointers.
*/
void AirCoupler::Load(cParser *Parser, TModel3d *Model) void AirCoupler::Load(cParser *Parser, TModel3d *Model)
{ {
std::string name = Parser->getToken<std::string>(); std::string name = Parser->getToken<std::string>();
@@ -77,6 +74,7 @@ void AirCoupler::Load(cParser *Parser, TModel3d *Model)
} }
} }
// Update submodels visibility.
void AirCoupler::Update() void AirCoupler::Update()
{ {
if (ModelOn) if (ModelOn)

View File

@@ -15,7 +15,6 @@ http://mozilla.org/MPL/2.0/.
class AirCoupler class AirCoupler
{ {
private: private:
// TButtonType eType;
TSubModel *ModelOn, *ModelOff, *ModelxOn; TSubModel *ModelOn, *ModelOff, *ModelxOn;
bool On; bool On;
bool xOn; bool xOn;
@@ -24,24 +23,26 @@ private:
public: public:
AirCoupler(); AirCoupler();
~AirCoupler(); ~AirCoupler();
///Reset members.
void Clear(); void Clear();
///Looks for submodels.
void Init(std::string const &asName, TModel3d *Model); void Init(std::string const &asName, TModel3d *Model);
///Loads info about coupler.
void Load(cParser *Parser, TModel3d *Model); void Load(cParser *Parser, TModel3d *Model);
int GetStatus(); int GetStatus();
inline void TurnOn() inline void TurnOn() ///Turns on straight coupler.
{ {
On = true; On = true;
xOn = false; xOn = false;
Update(); Update();
}; };
inline void TurnOff() inline void TurnOff() ///Turns on disconnected coupler.
{ {
On = false; On = false;
xOn = false; xOn = false;
Update(); Update();
}; };
inline void TurnxOn() inline void TurnxOn() ///Turns on slanted coupler.
{ {
On = false; On = false;
xOn = true; xOn = true;