![]() |
VR-Forces 5.0.3 Developer's Guide
|

Public Types | |
| typedef std::vector< DtVector > | DtCOVertexList |
| typedef std::vector < DtIttEnvironmentalProcessData * > | DtGeometricDataList |
| typedef std::map< int, DtIttSourceDataCreator > | DtIttSourceDataMap |
Public Member Functions | |
| DtControlObjectBaseRepository () | |
| virtual | ~DtControlObjectBaseRepository () |
| DtControlObjectBaseRepository (const DtControlObjectBaseRepository &orig) | |
| DtControlObjectBaseRepository & | operator= (const DtControlObjectBaseRepository &orig) |
| virtual DtStateRepository * | clone (bool copy=false) const |
| virtual const DtControlObjectKind & | kind () const |
| virtual void | setKind (const DtControlObjectKind &k) |
| virtual const DtControlObjectCategory & | category () const |
| virtual void | setCategory (const DtControlObjectCategory &c) |
| const std::vector< DtVector > & | vertexList () const |
| virtual void | updateExtensions () |
| virtual int | compare (const DtControlObjectBaseRepository *rhs) |
| virtual int | compareToMostRecent () |
| virtual bool | locationsDifferent (bool updateIfDifferent) |
| virtual void | emptyVertexList () |
| virtual void | getBoundingVolume (DtVector &location, double &radius) const |
| const DtGeometricDataList & | geometricRecords () const |
| bool | geometricRecordsChanged () const |
| void | clearGeometricRecordsChanged () |
| virtual void | updateDataRecords () |
| virtual int | numberOfSubordinates () const |
| virtual bool | getSubordinate (int i, DtGlobalObjectDesignator &d) |
| virtual const DtGlobalObjectDesignatorList & | subordinates () const |
| virtual DtGlobalObjectDesignatorList & | subordinates () |
| virtual void | setExtendedData (const std::map< DtString, DtString > &ed) |
| virtual void | setExtendedData (const DtString &key, const DtString &value) |
| virtual double | orientation () const |
| virtual DtString | uuidString () const |
| virtual void | setVertices (const DtList &pnt) |
| virtual void | appendVertex (const DtVector &) |
| virtual void | setVertex (int i, const DtVector &) |
| virtual void | removeVertex (int i) |
| virtual void | setObjectType (const DtObjectType &) |
| virtual DtForceType | forceType () const |
| virtual void | setForceType (DtForceType i) |
| virtual int | color () const |
| virtual void | setColor (int) |
| virtual const DtString & | parent () const |
| virtual void | setParent (const DtString &) |
| virtual const DtString & | userData () const |
| virtual void | setUserData (const DtString &) |
| virtual void | setVrfObjectName (const DtString &) |
| virtual const DtString & | vrfObjectName () |
| virtual DtAppearance | appearance () const |
| virtual void | setAppearance (const DtAppearance &app) |
| virtual void | setNumberOfSubordinates (int) |
| virtual void | setSubordinate (int i, const DtGlobalObjectDesignator &) |
| virtual const DtGlobalObjectDesignator & | hostGlobalId () const |
| virtual void | setHostGlobalId (const DtGlobalObjectDesignator &) |
| virtual void | clearHostGlobalId () |
| virtual bool | getFontInformation (DtString &font, int &fontSize) const |
| virtual void | setFontInformation (const DtString &, int fontSize) |
| virtual bool | getFontColor (unsigned int &color) const |
| virtual void | setFontColor (unsigned int color) |
| virtual bool | getArrowInformation (int &arrowHeadPlacement, int &arrowStyle, int &arrowSize) const |
| virtual void | setArrowInformation (int arrowHeadPlacement, int arrowStyle, int arrowSize) |
| virtual void | setBoundingSphereRadius (double) |
| virtual double | boundingSphereRadius () const |
| virtual void | setBoundingSphereLocation (const DtVector &) |
| virtual const DtVector & | boundingSphereLocation () const |
| bool | hasBoundingSphereRecord () const |
| bool | hasBoundingRectRecord () const |
| virtual void | setBoundingExtent (const DtVector &) |
| const DtVector & | boundingExtent () const |
| virtual void | setBoundingCornerLocation (const DtVector &) |
| virtual const DtVector & | boundingCornerLocation () const |
| virtual void | setBoundingOrientation (const DtTaitBryan &) |
| const DtTaitBryan & | boundingOrientation () const |
| virtual void | setProjected (bool) |
| virtual bool | projected () const |
| virtual void | setClosedFigure (bool) |
| virtual bool | closedFigure () const |
| virtual void | setBound2D (bool) |
| virtual bool | bound2D () const |
| virtual void | setFillStyle (int) |
| virtual int | fillStyle () const |
| virtual void | setLineStyle (int) |
| virtual int | lineStyle () const |
| virtual void | setLineWidth (int) |
| virtual int | lineWidth () const |
| virtual void | setPhysicalLineHeight (double) |
| virtual double | physicalLineHeight () const |
| virtual void | setPhysicalLineWidth (double) |
| virtual double | physicalLineWidth () const |
| virtual void | setRelativeLocation (const DtVector &) |
| virtual const DtVector & | relativeLocation () const |
| virtual void | setVelocity (const DtVector &) |
| virtual const DtVector & | velocity () const |
| virtual void | setAcceleration (const DtVector &) |
| virtual const DtVector & | acceleration () const |
| virtual void | setDRAlogrithm (DtDeadReckonTypes) |
| virtual const DtDeadReckonTypes & | drAlgorithm () const |
| virtual void | setOffsetPoints (const std::vector< DtVector > &) |
| virtual const std::vector < DtVector > & | offsetPoints () const |
| virtual void | setCachePoints (bool) |
| bool | cachePoints () const |
| virtual DtString | extendedData (const DtString &key) const |
| const DtVrfExtendedRecordData & | extendedRecordData () const |
| DtVrfExtendedRecordData & | extendedRecordData () |
| int | numberOfDatumRecords () const |
| void | setNumberOfDatumRecords (int) |
| virtual void | setSendVrfObjectDataRecord (bool shouldSend) |
| virtual bool | shouldSendVrfObjectDataRecord () const |
Public Member Functions inherited from DtVrfExtensions | |
| DtVrfExtensions () | |
| virtual | ~DtVrfExtensions () |
| DtVrfExtensions (const DtVrfExtensions &orig) | |
| DtVrfExtensions & | operator= (const DtVrfExtensions &orig) |
| virtual const DtString & | name () const |
| virtual void | setName (const DtString &n) |
| virtual const DtString & | vrfObjectLabel () const |
| virtual void | setVrfObjectLabel (const DtString &l) |
| virtual const DtString & | echelonId () const |
| virtual void | setEchelonId (const DtString &l) |
| virtual const DtString & | overlayParent () const |
| virtual void | setOverlayParent (const DtString &l) |
| virtual bool | isVrfSimulated () const |
| virtual void | setIsVrfSimulated (bool vrf) |
| virtual DtU32 | vrfSessionId () const |
| virtual void | setVrfSessionId (DtU32 id) |
| virtual void | setVrfMessageVersionSupported (DtU32 id) |
| virtual DtU32 | vrfMessageVersionSupported () const |
| virtual const DtObjectType & | objectType () const |
| virtual void | setIsSubordinateOfForce (bool b) |
| virtual bool | isSubordinateOfForce () const |
| virtual int | superType () const |
| virtual void | setHasPlan (bool yesNo) |
| virtual bool | hasPlan () const |
| virtual void | setIsCurrentlyTasked (bool yesNo) |
| virtual bool | isCurrentlyTasked () const |
| virtual void | setRulesOfEngagement (const DtString &) |
| virtual const DtString & | rulesOfEngagement () const |
| virtual bool | setupFromVrfObjectData (const DtIfVrfObjectData &data) |
| virtual void | addRangeItem (const DtRangeItem &) |
| virtual void | removeRangeItem (int index) |
| virtual void | setRangeItems (const DtRangeItems &) |
| const DtRangeItems & | rangeItems () const |
| virtual bool | createVrfObjectDataMessage () |
| virtual DtIfVrfObjectData * | vrfObjectDataMessage () const |
| virtual void | setIndependentlyTasked (bool yesNo) |
| virtual bool | independentlyTasked () const |
| virtual void | setUnderFire (bool yesNo) |
| virtual bool | underFire () const |
| virtual void | setExecutingPlan (bool yesNo) |
| virtual bool | executingPlan () const |
| virtual const std::map < DtString, DtString > & | extendedData () const |
| virtual void | setBoundingVolume (const DtVector32 &) |
| virtual const DtVector32 & | boundingVolume () const |
| virtual void | setBoundingVolumeOffset (const DtVector32 &) |
| virtual const DtVector32 & | boundingVolumeOffset () const |
Static Public Member Functions | |
| static void | initializePuffFactory () |
| static void | addToPuffFactory (int iRecordType, DtIttSourceDataCreator fcn) |
| static DtIttSourceData * | createPuffRecord (DtNetEnvironmentalRecord *geometric, DtNetEnvironmentalRecord *source) |
| static DtIttSourceData * | createPuffRecord (DtNetEnvironmentalRecord *rec) |
| static DtEnvironmentProcessRepository * | create () |
Static Public Member Functions inherited from DtVrfExtensions | |
| static void | setExpectedVrfMessageVersion (DtU32 version) |
| static DtU32 | expectedVrfMessageVersion () |
Public Attributes | |
| DtControlObjectKind | myKind |
| DtControlObjectCategory | myCategory |
| DtCOVertexList | myVertexList |
| DtSimEnvironmentalObjectStateRecord * | myExtEnvStateRecord |
| DtEnvironmentalBoundingSphereRecord * | myBoundingSphereRecord |
| DtVrfObjectDataEnvironmentalRecord * | myVrfObjectStateRecord |
| DtControlObjectBaseRepository * | myLastCopy |
| DtEnvironmentalRectangularVolumeRecord * | myBoundingRectRecord |
| DtGeometricDataList | myGeometricRecords |
| bool | myGeometricRecordsChanged |
| bool | myNeedVrfObjectDataUpdate |
| bool | myCachePoints |
| int | myPointsSet |
| DtEnvironmentalProcessExtendedRecordData | myExtendedRecordData |
| bool | mySendVrfObjectDataRec |
Static Public Attributes | |
| static DtIttSourceDataMap | thePuffFactory |
Protected Member Functions | |
| virtual bool | createExtendedEnvironmentalStateRecord () |
| virtual DtSimEnvironmentalObjectStateRecord * | extendedEnvironmentalStateRecord () |
| virtual bool | createVrfObjectStateRecord () |
| virtual DtVrfObjectDataEnvironmentalRecord * | vrfObjectStateRecord () |
| virtual bool | createBoundingSphereRecord () |
| virtual DtEnvironmentalBoundingSphereRecord * | boundingSphereRecord () |
| virtual bool | createBoundingRectRecord () |
| virtual DtEnvironmentalRectangularVolumeRecord * | boundingRectRecord () |
| virtual void | setupKindFromType (const DtEntityType &type) |
| virtual void | getBoundingVolume (EnvGeomSpheriod *rec) |
| virtual void | clearGeometricRecords () |
| virtual void | extensionModified () |
Additional Inherited Members | |
Protected Attributes inherited from DtVrfExtensions | |
| DtString | myName |
| DtIfVrfObjectData * | myVrfObjectDataMessage |
Static Protected Attributes inherited from DtVrfExtensions | |
| static DtU32 | theExpectedVrfMessageVersion |
| typedef std::vector<DtVector> DtControlObjectBaseRepository::DtCOVertexList |
| typedef std::vector<DtIttEnvironmentalProcessData*> DtControlObjectBaseRepository::DtGeometricDataList |
| typedef std::map<int, DtIttSourceDataCreator> DtControlObjectBaseRepository::DtIttSourceDataMap |
| DtControlObjectBaseRepository::DtControlObjectBaseRepository | ( | ) |
default constructor
|
virtual |
destructor
| DtControlObjectBaseRepository::DtControlObjectBaseRepository | ( | const DtControlObjectBaseRepository & | orig | ) |
copy constructor
| DtControlObjectBaseRepository& DtControlObjectBaseRepository::operator= | ( | const DtControlObjectBaseRepository & | orig | ) |
assignment operator
|
virtual |
Return a copy/empty object of the same type as this.
Reimplemented in makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository >, DtCloudLayerRepository, DtControlObjectRepository, DtWeatherObjectRepository, makVrfVrlinkExtToolkit::DtStateRepositoryWithExtendedAttributes< DtControlObjectBaseRepository >, and DtGlobalEnvironmentObjectRepository.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
| const std::vector<DtVector>& DtControlObjectBaseRepository::vertexList | ( | ) | const |
|
virtual |
updateExtensions() extracts the extended environmental process state information, if present, from the state repository
Reimplemented in DtControlObjectRepository, DtCloudLayerRepository, and DtWeatherObjectRepository.
|
virtual |
Compares us against the supplied state repository and returns what's changed. Since this is being called from a location where the vertex list is already being checked, we don't need to do it.
|
virtual |
Returns what has changed since the last time we called compare.
Returns true if our stashed location is different than our current location.
|
virtual |
|
static |
Adds mappings between environmental record types and the type of information to read off of the network into local environmental data structures.
|
static |
|
static |
|
static |
|
virtual |
|
inline |
References myGeometricRecords.
|
inline |
References myGeometricRecordsChanged.
|
inline |
References myGeometricRecordsChanged.
|
virtual |
If myNeedVrfObjectDataUpdate is true, update the vrf object data record. Also sets all vrf specific data records into state repository. Called from publisher.
Reimplemented in DtCloudLayerRepository, and DtWeatherObjectRepository.
|
virtual |
Subordinate information. Not currently used by VRF.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Sets extended data for transport via extended data records.
Reimplemented from DtVrfExtensions.
|
virtual |
Gets/sets extended data.
Reimplemented from DtVrfExtensions.
|
virtual |
Returns the orientation of the given environmental in radians. If the environmental is a closed figure the orientation is the angle of the first leg, else the angle of the first to last point.
|
virtual |
Returns a string version of the VRF UUID of this object, if it can be determined. VRF has multiple ways of sending the UUID. This method only works when the UUID is sent via the object's extendedData. If sent by other means, such as using state properties (which is the default in 4.6 and later), the returned string will be empty.
Reimplemented in DtControlObjectRepository.
|
virtual |
Sets the vertices to use in the publication of this object. Will create the environmental records (as needed), put them into the state repository structure and also the vertex list. This routine assumes the DtList contains DtVectors.
|
virtual |
|
virtual |
|
virtual |
Environmental record settings.
Used to set in appearance value of env state record and vrf object data message
Reimplemented from DtVrfExtensions.
|
virtual |
Returns the force type from the environmental header record (if it exists), else returns neutral by default.
|
virtual |
|
virtual |
Returns the color (rgb) value of this object.
|
virtual |
|
virtual |
Returns the parent of this object.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Returns the parent this object might be attached to.
|
virtual |
|
virtual |
Sets host global id to empty string.
|
virtual |
Deals with font and arrow head information via the extended data. Format of extended data for dealing with fonts and arrows is in the DtEnvironmentalFormattingData entry. Format is <font name>="">|<font size>="">|<unused>|<font color>="">|<arrow head="" placement>="">|<arrow style>="">|<arrow size>="">
The data can be set specifically in the extended data with that format, or the routines below can be used to access/set the data.
Returns true if font information exists.
|
virtual |
32 bit AGBR value
|
virtual |
|
virtual |
|
virtual |
Routines that are used to set/get information about the bounding sphere. If this information is set, a bounding sphere environmental record will be created and send with the environmental state repository. To check to see if this information has been supplied, test the result of hasBoundingVolumeRecord(), if that value is true, then bounding volume information has been supplied.
Note that if this information is not set, then, this information will not be sent over the network. Call and of the set* to create the bounding sphere record and send the radius information In setting the bounding sphere radius, if a bounding sphere record does not exist, it will be created
|
virtual |
|
virtual |
Sets/gets the bounding sphere location. Will also create the record on set if it does not exist.
|
virtual |
|
inline |
References myBoundingSphereRecord.
|
inline |
Routines that are used to set/get information about the bounding rectangle. If this information is set, a bounding sphere environmental record will be created and send with the environmental state repository. To check to see if this information has been supplied, test the result of hasBoundingRectRecord(), if that value is true, then bounding rectangle information has been supplied.
Note that if this information is not set, then, this information will not be sent over the network. Call and of the set* to create the bounding rectangle record and send the rectangle information
References myBoundingRectRecord.
|
virtual |
| const DtVector& DtControlObjectBaseRepository::boundingExtent | ( | ) | const |
|
virtual |
|
virtual |
|
virtual |
| const DtTaitBryan& DtControlObjectBaseRepository::boundingOrientation | ( | ) | const |
|
virtual |
Gets/sets additional attribute values about the environmental. These values are stored in the extended environmental record.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
For those objects that support it. Note that point objects do not make use of these items.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Height of the line, in meters. When added to the altitude, can be considered a ceiling.
|
virtual |
|
virtual |
Width of the line, in meters. Different than "lineWidth" which is more of a stylistic representation.
|
virtual |
|
virtual |
If attached to an entity, the relative position (in body coordinatates) of this object from the origin of the attached object. If this is a multi-point object it is the offset from the first point in that object.
|
virtual |
|
virtual |
Unused at this point – left for future possible expansion for movable/rotatable environmentals {
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set cachePoints to false to not cache the points that are set into the structure or read from the network into the myVertexList variable. This variable is set to false if this repository is used from a publisher. By default, this value it true.
|
inline |
References myCachePoints.
Extended record data is a key/value pair. The value and key is always a string representation and is up to the developer to determine the format of the value. The values are set through the publisher.
Reimplemented from DtVrfExtensions.
|
inline |
|
inline |
| int DtControlObjectBaseRepository::numberOfDatumRecords | ( | ) | const |
| void DtControlObjectBaseRepository::setNumberOfDatumRecords | ( | int | ) |
|
virtual |
Whether a separate VrfObjectData record should be sent to convey additional VRF object information.
|
virtual |
Whether a separate VrfObjectData record should be sent to convey additional VRF object information.
|
protectedvirtual |
createExtendedEnvironmentalStateRecord() allocates myExtEnvStateRecord, a DtSimEnvironmentalObjectStateRecord used by VR-Forces as extended environmental process state information:
|
protectedvirtual |
extendedEnvironmentalStateRecord() returns the myExtEnvStateRecord for inspection by the caller. If myExtEnvStateRecord is NULL, it is created.
|
protectedvirtual |
createVrfObjectStateRecord() allocates myVrfObjectStateRecord, a DtVrfObjectDataEnvironmentalRecord used by VR-Forces as extended vrf object state information:
|
protectedvirtual |
extendedVrfObjectStateRecord() returns the myVrfObjectStateRecord for inspection by the caller. If myVrfObjectStateRecord is NULL, it is created.
|
protectedvirtual |
createBoundingSphereRecord() allocates myBoundingSphereRecord
|
protectedvirtual |
boundingSphereRecord() returns the myBoundingSphereRecord for inspection by the caller. If myBoundingSphereRecord is NULL, it is created.
|
protectedvirtual |
createBoundingRectRecord() allocates myBoundingRectRecord
|
protectedvirtual |
boundingRectRecord() returns the myBoundingRectRecord for inspection by the caller. If myBoundingRectRecord is NULL, it is created.
|
protectedvirtual |
Sets up internal object kind and category from object type.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
Override to set myNeedVrfObjectDataUpdate to true.
Reimplemented from DtVrfExtensions.
|
static |
| DtControlObjectKind DtControlObjectBaseRepository::myKind |
| DtControlObjectCategory DtControlObjectBaseRepository::myCategory |
| DtCOVertexList DtControlObjectBaseRepository::myVertexList |
Keeps a list of all geometry point records to use to update internal model datas from.
| DtSimEnvironmentalObjectStateRecord* DtControlObjectBaseRepository::myExtEnvStateRecord |
DtSimEnvironmentalObjectStateRecord is a special form of DtEnvironmentalRecord, used to decode custom data that might be published from a VR-Forces back end, such as label, force type, appearance, etc. see "envObjState.h".
| DtEnvironmentalBoundingSphereRecord* DtControlObjectBaseRepository::myBoundingSphereRecord |
Referenced by hasBoundingSphereRecord().
| DtVrfObjectDataEnvironmentalRecord* DtControlObjectBaseRepository::myVrfObjectStateRecord |
| DtControlObjectBaseRepository* DtControlObjectBaseRepository::myLastCopy |
| DtEnvironmentalRectangularVolumeRecord* DtControlObjectBaseRepository::myBoundingRectRecord |
Referenced by hasBoundingRectRecord().
|
static |
This information is needed for ITT puff clouds.
| DtGeometricDataList DtControlObjectBaseRepository::myGeometricRecords |
Referenced by geometricRecords().
| bool DtControlObjectBaseRepository::myGeometricRecordsChanged |
Referenced by clearGeometricRecordsChanged(), and geometricRecordsChanged().
| bool DtControlObjectBaseRepository::myNeedVrfObjectDataUpdate |
| bool DtControlObjectBaseRepository::myCachePoints |
Referenced by cachePoints().
| int DtControlObjectBaseRepository::myPointsSet |
| DtEnvironmentalProcessExtendedRecordData DtControlObjectBaseRepository::myExtendedRecordData |
| bool DtControlObjectBaseRepository::mySendVrfObjectDataRec |