![]() |
VR-Forces Developer's Guide
|
The DtLocalObjectCreateInformation class is a subset of the information used in the DtIfCreateVrfObject call and will be used as the main class for creating DtLocalObject.

Protected Member Functions | |
| void | validateUUID () |
| DtLocalObjectCreateInformation::DtLocalObjectCreateInformation | ( | const DtUUID & | uuid | ) |
CTOR with UUID.
| DtLocalObjectCreateInformation::DtLocalObjectCreateInformation | ( | ) |
CTOR. Assumes UUID will be set at a later time.
| DtLocalObjectCreateInformation::DtLocalObjectCreateInformation | ( | const DtIfCreateVrfObject & | ) |
CTOR from create message.
| DtLocalObjectCreateInformation::DtLocalObjectCreateInformation | ( | const DtLocalObjectCreateInformation & | ) |
Copy constructor.
|
virtual |
DTOR.
| DtLocalObjectCreateInformation& DtLocalObjectCreateInformation::operator= | ( | const DtLocalObjectCreateInformation & | ) |
| void DtLocalObjectCreateInformation::setUUID | ( | const DtUUID & | ) |
| const DtUUID& DtLocalObjectCreateInformation::uuid | ( | ) | const |
| void DtLocalObjectCreateInformation::setOverlay | ( | const DtString & | ) |
| const DtString& DtLocalObjectCreateInformation::overlay | ( | ) | const |
| void DtLocalObjectCreateInformation::setObjectType | ( | const DtEntityType & | ) |
| const DtEntityType& DtLocalObjectCreateInformation::objectType | ( | ) | const |
| void DtLocalObjectCreateInformation::setPublishFlag | ( | int | ) |
See DtStateData::PublishFlag for publish flag types. Default is PublishAll.
| void DtLocalObjectCreateInformation::setPublishObject | ( | bool | ) |
| bool DtLocalObjectCreateInformation::publishObject | ( | ) | const |
Set to either DoNotPublish (false) or PublishAll (true)
| int DtLocalObjectCreateInformation::publishFlag | ( | ) | const |
Return true if flag is anything but DoNotPublish.
| void DtLocalObjectCreateInformation::setEntityIdentifier | ( | const DtEntityIdentifier & | ) |
| DtEntityIdentifier DtLocalObjectCreateInformation::entityIdentifier | ( | ) | const |
If the global id is filled in and it is a valid entity id, then, assume that also acts as the entity id, unless set by the user.
| void DtLocalObjectCreateInformation::setLabel | ( | const DtString & | ) |
| const DtString& DtLocalObjectCreateInformation::label | ( | ) | const |
| void DtLocalObjectCreateInformation::setPosition | ( | const DtVector & | geocLocation | ) |
Sets the first vertex to this position, and clears remainder of vertices, if present.
| DtVector DtLocalObjectCreateInformation::position | ( | ) | const |
If there are vertices, the first vertex.
| DtVector DtLocalObjectCreateInformation::endPosition | ( | ) | const |
| const std::vector<DtVector>& DtLocalObjectCreateInformation::vertices | ( | ) | const |
| std::vector<DtVector>& DtLocalObjectCreateInformation::vertices | ( | ) |
| void DtLocalObjectCreateInformation::setVertices | ( | const DtList & | ) |
Assumes DtList is a list of DtVector.
| void DtLocalObjectCreateInformation::setVertices | ( | const std::vector< DtVector > & | ) |
| void DtLocalObjectCreateInformation::addVertex | ( | const DtVector & | ) |
| const DtTaitBryan& DtLocalObjectCreateInformation::orientation | ( | ) | const |
| void DtLocalObjectCreateInformation::setOrientation | ( | const DtTaitBryan & | ) |
| void DtLocalObjectCreateInformation::setColor | ( | int | ) |
If tactical graphic that supports, set color (rgba)
| int DtLocalObjectCreateInformation::color | ( | ) | const |
If tactical graphic that supports, set color (rgba)
| bool DtLocalObjectCreateInformation::colorSet | ( | ) | const |
If tactical graphic that supports, set color (rgba)
| void DtLocalObjectCreateInformation::clearColor | ( | ) |
If tactical graphic that supports, set color (rgba)
| void DtLocalObjectCreateInformation::setLineWidth | ( | int | ) |
If tactical graphic that supports, set line width (default is 1)
| int DtLocalObjectCreateInformation::lineWidth | ( | ) | const |
If tactical graphic that supports, set line width (default is 1)
| bool DtLocalObjectCreateInformation::lineWidthSet | ( | ) | const |
If tactical graphic that supports, set line width (default is 1)
| void DtLocalObjectCreateInformation::clearLineWidth | ( | ) |
If tactical graphic that supports, set line width (default is 1)
| void DtLocalObjectCreateInformation::setPenStyle | ( | int | ) |
If tactical graphic that supports, set the pen style (default is 2 – solid line)
| int DtLocalObjectCreateInformation::penStyle | ( | ) | const |
If tactical graphic that supports, set the pen style (default is 2 – solid line)
| bool DtLocalObjectCreateInformation::penStyleSet | ( | ) | const |
If tactical graphic that supports, set the pen style (default is 2 – solid line)
| void DtLocalObjectCreateInformation::clearPenStyle | ( | ) |
If tactical graphic that supports, set the pen style (default is 2 – solid line)
| void DtLocalObjectCreateInformation::setFillStyle | ( | int | ) |
If tactical graphic that supports, set the pen style (default is -1 – keep fill style as defined in visuals)
| int DtLocalObjectCreateInformation::fillStyle | ( | ) | const |
If tactical graphic that supports, set the pen style (default is -1 – keep fill style as defined in visuals)
| bool DtLocalObjectCreateInformation::fillStyleSet | ( | ) | const |
If tactical graphic that supports, set the pen style (default is -1 – keep fill style as defined in visuals)
| void DtLocalObjectCreateInformation::clearFillStyle | ( | ) |
If tactical graphic that supports, set the pen style (default is -1 – keep fill style as defined in visuals)
| void DtLocalObjectCreateInformation::setWorldVelocity | ( | const DtVector & | ) |
Initial movement information.
| const DtVector& DtLocalObjectCreateInformation::worldVelocity | ( | ) | const |
Initial movement information.
| bool DtLocalObjectCreateInformation::worldVelocitySet | ( | ) | const |
Initial movement information.
| void DtLocalObjectCreateInformation::clearWorldVelocity | ( | ) |
Initial movement information.
| void DtLocalObjectCreateInformation::setWorldOrientation | ( | const DtTaitBryan & | ) |
Initial movement information.
| const DtTaitBryan& DtLocalObjectCreateInformation::worldOrientation | ( | ) | const |
Initial movement information.
| bool DtLocalObjectCreateInformation::worldOrientationSet | ( | ) | const |
Initial movement information.
| void DtLocalObjectCreateInformation::clearWorldOrientation | ( | ) |
Initial movement information.
| void DtLocalObjectCreateInformation::setAmClampedToGround | ( | bool | ) |
| bool DtLocalObjectCreateInformation::amClampedToGround | ( | ) | const |
| void DtLocalObjectCreateInformation::setHeading | ( | double | rad | ) |
Sets the psi member of orientation() in topographic radians.
| double DtLocalObjectCreateInformation::heading | ( | ) | const |
| void DtLocalObjectCreateInformation::setPitch | ( | double | rad | ) |
Sets the theta member of orientation() in topographic radians.
| double DtLocalObjectCreateInformation::pitch | ( | ) | const |
| void DtLocalObjectCreateInformation::setRoll | ( | double | rad | ) |
Sets the phi member of orientation() in topographic radians.
| double DtLocalObjectCreateInformation::roll | ( | ) | const |
| void DtLocalObjectCreateInformation::setObjectName | ( | const DtString & | ) |
| const DtString& DtLocalObjectCreateInformation::objectName | ( | ) | const |
| void DtLocalObjectCreateInformation::setObjectNamePrefix | ( | const DtString & | ) |
If objectName is empty string, use this prefix (if defined) when generating a unique name.
| const DtString& DtLocalObjectCreateInformation::objectNamePrefix | ( | ) | const |
| void DtLocalObjectCreateInformation::setForceType | ( | DtForceType | ) |
| DtForceType DtLocalObjectCreateInformation::forceType | ( | ) | const |
| void DtLocalObjectCreateInformation::setClampToGround | ( | bool | ) |
When placing, whether or not to clamp the object to the ground (valid for only platform single point objects). Default is true.
| bool DtLocalObjectCreateInformation::clampToGround | ( | ) | const |
| void DtLocalObjectCreateInformation::setProjected | ( | bool | ) |
Whether or not this item is projected. A projected item is 2D only.
| bool DtLocalObjectCreateInformation::projected | ( | ) | const |
| void DtLocalObjectCreateInformation::setIsClutterEntity | ( | bool | ) |
Hint as to whether or not this object can be a lower fidelity clutter simulation object. Default is false.
| bool DtLocalObjectCreateInformation::isClutterEntity | ( | ) | const |
| void DtLocalObjectCreateInformation::setGlobalId | ( | const DtString & | ) |
Sets the global id (HLA) of the object on creation. This name is subject to verification by the RTI so might not be assigned. In DIS this will be translated to an entity id. If the sttring is not of site:host:entity then it will be assigned an entity id. If the global id cannot be assigned by the RTI an new id will be assigned. This parameter is a DtString rather than the native class type due to the fact that this message is protocol indepenent. The default to generate new for each object.
| const DtString& DtLocalObjectCreateInformation::globalId | ( | ) | const |
| void DtLocalObjectCreateInformation::setClosedFigure | ( | bool | ) |
Whether or not this item is a closed figure (like an area)
| bool DtLocalObjectCreateInformation::closedFigure | ( | ) | const |
| void DtLocalObjectCreateInformation::setAppearance | ( | unsigned | int | ) |
Appearance bits for object.
| void DtLocalObjectCreateInformation::setConnectToRadioNetwork | ( | bool | b | ) |
Whether or not to connect this object to the local radio network. Default is true.
| bool DtLocalObjectCreateInformation::connectToRadioNetwork | ( | ) | const |
| void DtLocalObjectCreateInformation::setAddToOrbat | ( | bool | ) |
Whether or not to also add this item to the order of battle file (orbat) that is saved to keep hierarchy of potential objects. Default is false.
| bool DtLocalObjectCreateInformation::addToOrbat | ( | ) | const |
| void DtLocalObjectCreateInformation::setCreateSubObjects | ( | bool | b | ) |
If this object also has subordinates, create those. Default is true.
| bool DtLocalObjectCreateInformation::createSubObjects | ( | ) | const |
| void DtLocalObjectCreateInformation::setOrganized | ( | bool | ) |
If this object can be organized, whether or not to add it to the force level organization. Default is true.
| bool DtLocalObjectCreateInformation::organized | ( | ) | const |
| void DtLocalObjectCreateInformation::setUserCallback | ( | DtVrfObjectUserInitFcn | , |
| void * | |||
| ) |
During creation, invoke this callback after the object is created but before added. Return false to not add this object into the system from the callback.
| DtVrfObjectUserInitFcn DtLocalObjectCreateInformation::callbackFunction | ( | ) | const |
| void* DtLocalObjectCreateInformation::callbackData | ( | ) | const |
| void DtLocalObjectCreateInformation::setRequestId | ( | unsigned | long | ) |
Only used if this is in response to being created from an object create message. Cannot be set. Default is 0.
| void DtLocalObjectCreateInformation::setStartingFormation | ( | const DtString & | ) |
Aggregate specific information. See createObjectServicesInterface.h for aggregate creation mode.
| const DtString& DtLocalObjectCreateInformation::startingFormation | ( | ) | const |
Aggregate specific information. See createObjectServicesInterface.h for aggregate creation mode.
| void DtLocalObjectCreateInformation::setAggregateCreationMode | ( | int | ) |
Aggregate specific information. See createObjectServicesInterface.h for aggregate creation mode.
| int DtLocalObjectCreateInformation::aggregateCreationMode | ( | ) | const |
Aggregate specific information. See createObjectServicesInterface.h for aggregate creation mode.
| const std::map<std::string, std::string>& DtLocalObjectCreateInformation::extendedData | ( | ) | const |
Initial extened data.
| std::map<std::string, std::string>& DtLocalObjectCreateInformation::extenedData | ( | ) |
| void DtLocalObjectCreateInformation::setExtendedData | ( | const std::map< std::string, std::string > & | ) |
| void DtLocalObjectCreateInformation::setExtendedData | ( | const DtString & | keyword, |
| const DtString & | data | ||
| ) |
| const DtString& DtLocalObjectCreateInformation::userData | ( | ) | const |
User data. For tactical graphics only. Should use extended data instead, but, this is here for backwards compatability.
| void DtLocalObjectCreateInformation::setUserData | ( | const DtString & | ) |
| void DtLocalObjectCreateInformation::setSuperior | ( | const DtUUID & | ) |
If this object should immediately be attached to a superior, the superior it should be attached to after creation.
| const DtUUID& DtLocalObjectCreateInformation::superior | ( | ) | const |
| const std::list<DtAdminContent*>& DtLocalObjectCreateInformation::initialAdminContent | ( | ) | const |
Initial admin content to apply to the object. This class owns the memory.
| std::list<DtAdminContent*>& DtLocalObjectCreateInformation::initialAdminContent | ( | ) |
Use this call to pass ownership of content to this class.
| void DtLocalObjectCreateInformation::setInitialAdminContent | ( | const std::list< DtAdminContent * > & | adminContent | ) |
| void DtLocalObjectCreateInformation::addInitialAdminContent | ( | DtAdminContent * | adminContent | ) |
| void DtLocalObjectCreateInformation::clearInitialAdminContent | ( | ) |
| const std::list<DtSimInterfaceContent*>& DtLocalObjectCreateInformation::initialInterfaceContent | ( | ) | const |
Initial interface content to apply to the object. This class owns the memory.
| std::list<DtSimInterfaceContent*>& DtLocalObjectCreateInformation::initialInterfaceContent | ( | ) |
Use this call to pass ownership of content to this class.
| void DtLocalObjectCreateInformation::setInitialInterfaceContent | ( | const std::list< DtSimInterfaceContent * > & | adminContent | ) |
| void DtLocalObjectCreateInformation::addInitialInterfaceContent | ( | DtSimInterfaceContent * | adminContent | ) |
| void DtLocalObjectCreateInformation::clearInitialInterfaceContent | ( | ) |
| void DtLocalObjectCreateInformation::addSubordinates | ( | const std::vector< DtUUID > & | ) |
Takes the UUIDs supplied, and, if the subordinates exist, adds them to the newly created object Adds to whatever might be there.
| void DtLocalObjectCreateInformation::addSubordinate | ( | const DtUUID & | ) |
| void DtLocalObjectCreateInformation::renmoveSubordinate | ( | const DtUUID & | ) |
| void DtLocalObjectCreateInformation::clearSubordinates | ( | ) |
| const std::vector<DtUUID>& DtLocalObjectCreateInformation::subordinates | ( | ) | const |
|
virtual |
Returns true if this is a valid creation object. Will check if there is a non-zero location.
|
protected |
Set a UUID into the uuid if the uuid is not valid.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
The topographic orientation to set for this object.
|
protected |
The vertices (geocentric) used to create this object.
|
protected |
Whether or not to publish this item on the network. Default is true.
|
protected |
Default is DtForceOther.
|
protected |
VR-Link specific – the entity identifier to use as a seed.
|
protected |
Default is true.
|
protected |
Default is false.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
World velocity to be set in the local object (only used if set)
|
protected |
|
protected |
If this is specified, use this instead of the supplied orientation.
|
protected |
|
protected |
Takes the UUIDs supplied, and, if the subordinates exist, adds them to the newly created object.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |