VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
entityStateRepository.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2014 VT MAK
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
12 #include <vl/baseEntityStateRepository.h>
13 #include <vl/diGuyObjectStateRepository.h>
14 #include <vl/entityAssociationVPRecord.h>
15 #include <vl/vectoringNozzleSystem.h>
16 #include <vl/entityTypeVPRecord.h>
17 #include <vl/separationVPRecord.h>
18 #include <vl/propulsionSystem.h>
19 
20 #include <vlpi/articulatedPartCollection.h>
21 #include <vlpi/attachedPartCollection.h>
22 
23 #include <iosfwd>
24 
36 class DT_DLL_VL DtEntityStateRepository : public DtBaseEntityStateRepository
37 {
38 public:
39 
41  static DtEntityStateRepository* create();
42 
44  DtEntityStateRepository();
45 
47  DtEntityStateRepository( const DtEntityStateRepository& orig );
48 
50  virtual ~DtEntityStateRepository();
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 setMarkingCharSet( int charSet );
71  virtual int markingCharSet() const;
72 
76  virtual void setMarkingText( const char* text );
80  virtual const char* markingText() const;
81 
87 
90  virtual void setAppearance( DtU32 app );
93  virtual DtU32 appearance() const;
94 
98  virtual void setAppearanceAttribute( const DtAppearAttribute attr,
99  const DtAppearAttrVal val );
103  virtual DtAppearAttrVal appearanceAttribute( const DtAppearAttribute attr ) const;
104 
106  virtual void setFrozen( bool onOff );
108  virtual bool frozen() const;
109 
111  virtual void setPowerPlantOn( bool onOff );
113  virtual bool powerPlantOn() const;
114 
116  virtual void setDamageState( DtDamageState s );
118  virtual DtDamageState damageState() const;
119 
121  virtual void setEngineSmokeOn( bool onOff );
123  virtual bool engineSmokeOn() const;
124 
126  virtual void setFlamesPresent( bool onOff );
128  virtual bool flamesPresent() const;
129 
131  virtual void setHasFuelSupplyCap( bool onOff );
133  virtual bool hasFuelSupplyCap() const;
134 
136  virtual void setHasRecoveryCap( bool onOff );
138  virtual bool hasRecoveryCap() const;
139 
141  virtual void setHasRepairCap( bool onOff );
143  virtual bool hasRepairCap() const;
144 
146  virtual void setHatchState( DtHatchState s );
148  virtual DtHatchState hatchState() const;
149 
151  virtual void setImmobilized( bool onOff );
153  virtual bool immobilized() const;
154 
157  virtual void setLifeformState( DtLifeformState s );
160  virtual DtLifeformState lifeformState() const;
161 
163  virtual void setLightState( DtLightType s, bool onOff );
165  virtual bool lightState( DtLightType s ) const;
166 
169  virtual void setLightState( DtLightState s );
172  virtual DtLightState lightState() const;
173 
175  virtual void setDensity( DtDensityType dens );
177  virtual DtDensityType density() const;
178 
180  virtual void setRampDeployed( bool onOff );
182  virtual bool rampDeployed() const;
183 
185  virtual void setSmokePlumePresent( bool onOff );
187  virtual bool smokePlumePresent() const;
188 
190  virtual void setTentDeployed( bool onOff );
192  virtual bool tentDeployed() const;
193 
195  virtual void setTrailState( DtTrailState s );
197  virtual DtTrailState trailState() const;
198 
200  virtual void setCamouflageType( DtCamouflageType type );
202  virtual DtCamouflageType camouflageType() const;
203 
205  virtual void setFirePowerDisabled( bool onOff );
207  virtual bool firePowerDisabled() const;
208 
210  virtual void setIsConcealed( bool onOff );
212  virtual bool isConcealed() const;
213 
215  virtual void setAfterburnerOn( bool onOff );
217  virtual bool afterburnerOn() const;
218 
220  virtual void setHasAmmunitionSupplyCap( bool onOff );
222  virtual bool hasAmmunitionSupplyCap() const;
223 
225  virtual void setLauncherRaised( bool onOff );
227  virtual bool launcherRaised() const;
228 
230  virtual void setLauncherFlashPresent( bool onOff );
232  virtual bool launcherFlashPresent() const;
233 
235  virtual void setPrimaryWeaponState( DtWeaponState s );
237  virtual DtWeaponState primaryWeaponState() const;
238 
240  virtual void setSecondaryWeaponState( DtWeaponState s );
242  virtual DtWeaponState secondaryWeaponState() const;
243 
245  virtual void setComplianceState( DtComplianceState s );
247  virtual DtComplianceState complianceState() const;
248 
250  virtual void setAntennaRaised( bool upDown );
252  virtual bool antennaRaised() const;
253 
255  virtual void setMissionKill( bool yesNo );
257  virtual bool missionKill() const;
258 
260  virtual void setInternalHeatSource( bool onOff );
262  virtual bool internalHeatSource() const;
263 
265  virtual void setMaskedCloaked( bool onOff );
267  virtual bool maskedCloaked() const;
268 
270 
273 
274  virtual const DtArticulatedPartCollection* artPartList() const;
275  virtual DtArticulatedPartCollection* artPartList();
276 
278 
281 
282  virtual const DtAttachedPartCollection* attPartList() const;
283  virtual DtAttachedPartCollection* attPartList();
284 
286 
287 #ifdef DtDIS
288 
293 
294  virtual const std::vector<DtVPRecord*>* variableParameterList() const;
295  virtual std::vector<DtVPRecord*>* variableParameterList();
296 
298 
299 #endif
300 
302  virtual void setInfraRedSigRepIndex( DtU16 value );
304  virtual DtU16 infraRedSigRepIndex() const;
305 
307  virtual void setAcousticSigRepIndex( DtU16 value );
309  virtual DtU16 acousticSigRepIndex() const;
310 
312  virtual void setRadarSigRepIndex( DtU16 value );
314  virtual DtU16 radarSigRepIndex() const;
315 
317  virtual void setCapabilities( DtU32 cap );
319  virtual DtU32 capabilities() const;
320 
322  virtual void setMeasuredSpeed( DtU16 value );
324  virtual DtU16 measuredSpeed() const;
325 
327  void setNumPropulsionSystems( DtU16 value );
329  DtU16 numPropulsionSystems() const;
330 
332  void setNumNozzleSystems( DtU16 value );
334  DtU16 numNozzleSystems() const;
335 
338  bool setPropulsionSystem( int index, const DtPropulsionSystem& record );
341  bool getPropulsionSystem( int index, DtPropulsionSystem& record ) const;
342 
345  bool setNozzleSystem( int index, const DtVectoringNozzleSystem& record );
348  bool getNozzleSystem( int index, DtVectoringNozzleSystem& record ) const;
349 
351  virtual void setClock( DtClock* clock );
352 
357 
360  virtual void setEntityId( const DtEntityIdentifier& id );
361 
364  virtual void setDiGuyStateRepository( DtDIGuyObjectStateRepository* diGuyStateRep );
366  virtual DtDIGuyObjectStateRepository* diGuyStateRepository();
367 
370  virtual void enableDiGuyObject(bool enable = true);
371 
374  virtual bool isEnabledDiGuyObject();
375 
377  virtual void setDiGuyAppearance( const DtString& val );
379  virtual const DtString& diGuyAppearance() const;
380 
382  virtual void setDiGuyArc( const std::vector<char>& val );
384  virtual const std::vector<char>& diGuyArc() const;
385 
387  virtual void setDiGuyParent( const DtEntityIdentifier& val );
389  virtual const DtEntityIdentifier& diGuyParent() const;
390 
395  virtual void setDiGuyType( const DtString& newDiGuyType,
396  const DtString& newDiGuyAppearance );
397  virtual void setDiGuyType( const DtString& val );
399  virtual const DtString& diGuyType() const;
400 
402  virtual void setDiGuyBodyAppearance( const DtString& val );
404  virtual const DtString& diGuyBodyAppearance() const;
405 
407  virtual void setDiGuyHeadAppearance( const DtString& val );
409  virtual const DtString& diGuyHeadAppearance() const;
410 
412  virtual void setDiGuyItemAppearance( const DtString& val );
414  virtual const DtString& diGuyItemAppearance() const;
415 
418  virtual bool setDiGuyAccessoryAppearance( unsigned int index, const DtString& val );
420  virtual const DtString& diGuyAccessoryAppearance( unsigned int index ) const;
421 
423  virtual void setDiGuyAccessoryAppearanceCount( unsigned int index );
425  virtual unsigned int diGuyAccessoryAppearanceCount() const;
426 
428  virtual void setDiGuyAction( const DtString& val );
430  virtual void setDiGuyAction( const DtString& val, bool paused,
431  double speed = 0.0 );
433  virtual const DtString& diGuyAction() const;
435  virtual const DtString& diGuyAction( bool& paused ) const;
436 
438  virtual void setDiGuyActionPaused( bool paused );
440  virtual bool isDiGuyActionPaused() const;
441 
443  virtual void setDiGuyActionSpeed( double speed );
445  virtual double diGuyActionSpeed() const;
446 
448  virtual void setDiGuyVisible( bool visibile );
450  virtual bool isDiGuyVisible() const;
451 
453  virtual void setDiGuyCharacterScale( const DtVector& scale );
455  virtual const DtVector& diGuyCharacterScale() const;
456 
460 
461  virtual void addDiGuyShapeVariation( unsigned int linkIndex, unsigned int shapeIndex, const DtDiGuyPixelData& pixelData );
462  virtual void removeDiGuyShapeVariation( unsigned int linkIndex, unsigned int shapeIndex );
463  virtual const DtDiGuyPixelData& diGuyShapeVariation( unsigned int linkIndex, unsigned int shapeIndex, bool& dataIsValid ) const;
464  virtual bool getDiGuyShapeVariation( unsigned int linkIndex, unsigned int shapeIndex, DtDiGuyPixelData& pixelData ) const;
465  virtual void setDiGuyShapeVariations( const DtDiGuyLinkShapeMap& shapeVariations );
466  virtual const DtDiGuyLinkShapeMap& diGuyShapeVariations() const;
467 
469 
471 
473  virtual void printData() const;
474 
476  virtual void printDataToStream( std::ostream& stream ) const;
477 
478 protected:
479 
482  DtEntityStateRepository* self() const;
483 
486  void internalSetMarkingText( const char* text );
487 
489  virtual void createDiGuyStateRep();
490 
491 protected:
492 
493  DtArticulatedPartCollection myArtPartList;
494  DtAttachedPartCollection myAttPartList;
495 
496 #ifdef DtDIS
497  std::vector<DtVPRecord*> myVPRecordCollection;
498 #endif
499 
500  DtForceType myForceId;
501  DtEntityType myGuise;
502  DtU32 myAppearance;
504  int myMarkingCharSet;
507  DtString myMarkingText;
508  DtU32 myCapabilities;
509  DtU16 myLiveEntityMeasuredSpeed;
510 
511  DtU16 myAcousticsSignatureIndex;
512  DtU16 myInfaredSignatureIndex;
513  DtU16 myRadarCrossSectionSignatureIndex;
514 
515  int myNumPropulsionSystemsData;
516  int myNumVectoringNozzleSystemData;
517  DtPropulsionSystem *myPropulsionSystemsDataList;
518  DtVectoringNozzleSystem *myVectoringNozzleSystemDataList;
519 
522  std::vector<char> myDiGuyArc;
523  DtEntityIdentifier myDiGuyParent;
524  DtDIGuyObjectStateRepository* myDiGuyStateRep;
525  bool myUseDiGuyObject;
526 
527 };
528 
529 
530 inline void DtEntityStateRepository::setForceId( DtForceType force )
531 {
532  myForceId = force;
533 }
534 
535 inline DtForceType DtEntityStateRepository::forceId() const
536 {
537  return myForceId;
538 }
539 
540 inline void DtEntityStateRepository::setGuise( const DtEntityType& type )
541 {
542  myGuise = type;
543 }
544 
545 inline const DtEntityType& DtEntityStateRepository::guise() const
546 {
547  return myGuise;
548 }
549 
550 inline void DtEntityStateRepository::setMarkingCharSet( int charSet )
551 {
552  myMarkingCharSet = charSet;
553 }
554 
555 inline int DtEntityStateRepository::markingCharSet() const
556 {
557  return myMarkingCharSet;
558 }
559 
560 inline void DtEntityStateRepository::setMarkingText( const char* a_text )
561 {
562  internalSetMarkingText( a_text );
563 }
564 
565 inline const char* DtEntityStateRepository::markingText() const
566 {
567  return myMarkingText.c_str();
568 }
569 
570 inline const DtArticulatedPartCollection* DtEntityStateRepository::artPartList() const
571 {
572  return &myArtPartList;
573 }
574 
575 inline DtArticulatedPartCollection* DtEntityStateRepository::artPartList()
576 {
577  return &myArtPartList;
578 }
579 
580 inline const DtAttachedPartCollection* DtEntityStateRepository::attPartList() const
581 {
582  return &myAttPartList;
583 }
584 
585 inline DtAttachedPartCollection* DtEntityStateRepository::attPartList()
586 {
587  return &myAttPartList;
588 }
589 
590 #ifdef DtDIS
591 
592 inline const std::vector<DtVPRecord*>* DtEntityStateRepository::variableParameterList() const
593 {
594  return &myVPRecordCollection;
595 }
596 
597 inline std::vector<DtVPRecord*>* DtEntityStateRepository::variableParameterList()
598 {
599  return &myVPRecordCollection;
600 }
601 
602 #endif
603 
604 inline void DtEntityStateRepository::setInfraRedSigRepIndex( DtU16 value )
605 {
606  myInfaredSignatureIndex = value;
607 }
608 
609 inline DtU16 DtEntityStateRepository::infraRedSigRepIndex() const
610 {
611  return myInfaredSignatureIndex;
612 }
613 
614 inline void DtEntityStateRepository::setAcousticSigRepIndex( DtU16 value )
615 {
616  myAcousticsSignatureIndex = value;
617 }
618 
619 inline DtU16 DtEntityStateRepository::acousticSigRepIndex() const
620 {
621  return myAcousticsSignatureIndex;
622 }
623 
624 inline void DtEntityStateRepository::setRadarSigRepIndex( DtU16 value )
625 {
626  myRadarCrossSectionSignatureIndex = value;
627 }
628 
629 inline DtU16 DtEntityStateRepository::radarSigRepIndex() const
630 {
631  return myRadarCrossSectionSignatureIndex;
632 }
633 
634 inline void DtEntityStateRepository::setCapabilities( DtU32 cap )
635 {
636  myCapabilities = cap;
637 }
638 
639 inline DtU32 DtEntityStateRepository::capabilities() const
640 {
641  return myCapabilities;
642 }
643 
644 inline void DtEntityStateRepository::setMeasuredSpeed( DtU16 value )
645 {
646  myLiveEntityMeasuredSpeed = value;
647 }
648 
649 inline DtU16 DtEntityStateRepository::measuredSpeed() const
650 {
651  return myLiveEntityMeasuredSpeed;
652 }
653 
654 inline DtEntityStateRepository* DtEntityStateRepository::self() const
655 {
656  return (DtEntityStateRepository*)this;
657 }
658 
659 inline void DtEntityStateRepository::internalSetMarkingText( const char* a_text )
660 {
661  myMarkingText = a_text;
662 }
Document ID: Generated on Fri Dec 2 02:42:08 EST 2016 from SVN revision 171416
Copyright © 2005-2016 VT MÄK. All Rights Reserved (www.mak.com)