VR-Link API Documentation for HLA Evolved
entitySR.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1992-2010 VT MAK
3 ** All rights reserved.
4 *********************************************************************/
5 
6 #ifndef entitySR_H_
7 #define entitySR_H_
8 
11 
12 #include "hostStructs.h"
13 #include "baseEntitySR.h"
14 #include "supEmisEsProp.h"
15 #include "supEmisEsNozz.h"
16 #include "dIGuyObjectSR.h"
17 
18 #include <vlpi/articulatedPartCollection.h>
19 #include <vlpi/attachedPartCollection.h>
20 
21 #include <iosfwd>
22 
23 
35 class DT_DLL_VL DtEntityStateRepository : public DtBaseEntityStateRepository
36 {
37 public:
38 
40  DtEntityStateRepository();
41 
43  virtual ~DtEntityStateRepository();
44 
46  DtEntityStateRepository(const DtEntityStateRepository& orig);
47 
49  DtEntityStateRepository& operator=(const DtEntityStateRepository& orig);
50 
52  virtual DtStateRepository* clone(bool copy = false) const;
53 
55  virtual void setForceId(DtForceType force);
57  virtual DtForceType forceId() const;
58 
60  virtual void setGuise(const DtEntityType& type);
62  virtual const DtEntityType& guise() const;
63 
65  virtual void setFrozen(bool onOff);
67  virtual bool frozen() const;
68 
71  virtual void setMarkingCharSet(int charSet);
74  virtual int markingCharSet() const;
75 
78  virtual void setMarkingText(const char* text);
81  virtual const char* markingText() const;
82 
83 
89 
90 
91  virtual bool powerPlantOn() const;
92 
94  virtual void setPowerPlantOn(bool onOff);
95 
97  virtual void setDamageState(DtDamageState s);
98 
100  virtual DtDamageState damageState() const;
101 
103  virtual void setEngineSmokeOn(bool onOff);
105  virtual bool engineSmokeOn() const;
106 
108  virtual void setFlamesPresent(bool onOff);
110  virtual bool flamesPresent() const;
111 
113  virtual void setHasFuelSupplyCap(bool onOff);
115  virtual bool hasFuelSupplyCap() const;
116 
118  virtual void setHasRecoveryCap(bool onOff);
120  virtual bool hasRecoveryCap() const;
121 
123  virtual void setHasRepairCap(bool onOff);
125  virtual bool hasRepairCap() const;
126 
128  virtual void setHatchState(DtHatchState s);
130  virtual DtHatchState hatchState() const;
131 
133  virtual void setImmobilized(bool onOff);
134 
136  virtual bool immobilized() const;
137 
140  virtual void setLifeformState(DtLifeformState s);
141 
144  virtual DtLifeformState lifeformState() const;
145 
147  virtual void setLightState(DtLightType s, bool onOff);
148 
150  virtual bool lightState(DtLightType s) const;
151 
153 
154 
155  virtual void setLightState(DtLightState s);
156  virtual DtLightState lightState() const;
158 
160 
161  virtual void setDensity(DtDensityType dens);
162  virtual DtDensityType density() const;
164 
166 
167  virtual void setRampDeployed(bool onOff);
168  virtual bool rampDeployed() const;
170 
172 
173  virtual void setSmokePlumePresent(bool onOff);
174  virtual bool smokePlumePresent() const;
176 
178 
179  virtual void setTentDeployed(bool onOff);
180  virtual bool tentDeployed() const;
182 
184 
185  virtual void setTrailState(DtTrailState s);
186  virtual DtTrailState trailState() const;
188 
190 
191  virtual void setCamouflageType(DtCamouflageType type);
192  virtual DtCamouflageType camouflageType() const;
194 
196 
197  virtual void setFirePowerDisabled(bool onOff);
198  virtual bool firePowerDisabled() const;
200 
202 
203  virtual void setIsConcealed(bool onOff);
204  virtual bool isConcealed() const;
206 
208 
209  virtual void setAfterburnerOn(bool onOff);
210  virtual bool afterburnerOn() const;
212 
214 
215  virtual void setHasAmmunitionSupplyCap(bool onOff);
216  virtual bool hasAmmunitionSupplyCap() const;
218 
220 
221  virtual void setLauncherRaised(bool onOff);
222  virtual bool launcherRaised() const;
224 
226 
227  virtual void setLauncherFlashPresent(bool onOff);
228  virtual bool launcherFlashPresent() const;
230 
232 
233  virtual void setPrimaryWeaponState(DtWeaponState s);
234  virtual DtWeaponState primaryWeaponState() const;
236 
238 
239  virtual void setSecondaryWeaponState(DtWeaponState s);
240  virtual DtWeaponState secondaryWeaponState() const;
242 
244 
245  virtual void setComplianceState(DtComplianceState s);
246  virtual DtComplianceState complianceState() const;
248 
250 
251  virtual void setAntennaRaised(bool upDown);
252  virtual bool antennaRaised() const;
254 
256 
257  virtual void setMissionKill(bool yesNo);
258  virtual bool missionKill() const;
260 
262 
263  virtual void setInternalHeatSource(bool onOff);
264  virtual bool internalHeatSource() const;
266 
268  virtual void setMaskedCloaked(bool onOff);
269 
271  virtual bool maskedCloaked() const;
272 
276  virtual void setAppearance(DtU32 app);
280  virtual DtU32 appearance() const;
281 
286  virtual void setAppearanceAttribute(const DtAppearAttribute attr,
287  const DtAppearAttrVal val);
292  virtual DtAppearAttrVal appearanceAttribute(
293  const DtAppearAttribute attr) const;
295 
297  // virtual void initArtParts(const DtArtPartSpec* specList);
298 
300 
301  virtual const DtArticulatedPartCollection* artPartList() const;
302  virtual DtArticulatedPartCollection* artPartList();
304 
306 
307  virtual const DtAttachedPartCollection* attPartList() const;
308  virtual DtAttachedPartCollection* attPartList();
310 
312 
313  virtual void setInfraRedSigRepIndex(DtU16 value);
314  virtual DtU16 infraRedSigRepIndex() const;
316 
318 
319  virtual void setAcousticSigRepIndex(DtU16 value);
320  virtual DtU16 acousticSigRepIndex() const;
322 
324 
325  virtual void setRadarSigRepIndex(DtU16 value);
326  virtual DtU16 radarSigRepIndex() const;
328 
330 
331 
332  void setNumPropulsionSystems(DtU16 value);
333  DtU16 numPropulsionSystems() const;
335 
337 
338 
339  void setNumNozzleSystems(DtU16 value);
340  DtU16 numNozzleSystems() const;
342 
344 
345 
346 
347  bool setPropulsionSystem(int index,
348  const DtPropulsionSystem& record);
349  bool getPropulsionSystem(int index,
350  DtPropulsionSystem& record) const;
352 
354 
355 
356 
357  bool setNozzleSystem(int index,
358  const DtVectoringNozzleSystem& record);
359  bool getNozzleSystem(int index,
360  DtVectoringNozzleSystem& record) const;
362 
364 
365  virtual void setMeasuredSpeed(DtU16 value);
366  virtual DtU16 measuredSpeed() const;
368 
370 
371  virtual void setCapabilities(DtU32 cap);
372  virtual DtU32 capabilities() const;
374 
376  virtual void setClock(DtClock* clock);
377 
378 
379 
381 
382 
384  virtual void setEntityId(const DtEntityIdentifier& id);
385 
387 
388 
389 
390 
391  virtual void setDiGuyStateRepository(DtDIGuyObjectStateRepository* diGuyStateRep);
392  virtual DtDIGuyObjectStateRepository* diGuyStateRepository();
394 
396  virtual void enableDiGuyStateRepository();
397 
400  virtual bool isDiGuyPublisherNeeded() const;
401 
403 
404  virtual void setDiGuyAppearance(const DtString& val);
405  virtual const DtString& diGuyAppearance() const;
407 
409 
410  virtual void setDiGuyArc(const std::vector<char>& val);
411  virtual const std::vector<char>& diGuyArc() const;
413 
415 
416  virtual void setDiGuyParent(const DtEntityIdentifier& val);
417  virtual const DtEntityIdentifier& diGuyParent() const;
419 
421 
422 
423 
424 
425  virtual void setDiGuyType(const DtString& newDiGuyType,
426  const DtString& newDiGuyAppearance );
427  virtual void setDiGuyType(const DtString& val);
428  virtual const DtString& diGuyType() const;
430 
432 
433  virtual void setDiGuyBodyAppearance(const DtString& val);
434  virtual const DtString& diGuyBodyAppearance() const;
436 
438 
439  virtual void setDiGuyHeadAppearance(const DtString& val);
440  virtual const DtString& diGuyHeadAppearance() const;
442 
444 
445  virtual void setDiGuyItemAppearance(const DtString& val);
446  virtual const DtString& diGuyItemAppearance() const;
448 
450 
451  virtual void setDiGuyAccessoryAppearance(const DtString& val);
452  virtual const DtString& diGuyAccessoryAppearance() const;
453 
455 
456  virtual void setDiGuyAction(const DtString& val);
457  virtual const DtString& diGuyAction() const;
458 
460  virtual const DtString& diGuyAction(bool& paused) const;
461 
463  virtual void setDiGuyAction(const DtString& val, bool paused, double speed=0.0);
465 
467 
468  virtual void setDiGuyActionPaused(bool paused);
469  virtual bool isDiGuyActionPaused() const;
471 
473 
474  virtual double diGuyActionSpeed() const;
475  virtual void setDiGuyActionSpeed(double speed);
477 
479 
480  virtual void setDiGuyVisible(bool visibile);
481  virtual bool isDiGuyVisible() const;
483 
485 
486  virtual void addDiGuyShapeVariation(unsigned int linkIndex, unsigned int shapeIndex, const DtDiGuyPixelData& pixelData);
487  virtual void removeDiGuyShapeVariation(unsigned int linkIndex, unsigned int shapeIndex);
488  virtual const DtDiGuyPixelData& diGuyShapeVariation(unsigned int linkIndex, unsigned int shapeIndex, bool& dataIsValid) const;
489  virtual bool getDiGuyShapeVariation(unsigned int linkIndex, unsigned int shapeIndex, DtDiGuyPixelData& pixelData) const;
490  virtual void setDiGuyShapeVariations(const DtDiGuyLinkShapeMap& shapeVariations);
491  virtual const DtDiGuyLinkShapeMap& diGuyShapeVariations() const;
493 
495 
496  virtual const DtVector& diGuyCharacterScale() const;
497  virtual void setDiGuyCharacterScale(const DtVector& scale);
499 
501 
502 public:
503 
505  virtual void printData() const;
506 
508  virtual void printDataToStream(std::ostream &stream) const;
509 
510 public:
511 
512  static DtEntityStateRepository* create();
513 
514 protected:
515 
518  DtEntityStateRepository* self() const;
519 
522  void internalSetMarkingText(const char* text);
523 
525  virtual void createDiGuyStateRep();
526 
527 protected:
528 
529  DtArticulatedPartCollection myArtPartList;
530  DtAttachedPartCollection myAttPartList;
531 
532  DtForceType myForceId;
533  DtEntityType myGuise;
534  DtU32 myAppearance;
535  int myMarkingCharSet;
538  DtString myMarkingText;
539  DtU32 myCapabilities;
540  DtU16 myLiveEntityMeasuredSpeed;
541 
542  DtU16 myAcousticsSignatureIndex;
543  DtU16 myInfaredSignatureIndex;
544  DtU16 myRadarCrossSectionSignatureIndex;
545 
546  int myNumPropulsionSystemsData;
547  int myNumVectoringNozzleSystemData;
548  DtPropulsionSystem *myPropulsionSystemsDataList;
549  DtVectoringNozzleSystem *myVectoringNozzleSystemDataList;
550 
553  DtString myDiGuyAction;
554  bool myDiGuyActionPaused;
555  DtString myDiGuyAppearance;
556  std::vector<char> myDiGuyArc;
557  DtString myDiGuyType;
558  DtEntityIdentifier myDiGuyParent;
559  DtDIGuyObjectStateRepository* myDiGuyStateRep;
560  bool myUseDiGuyStateRep;
561  bool myIsDiGuyPublisherNeeded;
562 };
563 
564 inline void
565 DtEntityStateRepository::setInfraRedSigRepIndex(DtU16 value)
566 {
567  myInfaredSignatureIndex = value;
568 }
569 
570 inline DtU16
571 DtEntityStateRepository::infraRedSigRepIndex() const
572 {
573  return myInfaredSignatureIndex;
574 }
575 
576 inline void
577 DtEntityStateRepository::setAcousticSigRepIndex(DtU16 value)
578 {
579  myAcousticsSignatureIndex = value;
580 }
581 
582 inline DtU16
583 DtEntityStateRepository::acousticSigRepIndex() const
584 {
585  return myAcousticsSignatureIndex;
586 }
587 
588 inline void
589 DtEntityStateRepository::setRadarSigRepIndex(DtU16 value)
590 {
591  myRadarCrossSectionSignatureIndex = value;
592 }
593 
594 inline DtU16
595 DtEntityStateRepository::radarSigRepIndex() const
596 {
597  return myRadarCrossSectionSignatureIndex;
598 }
599 
600 inline DtForceType DtEntityStateRepository::forceId() const
601 {
602  return myForceId;
603 }
604 
605 inline const DtEntityType& DtEntityStateRepository::guise() const
606 {
607  return myGuise;
608 }
609 
610 inline DtU32 DtEntityStateRepository::appearance() const
611 {
612  return myAppearance;
613 }
614 
615 inline int DtEntityStateRepository::markingCharSet() const
616 {
617  return myMarkingCharSet;
618 }
619 
620 inline const char* DtEntityStateRepository::markingText() const
621 {
622  return myMarkingText.c_str();
623 }
624 
625 inline DtU32 DtEntityStateRepository::capabilities() const
626 {
627  return myCapabilities;
628 }
629 
630 inline void DtEntityStateRepository::setForceId(DtForceType force)
631 {
632  myForceId = force;
633 }
634 
635 inline void DtEntityStateRepository::setGuise(const DtEntityType& type)
636 {
637  myGuise = type;
638 }
639 
640 inline void DtEntityStateRepository::setAppearance(DtU32 app)
641 {
642  myAppearance = app;
643 }
644 
645 inline void DtEntityStateRepository::setMarkingCharSet(int charSet)
646 {
647  myMarkingCharSet = charSet;
648 }
649 
650 inline void DtEntityStateRepository::internalSetMarkingText(const char* a_text)
651 {
652  myMarkingText = a_text;
653 }
654 
655 inline void DtEntityStateRepository::setMarkingText(const char* a_text)
656 {
657  internalSetMarkingText(a_text);
658 }
659 
660 inline void DtEntityStateRepository::setCapabilities(DtU32 cap)
661 {
662  myCapabilities = cap;
663 }
664 
665 inline DtEntityStateRepository* DtEntityStateRepository::self() const
666 {
667  return (DtEntityStateRepository*)this;
668 }
669 
670 inline const DtArticulatedPartCollection* DtEntityStateRepository::artPartList() const
671 {
672  return &myArtPartList;
673 }
674 
675 inline DtArticulatedPartCollection* DtEntityStateRepository::artPartList()
676 {
677  return &myArtPartList;
678 }
679 
680 inline const DtAttachedPartCollection* DtEntityStateRepository::attPartList() const
681 {
682  return &myAttPartList;
683 }
684 
685 inline DtAttachedPartCollection* DtEntityStateRepository::attPartList()
686 {
687  return &myAttPartList;
688 }
689 
690 inline void
691 DtEntityStateRepository::setMeasuredSpeed(DtU16 value)
692 {
693  myLiveEntityMeasuredSpeed = value;
694 }
695 
696 inline DtU16
697 DtEntityStateRepository::measuredSpeed() const
698 {
699  return myLiveEntityMeasuredSpeed;
700 }
701 
702 #endif
703 
Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)