VR-Link API Documentation for DIS
entityStateRepository.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2010 VT MAK
3 ** All rights reserved.
4 *********************************************************************/
5 
6 #ifndef entityStateRepository_H_
7 #define entityStateRepository_H_
8 
11 
12 #include "hostStructs.h"
13 #include "baseEntityStateRepository.h"
14 #include "propulsionSystem.h"
15 #include "vectoringNozzleSystem.h"
16 #include "diGuyObjectStateRepositoryDIS.h"
17 
18 #include <vl/entityTypeVPRecord.h>
19 #include <vl/entityAssociationVPRecord.h>
20 #include <vl/separationVPRecord.h>
21 
22 #include <vlpi/articulatedPartCollection.h>
23 #include <vlpi/attachedPartCollection.h>
24 
25 #include <iosfwd>
26 
27 
39 class DT_DLL_VL DtEntityStateRepository : public DtBaseEntityStateRepository
40 {
41 public:
42 
44  DtEntityStateRepository();
45 
47  virtual ~DtEntityStateRepository();
48 
50  DtEntityStateRepository(const DtEntityStateRepository& orig);
51 
53  DtEntityStateRepository& operator=(const DtEntityStateRepository& orig);
54 
56  virtual DtStateRepository* clone(bool copy = false) const;
57 
59  virtual void setForceId(DtForceType force);
61  virtual DtForceType forceId() const;
62 
64  virtual void setGuise(const DtEntityType& type);
66  virtual const DtEntityType& guise() const;
67 
69  virtual void setFrozen(bool onOff);
71  virtual bool frozen() const;
72 
75  virtual void setMarkingCharSet(int charSet);
78  virtual int markingCharSet() const;
79 
82  virtual void setMarkingText(const char* text);
85  virtual const char* markingText() const;
86 
87 
93 
94 
95  virtual bool powerPlantOn() const;
96 
98  virtual void setPowerPlantOn(bool onOff);
99 
101  virtual void setDamageState(DtDamageState s);
102 
104  virtual DtDamageState damageState() const;
105 
107  virtual void setEngineSmokeOn(bool onOff);
109  virtual bool engineSmokeOn() const;
110 
112  virtual void setFlamesPresent(bool onOff);
114  virtual bool flamesPresent() const;
115 
117  virtual void setHasFuelSupplyCap(bool onOff);
119  virtual bool hasFuelSupplyCap() const;
120 
122  virtual void setHasRecoveryCap(bool onOff);
124  virtual bool hasRecoveryCap() const;
125 
127  virtual void setHasRepairCap(bool onOff);
129  virtual bool hasRepairCap() const;
130 
132  virtual void setHatchState(DtHatchState s);
134  virtual DtHatchState hatchState() const;
135 
137  virtual void setImmobilized(bool onOff);
138 
140  virtual bool immobilized() const;
141 
144  virtual void setLifeformState(DtLifeformState s);
145 
148  virtual DtLifeformState lifeformState() const;
149 
151  virtual void setLightState(DtLightType s, bool onOff);
152 
154  virtual bool lightState(DtLightType s) const;
155 
157 
158 
159  virtual void setLightState(DtLightState s);
160  virtual DtLightState lightState() const;
162 
164 
165  virtual void setDensity(DtDensityType dens);
166  virtual DtDensityType density() const;
168 
170 
171  virtual void setRampDeployed(bool onOff);
172  virtual bool rampDeployed() const;
174 
176 
177  virtual void setSmokePlumePresent(bool onOff);
178  virtual bool smokePlumePresent() const;
180 
182 
183  virtual void setTentDeployed(bool onOff);
184  virtual bool tentDeployed() const;
186 
188 
189  virtual void setTrailState(DtTrailState s);
190  virtual DtTrailState trailState() const;
192 
194 
195  virtual void setCamouflageType(DtCamouflageType type);
196  virtual DtCamouflageType camouflageType() const;
198 
200 
201  virtual void setFirePowerDisabled(bool onOff);
202  virtual bool firePowerDisabled() const;
204 
206 
207  virtual void setIsConcealed(bool onOff);
208  virtual bool isConcealed() const;
210 
212 
213  virtual void setAfterburnerOn(bool onOff);
214  virtual bool afterburnerOn() const;
216 
218 
219  virtual void setHasAmmunitionSupplyCap(bool onOff);
220  virtual bool hasAmmunitionSupplyCap() const;
222 
224 
225  virtual void setLauncherRaised(bool onOff);
226  virtual bool launcherRaised() const;
228 
230 
231  virtual void setLauncherFlashPresent(bool onOff);
232  virtual bool launcherFlashPresent() const;
234 
236 
237  virtual void setPrimaryWeaponState(DtWeaponState s);
238  virtual DtWeaponState primaryWeaponState() const;
240 
242 
243  virtual void setSecondaryWeaponState(DtWeaponState s);
244  virtual DtWeaponState secondaryWeaponState() const;
246 
248 
249  virtual void setComplianceState(DtComplianceState s);
250  virtual DtComplianceState complianceState() const;
252 
254 
255  virtual void setAntennaRaised(bool upDown);
256  virtual bool antennaRaised() const;
258 
260 
261  virtual void setMissionKill(bool yesNo);
262  virtual bool missionKill() const;
264 
266 
267  virtual void setInternalHeatSource(bool onOff);
268  virtual bool internalHeatSource() const;
270 
272  virtual void setMaskedCloaked(bool onOff);
273 
275  virtual bool maskedCloaked() const;
276 
280  virtual void setAppearance(DtU32 app);
284  virtual DtU32 appearance() const;
285 
290  virtual void setAppearanceAttribute(const DtAppearAttribute attr,
291  const DtAppearAttrVal val);
296  virtual DtAppearAttrVal appearanceAttribute(
297  const DtAppearAttribute attr) const;
299 
301  // virtual void initArtParts(const DtArtPartSpec* specList);
302 
304 
305  virtual const DtArticulatedPartCollection* artPartList() const;
306  virtual DtArticulatedPartCollection* artPartList();
308 
310 
311  virtual const DtAttachedPartCollection* attPartList() const;
312  virtual DtAttachedPartCollection* attPartList();
314 
315 
316 #ifdef DtDIS
317 
319 
320 
321 
322  virtual const std::vector<DtVPRecord*>* variableParameterList() const;
323  virtual std::vector<DtVPRecord*>* variableParameterList();
325 
326 #endif
327 
329 
330  virtual void setInfraRedSigRepIndex(DtU16 value);
331  virtual DtU16 infraRedSigRepIndex() const;
333 
335 
336  virtual void setAcousticSigRepIndex(DtU16 value);
337  virtual DtU16 acousticSigRepIndex() const;
339 
341 
342  virtual void setRadarSigRepIndex(DtU16 value);
343  virtual DtU16 radarSigRepIndex() const;
345 
347 
348 
349  void setNumPropulsionSystems(DtU16 value);
350  DtU16 numPropulsionSystems() const;
352 
354 
355 
356  void setNumNozzleSystems(DtU16 value);
357  DtU16 numNozzleSystems() const;
359 
361 
362 
363 
364  bool setPropulsionSystem(int index,
365  const DtPropulsionSystem& record);
366  bool getPropulsionSystem(int index,
367  DtPropulsionSystem& record) const;
369 
371 
372 
373 
374  bool setNozzleSystem(int index,
375  const DtVectoringNozzleSystem& record);
376  bool getNozzleSystem(int index,
377  DtVectoringNozzleSystem& record) const;
379 
381 
382  virtual void setMeasuredSpeed(DtU16 value);
383  virtual DtU16 measuredSpeed() const;
385 
387 
388  virtual void setCapabilities(DtU32 cap);
389  virtual DtU32 capabilities() const;
391 
393  virtual void setClock(DtClock* clock);
394 
395 
396 
398 
399 
401  virtual void setEntityId(const DtEntityIdentifier& id);
402 
404 
405 
406 
407 
408  virtual void setDiGuyStateRepository(DtDIGuyObjectStateRepository* diGuyStateRep);
409  virtual DtDIGuyObjectStateRepository* diGuyStateRepository();
411 
413  virtual void enableDiGuyStateRepository();
414 
417  virtual bool isDiGuyPublisherNeeded() const;
418 
420 
421  virtual void setDiGuyAppearance(const DtString& val);
422  virtual const DtString& diGuyAppearance() const;
424 
426 
427  virtual void setDiGuyArc(const std::vector<char>& val);
428  virtual const std::vector<char>& diGuyArc() const;
430 
432 
433  virtual void setDiGuyParent(const DtEntityIdentifier& val);
434  virtual const DtEntityIdentifier& diGuyParent() const;
436 
438 
439 
440 
441 
442  virtual void setDiGuyType(const DtString& newDiGuyType,
443  const DtString& newDiGuyAppearance );
444  virtual void setDiGuyType(const DtString& val);
445  virtual const DtString& diGuyType() const;
447 
449 
450  virtual void setDiGuyBodyAppearance(const DtString& val);
451  virtual const DtString& diGuyBodyAppearance() const;
453 
455 
456  virtual void setDiGuyHeadAppearance(const DtString& val);
457  virtual const DtString& diGuyHeadAppearance() const;
459 
461 
462  virtual void setDiGuyItemAppearance(const DtString& val);
463  virtual const DtString& diGuyItemAppearance() const;
465 
467 
468  virtual void setDiGuyAccessoryAppearance(const DtString& val);
469  virtual const DtString& diGuyAccessoryAppearance() const;
470 
472 
473  virtual void setDiGuyAction(const DtString& val);
474  virtual const DtString& diGuyAction() const;
475 
477  virtual const DtString& diGuyAction(bool& paused) const;
478 
480  virtual void setDiGuyAction(const DtString& val, bool paused, double speed=0.0);
482 
484 
485  virtual void setDiGuyActionPaused(bool paused);
486  virtual bool isDiGuyActionPaused() const;
488 
490 
491  virtual double diGuyActionSpeed() const;
492  virtual void setDiGuyActionSpeed(double speed);
494 
496 
497  virtual void setDiGuyVisible(bool visibile);
498  virtual bool isDiGuyVisible() const;
500 
502 
503  virtual void addDiGuyShapeVariation(unsigned int linkIndex, unsigned int shapeIndex, const DtDiGuyPixelData& pixelData);
504  virtual void removeDiGuyShapeVariation(unsigned int linkIndex, unsigned int shapeIndex);
505  virtual const DtDiGuyPixelData& diGuyShapeVariation(unsigned int linkIndex, unsigned int shapeIndex, bool& dataIsValid) const;
506  virtual bool getDiGuyShapeVariation(unsigned int linkIndex, unsigned int shapeIndex, DtDiGuyPixelData& pixelData) const;
507  virtual void setDiGuyShapeVariations(const DtDiGuyLinkShapeMap& shapeVariations);
508  virtual const DtDiGuyLinkShapeMap& diGuyShapeVariations() const;
510 
512 
513  virtual const DtVector& diGuyCharacterScale() const;
514  virtual void setDiGuyCharacterScale(const DtVector& scale);
516 
518 
519 public:
520 
522  virtual void printData() const;
523 
525  virtual void printDataToStream(std::ostream &stream) const;
526 
527 public:
528 
529  static DtEntityStateRepository* create();
530 
531 protected:
532 
535  DtEntityStateRepository* self() const;
536 
539  void internalSetMarkingText(const char* text);
540 
542  virtual void createDiGuyStateRep();
543 
544 protected:
545 
546  DtArticulatedPartCollection myArtPartList;
547  DtAttachedPartCollection myAttPartList;
548 
549 #ifdef DtDIS
550  std::vector<DtVPRecord*> myVPRecordCollection;
551 #endif
552 
553  DtForceType myForceId;
554  DtEntityType myGuise;
555  DtU32 myAppearance;
556  int myMarkingCharSet;
559  DtString myMarkingText;
560  DtU32 myCapabilities;
561  DtU16 myLiveEntityMeasuredSpeed;
562 
563  DtU16 myAcousticsSignatureIndex;
564  DtU16 myInfaredSignatureIndex;
565  DtU16 myRadarCrossSectionSignatureIndex;
566 
567  int myNumPropulsionSystemsData;
568  int myNumVectoringNozzleSystemData;
569  DtPropulsionSystem *myPropulsionSystemsDataList;
570  DtVectoringNozzleSystem *myVectoringNozzleSystemDataList;
571 
574  DtString myDiGuyAction;
575  bool myDiGuyActionPaused;
576  DtString myDiGuyAppearance;
577  std::vector<char> myDiGuyArc;
578  DtString myDiGuyType;
579  DtEntityIdentifier myDiGuyParent;
580  DtDIGuyObjectStateRepository* myDiGuyStateRep;
581  bool myUseDiGuyStateRep;
582  bool myIsDiGuyPublisherNeeded;
583 };
584 
585 inline void
586 DtEntityStateRepository::setInfraRedSigRepIndex(DtU16 value)
587 {
588  myInfaredSignatureIndex = value;
589 }
590 
591 inline DtU16
592 DtEntityStateRepository::infraRedSigRepIndex() const
593 {
594  return myInfaredSignatureIndex;
595 }
596 
597 inline void
598 DtEntityStateRepository::setAcousticSigRepIndex(DtU16 value)
599 {
600  myAcousticsSignatureIndex = value;
601 }
602 
603 inline DtU16
604 DtEntityStateRepository::acousticSigRepIndex() const
605 {
606  return myAcousticsSignatureIndex;
607 }
608 
609 inline void
610 DtEntityStateRepository::setRadarSigRepIndex(DtU16 value)
611 {
612  myRadarCrossSectionSignatureIndex = value;
613 }
614 
615 inline DtU16
616 DtEntityStateRepository::radarSigRepIndex() const
617 {
618  return myRadarCrossSectionSignatureIndex;
619 }
620 
621 inline DtForceType DtEntityStateRepository::forceId() const
622 {
623  return myForceId;
624 }
625 
626 inline const DtEntityType& DtEntityStateRepository::guise() const
627 {
628  return myGuise;
629 }
630 
631 inline DtU32 DtEntityStateRepository::appearance() const
632 {
633  return myAppearance;
634 }
635 
636 inline int DtEntityStateRepository::markingCharSet() const
637 {
638  return myMarkingCharSet;
639 }
640 
641 inline const char* DtEntityStateRepository::markingText() const
642 {
643  return myMarkingText.c_str();
644 }
645 
646 inline DtU32 DtEntityStateRepository::capabilities() const
647 {
648  return myCapabilities;
649 }
650 
651 inline void DtEntityStateRepository::setForceId(DtForceType force)
652 {
653  myForceId = force;
654 }
655 
656 inline void DtEntityStateRepository::setGuise(const DtEntityType& type)
657 {
658  myGuise = type;
659 }
660 
661 inline void DtEntityStateRepository::setAppearance(DtU32 app)
662 {
663  myAppearance = app;
664 }
665 
666 inline void DtEntityStateRepository::setMarkingCharSet(int charSet)
667 {
668  myMarkingCharSet = charSet;
669 }
670 
671 inline void DtEntityStateRepository::internalSetMarkingText(const char* a_text)
672 {
673  myMarkingText = a_text;
674 }
675 
676 inline void DtEntityStateRepository::setMarkingText(const char* a_text)
677 {
678  internalSetMarkingText(a_text);
679 }
680 
681 inline void DtEntityStateRepository::setCapabilities(DtU32 cap)
682 {
683  myCapabilities = cap;
684 }
685 
686 inline DtEntityStateRepository* DtEntityStateRepository::self() const
687 {
688  return (DtEntityStateRepository*)this;
689 }
690 
691 inline const DtArticulatedPartCollection* DtEntityStateRepository::artPartList() const
692 {
693  return &myArtPartList;
694 }
695 
696 inline DtArticulatedPartCollection* DtEntityStateRepository::artPartList()
697 {
698  return &myArtPartList;
699 }
700 
701 inline const DtAttachedPartCollection* DtEntityStateRepository::attPartList() const
702 {
703  return &myAttPartList;
704 }
705 
706 inline DtAttachedPartCollection* DtEntityStateRepository::attPartList()
707 {
708  return &myAttPartList;
709 }
710 
711 #ifdef DtDIS
712 
713 inline const std::vector<DtVPRecord*>* DtEntityStateRepository::variableParameterList() const
714 {
715  return &myVPRecordCollection;
716 }
717 
718 inline std::vector<DtVPRecord*>* DtEntityStateRepository::variableParameterList()
719 {
720  return &myVPRecordCollection;
721 }
722 
723 
724 #endif
725 inline void
726 DtEntityStateRepository::setMeasuredSpeed(DtU16 value)
727 {
728  myLiveEntityMeasuredSpeed = value;
729 }
730 
731 inline DtU16
732 DtEntityStateRepository::measuredSpeed() const
733 {
734  return myLiveEntityMeasuredSpeed;
735 }
736 
737 #endif
738 
Document ID: Generated on Wed Oct 23 22:25:48 EDT 2013 from SVN revision 132765
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)