 |
VR-Forces 4.8 Class Documentation
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 4.8 Class Documentation
|
The moving-object-param parameter type is used for objects that are capable of movement, such as individual entities and aggregates. More...
Public Member Functions | |
| DtMovingObjectParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) | |
| constructor with parameters to set up read/writability correctly More... | |
| DtMovingObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) | |
| virtual | ~DtMovingObjectParameters () |
| destructor More... | |
| const DtMovingObjectParameters & | operator= (const DtMovingObjectParameters &orig) |
| assignment operator More... | |
| virtual DtVrfObjectParameters * | clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const |
| virtual DtVrfObjectParameters * | clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const |
| virtual DtString | type () const |
| Should return the type of object this is a parameter block for. More... | |
| virtual bool | inheritValues (const DtVrfObjectParameters *benefactor) |
| virtual void | inheritValuesFromThisType (const DtMovingObjectParameters *benefactor) |
| virtual int | illuminationRecalcTime () const |
| Accessor/mutator for myIlluminationRecalcTime. More... | |
| virtual void | setIlluminationRecalcTime (int newValue) |
| virtual int | weatherAreaRecalcTime () const |
| Accessor/mutator for myWeatherAreaRecalcTime. More... | |
| virtual void | setWeatherAreaRecalcTime (int newValue) |
| virtual bool | canPivot () const |
| Accessor/mutator for myCanPivot. More... | |
| virtual void | setCanPivot (bool newValue) |
| virtual bool | protectEmbarkedFromCollateralDamage () const |
| Accessor/mutator for myProtectEmbarkedFromCollateralDamage. More... | |
| virtual void | setProtectEmbarkedFromCollateralDamage (bool newValue) |
| virtual DtReal | maxPivotSpeed () const |
| Accessor/mutator for myMaxPivotSpeed. More... | |
| virtual void | setMaxPivotSpeed (DtReal maxSpeed) |
| virtual const DtVector & | leftSupport () const |
| Accessor/mutator for myLeftSupport. More... | |
| virtual void | setLeftSupport (const DtVector &newLeftSupport) |
| virtual const DtVector & | rightSupport () const |
| Accessor/mutator for myRightSupport. More... | |
| virtual void | setRightSupport (const DtVector &newRightSupport) |
| virtual const DtVector & | otherSupport () const |
| Accessor/mutator for myOtherSupport. More... | |
| virtual void | setOtherSupport (const DtVector &newOtherSupport) |
| virtual DtReal | maxSpeed () const |
| Accessor/mutator for myMaxSpeed. More... | |
| virtual void | setMaxSpeed (DtReal speed) |
| virtual DtReal | maxReverseSpeed () const |
| Accessor/mutator for myMaxReverseSpeed. More... | |
| virtual void | setMaxReverseSpeed (DtReal speed) |
| virtual bool | useModelArtPartInformation () const |
| Accessor/mutator for myUseModelArtPartInformation. More... | |
| virtual void | setUseModelArtPartInformation (bool) |
| virtual DtReal | turningRadius () const |
| Accessor/mutator for myTurningRadius. More... | |
| virtual void | setTurningRadius (DtReal turningRadius) |
| virtual DtReal | maxSlope () const |
| Accessor/mutator for myMaxSlope. More... | |
| virtual void | setMaxSlope (DtReal slope) |
| virtual DtReal | orderedSpeed () const |
| Accessor/mutator for myOrderedSpeed. More... | |
| virtual void | setOrderedSpeed (DtReal speed) |
| virtual DtReal | maxAcceleration () const |
| Accessor/mutator for myMaxAcceleration. More... | |
| virtual void | setMaxAcceleration (const DtReal maxAcceleration) |
| virtual DtReal | maxStoppingDeceleration () const |
| Accessor/mutator for myMaxStoppingDeceleration. More... | |
| virtual void | setMaxStoppingDeceleration (const DtReal maxStoppingDeceleration) |
| virtual DtReal | maxLateralAcceleration () const |
| Accessor/mutator for myMaxLateralAcceleration. More... | |
| virtual void | setMaxLateralAcceleration (const DtReal maxLateralAcceleration) |
| virtual DtReal | fuelEfficiency () const |
| Accessor/mutator for myFuelEfficiency. More... | |
| virtual void | setFuelEfficiency (const DtReal efficiency) |
| virtual bool | useObjectGeometry () const |
| Accessor/mutator for myUseObjectGeometry. More... | |
| virtual void | setUseObjectGeometry (bool) |
| virtual bool | useObjectVisuals () const |
| Accessor/mutator for myUseObjectVisuals. More... | |
| virtual void | setUseObjectVisuals (bool) |
| virtual const DtString & | objectGeometryFile () const |
| Accessor/mutator for myObjectGeometryFile. More... | |
| virtual void | setObjectGeometryFile (const DtFilename &) |
| virtual bool | embedIntoTerrain () const |
| Accessor/mutator for myEmbedIntoTerrain. More... | |
| virtual void | setEmbedIntoTerrain (bool) |
| virtual void | setDIGuyCharacterInfo (const DtRwDIGuyCharacterInfo &info) |
| Accessor/mutator for #myDIGuyCharacter. More... | |
| virtual const DtRwDIGuyCharacterInfo & | diGuyCharacterInfo () const |
| virtual void | setMaxDisaggregationDistance (DtReal distance) |
| Maximum disaggregation distance in meters. More... | |
| virtual DtReal | maxDisaggregationDistance () const |
| virtual void | setUsingRailMovement (bool rails) |
| Accessor/mutator for myUsingRailMovement. More... | |
| virtual bool | usingRailMovement () const |
 Public Member Functions inherited from DtVrfObjectParameters | |
| DtVrfObjectParameters (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) | |
| Constructor with parameters to set up read/writability correctly. More... | |
| DtVrfObjectParameters (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) | |
| virtual | ~DtVrfObjectParameters () |
| destructor More... | |
| DtVrfObjectParameters & | operator= (const DtVrfObjectParameters &orig) |
| assignment operator More... | |
| virtual bool | init () |
| Invoked when created so that deriving classes may do virtual allocation as necessary. More... | |
| virtual void | inheritValuesFromThisType (const DtVrfObjectParameters *benefactor) |
| virtual bool | createLocalSubComponentTypes () |
| Creates a DtVrfObjectSubComponentTypes type of composed object type. More... | |
| virtual bool | createRemoteSubComponentTypes () |
| Creates a DtVrfObjectSubComponentTypes type of composed object type. More... | |
| virtual DtVrfObjectSubComponentTypes * | localVrfSubComponentTypes () const |
| Get local sub-component types. More... | |
| virtual DtVrfObjectSubComponentTypes * | remoteVrfSubComponentTypes () const |
| Get remote sub-component types. More... | |
| virtual void | setMinTickPeriod (DtReal minTickPeriod) |
| Set the minimum tick period for this object (individual components and the network interface may override) More... | |
| virtual DtReal | minTickPeriod () const |
| get the minimum tick period for this component (individual components and the network interface may override) More... | |
| virtual void | setMinTickPeriodVariance (DtReal minTickPeriodVariance) |
| Set the minimum tick period variance for this component (individual components and the network interface may override) More... | |
| virtual DtReal | minTickPeriodVariance () const |
| Get the minimum tick period variance for this component (individual components and the network interface may override) More... | |
| virtual DtForceType | forceType () const |
| Currently unused. More... | |
| virtual void | setForceType (const DtForceType force) |
| virtual bool | hasGuiKeyword (const DtString &) const |
| Returns true if the gui keywords contain the particular keyword specified (the gui keywords are specified in the .entity object) More... | |
| virtual const DtString & | category () const |
| Accessor/mutator for myCategory. More... | |
| virtual void | setCategory (const DtString &category) |
| virtual bool | categorySpecified () const |
| Returns true of the category was specified in the file. More... | |
| virtual const DtString & | echelonLevel () const |
| Accessor/mutator for myEchelonLevel. More... | |
| virtual void | setEchelonLevel (const DtString &echelonLevel) |
| virtual bool | echelonLevelSpecified () const |
| Returns true of the echelon level was specified in the file. More... | |
| virtual bool | organized () const |
| Accessor/mutator for myOrganized. More... | |
| virtual void | setOrganized (bool organized) |
| virtual const DtRwVisualMetaData & | visualMetaData () const |
| Accessor/mutator for myVisualMetaData. More... | |
| virtual void | setVisualMetaData (const DtRwVisualMetaData &list) |
| virtual const DtComponentDescriptorList & | sensorDescriptorList () const |
| Accessor/mutator for mySensorDescriptorList. More... | |
| virtual DtComponentDescriptorList & | sensorDescriptorList () |
| virtual void | setSensorDescriptorList (const DtComponentDescriptorList &list) |
| virtual const DtComponentDescriptorList & | controllerDescriptorList () const |
| Accessor/mutator for myControllerDescriptorList. More... | |
| virtual DtComponentDescriptorList & | controllerDescriptorList () |
| virtual void | setControllerDescriptorList (const DtComponentDescriptorList &list) |
| virtual const DtComponentDescriptorList & | actuatorDescriptorList () const |
| Accessor/mutator for myActuatorDescriptorList. More... | |
| virtual DtComponentDescriptorList & | actuatorDescriptorList () |
| virtual void | setActuatorDescriptorList (const DtComponentDescriptorList &list) |
| virtual const DtConnectionDescriptorList & | connectionDescriptorList () const |
| Accessor/mutator for myConnectionDescriptorList. More... | |
| virtual DtConnectionDescriptorList & | connectionDescriptorList () |
| virtual void | setConnectionDescriptorList (const DtConnectionDescriptorList &list) |
| virtual DtDeadReckonTypes | deadReckoningAlgorithm () const |
| Accessor/mutator for myDeadReckoningAlgorithm. More... | |
| virtual void | setDeadReckoningAlgorithm (DtDeadReckonTypes deadReckoningAlgorithm) |
| virtual const DtRwNavigationParameters & | navigationParameters () const |
| Accessor/mutator for myNavigationParameters. More... | |
| virtual DtRwNavigationParameters & | navigationParameters () |
| virtual void | setNavigationParameters (const DtRwNavigationParameters ¶meters) |
| virtual const DtRwDeadReckonThresholds & | deadReckoningThresholds () const |
| Accessor/mutator for myDeadReckoningThresholds. More... | |
| virtual void | setDeadReckoningThresholds (const DtRwDeadReckonThresholds &deadReckoningThresholds) |
| virtual DtReal | mass () const |
| Accessor/mutator for myMass. More... | |
| virtual void | setMass (const DtReal mass) |
| virtual const DtRwSensorSignatureList & | sensorSignatureList () const |
| Accessor/mutator for mySensorSignatureList. More... | |
| virtual DtRwSensorSignatureList & | sensorSignatureList () |
| virtual const DtVrfSubObjectParameterList & | subordinateObjects () const |
| List of subordinates objects to create if fully instantiating from the parameter entry (ignored when object is being created by an AggregateAs message, eg.) More... | |
| virtual void | setSubordinateObjects (const DtVrfSubObjectParameterList &subordinateObjects) |
| virtual const DtVrfSubObjectParameterList & | attachedObjects () const |
| Note that attached objects are not fully supported yet (still need to modify our network interfaces to support the new VR-Link / RPR mechanism for publishing attached objects) and so this list is currently ignored. More... | |
| virtual void | setAttachedObjects (const DtVrfSubObjectParameterList &attachedObjects) |
| virtual DtVrfObjectSubComponentTypes * | localSubComponentTypes () const |
| Get local sub-component types. More... | |
| virtual DtVrfObjectSubComponentTypes * | remoteSubComponentTypes () const |
| Get remote sub-component types. More... | |
| virtual void | putData (std::string &fp, int indentLevel=0) |
| putData writes our type, which is provided by the virtual type accessor of the deriving class. More... | |
| virtual DtlObjPtr | getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) |
| getData is just used to get us past the type in the data stream, since it's not actual stored. More... | |
| virtual const Dt3dBoundingVolume * | boundingVolume () const |
| Set/get the bounding volume of the object. More... | |
| virtual void | setBoundingVolume (const Dt3dBoundingVolume &newBoundingVolume) |
| Set the bounding volume of the object. More... | |
| virtual void | setBoundingVolume (const DtVector &localBvolDiagonal, const DtVector &offset=DtVector::zero()) |
| Set the bounding volume from its components. More... | |
| virtual DtSimBoundingGeometry::DtSimBoundingGeometryType | boundingGeometryType () const |
| Set/get the bounding geometry type of the object. More... | |
| virtual void | setBoundingGeometryType (DtSimBoundingGeometry::DtSimBoundingGeometryType type) |
| virtual double | draft () const |
| For convenience– computes the draft from bounding volume. More... | |
| virtual DtAggregateFormation | formation () const |
| Accessor/mutator for myFormationType. More... | |
| virtual void | setFormation (DtAggregateFormation formation) |
| virtual DtU32 | appearance () const |
| Accessor/mutator for myDefaultAppearance. More... | |
| virtual void | setAppearance (const DtU32 appearance) |
| virtual bool | appearanceSpecified () const |
| virtual const DtString & | displayName () const |
| Accessor/mutator for myDisplayName. More... | |
| virtual void | setDisplayName (const DtString &s) |
| virtual const DtEntityType & | defaultEntityType () const |
| Accessor/mutator for myDefaultEntityType. More... | |
| virtual void | setDefaultEntityType (const DtEntityType &s) |
| virtual const DtString & | displayDescription () const |
| Accessor/mutator for myDisplayDescription. More... | |
| virtual void | setDisplayDescription (const DtString &s) |
| virtual const DtString & | engagementRules () const |
| Accessor/mutator for myEngagementRules. More... | |
| virtual void | setEngagementRules (const DtString &engagementRules) |
| virtual const DtSimResourceManager & | resourceManager () const |
| Accessor/mutator for myResourceManager. More... | |
| virtual void | setResourceManager (const DtSimResourceManager &resourceManager) |
| virtual void | setStateRepositoryUserExtensionType (const DtString &type) |
| Accessor/mutator for myStateRepositoryUserExtensionType. More... | |
| virtual const DtString & | stateRepositoryUserExtensionType () const |
| virtual DtObjectType | objectType () const |
| Accessor/mutator for myObjectType. More... | |
| virtual void | setObjectType (const DtObjectType &objectType) |
| virtual DtObjectType | matchType () const |
| Accessor/mutator for myMatchType. More... | |
| virtual void | setMatchType (const DtObjectType &objectType) |
| virtual bool | taskedBySuperiorUponTaskComplete () const |
| Flag indicating whether or not entity should always go into a 'tasked by superior' state upon completion of a top-level task (a non-subtask task). More... | |
| virtual void | setTaskedBySuperiorUponTaskComplete (bool trueOrFalse) |
| virtual void | setRangeRingPublisherTickTime (double) |
| Tick time for range ring publisher in simulation seconds. Default is -1 (as fast as possible) More... | |
| virtual double | rangeRingPublisherTickTime () const |
| void | setParameterType (const DtString &) |
| Sets/gets type of parameter. More... | |
| const DtString & | parameterType () const |
| virtual void | setStateRepositoryUserExtension (const DtVrfStateRepositoryUserExtension &userExtension) |
| State repository user extension data (extensible at the base class DtVrfObjectStateRepository). More... | |
| virtual DtVrfStateRepositoryUserExtension * | stateRepositoryUserExtension () const |
| virtual void | getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Override so we can figure out what kind of DtVrfStateRepositoryUserExtension to instantiate before calling down to base class version to actually load the parameters. More... | |
| virtual DtTime | underFireTime () const |
| virtual void | setUnderFireTime (DtTime time) |
| virtual bool | underFireTimeSpecified () const |
| virtual DtReal | underFireDistance () const |
| virtual void | setUnderFireDistance (DtReal underFireDistance) |
| virtual bool | underFireDistanceSpecified () const |
| virtual const DtAutoConnectionsListPtr & | autoConnections () const |
| virtual DtAutoConnectionsListPtr & | autoConnections () |
| virtual const std::list < DtSimArtPartDescriptor * > * | configuredArtPartList () const |
| virtual const std::list < DtSimArtPartDescriptor * > * | componentDefaultArtPartList () const |
| virtual void | connectSystems () |
| Creates entity-level connections between systems based on sysdef metadata. More... | |
| bool | operator== (const DtVrfObjectParameters &) const |
| Equality operator. Simply compares the contents of the registry. More... | |
| bool | operator!= (const DtVrfObjectParameters &) const |
| virtual DtEnvironmentSP | xmlEnvironment () |
| virtual DtEnvValueSP | objectNode () |
| virtual const DtReaderWriter * | findVariableBinding (const DtString &) const |
| Find a variable binding from the original items in getSelf. Only valid if getSelf was called for this object. More... | |
| virtual const DtVariableBindingsList & | variableBindingsFromLoad () const |
| virtual DtReaderWriterRegistryData * | findProperty (const DtString &rwName) const |
| Returns a property value as defined in the registry (first look) or the additional parameter data (second look) More... | |
| virtual const DtRwProperties & | parameterData () const |
| Return parameter data accessor. More... | |
| virtual DtRwProperties & | parameterData () |
| virtual const DtRwProperties & | stateData () const |
| Return state data. More... | |
| virtual DtRwProperties & | stateData () |
| virtual void | setPublishParameterData (bool) |
| Set to true if the parameter data is to be published in the extended data portion of the object. More... | |
| virtual bool | publishParameterData () const |
| virtual void | setUiFilename (const DtString &uiFilename) |
| virtual DtString | uiFilename () const |
| virtual void | setCanCreateAsNew (bool) |
| virtual bool | canCreateAsNew () const |
| virtual void | setCanMoveOntoEmbarked (bool) |
| Whether or not this object can be embarked on by checking as to whether or not and entity is moving near it and intersects it at a test location. More... | |
| virtual bool | canMoveOntoEmbarked () const |
| virtual void | rebuildArtPartList () |
| Clears out and rebuilds the articulated part list. More... | |
| virtual void | updatePartOverridesFromActuator (DtSimArtPartDescriptor &artPartDescriptor, const DtComponentDescriptor &actuatorDescriptor, const DtString &systemName=DtString::nullString()) |
| Some older actuator descriptors may contain settings that override the art part settings. More... | |
| virtual const DtComponentSystemDescriptorList & | systemDescriptorList () const |
| See mySystemDescriptorList. More... | |
| virtual DtComponentSystemDescriptorList & | systemDescriptorList () |
| virtual void | setSystemDescriptorList (const DtComponentSystemDescriptorList &list) |
| virtual const DtRwBoolean | deadReckoningAllowGuiOverrides () const |
| Accessor/mutator for myDeadReckoningAllowGuiOverrides. More... | |
| virtual void | setDeadReckoningAllowGuiOverrides (bool allow) |
| virtual const DtRadioDescriptorList & | radioDescriptorList () const |
| See myRadioDescriptorList. More... | |
| virtual DtRadioDescriptorList & | radioDescriptorList () |
| virtual const DtSimSector & | initialSectorOfResponsibility () const |
| virtual void | setInitialSectorOfResponsibility (const DtSimSector &sor) |
| virtual DtTaskExecutionRules & | taskExecutionRules () |
| virtual const DtTaskExecutionRules & | taskExecutionRules () const |
| virtual void | setTaskExecutionRulesFilename (const DtFilename &) |
| virtual const DtReaderWriterFile & | taskExecutionRulesFilename () const |
| virtual void | setHlaFomClass (const DtString &) |
| virtual const DtString & | hlaFomClass () const |
| virtual void | setArtPartList (const DtSimArtPartDescriptorList &partList) |
| virtual const DtSimArtPartDescriptorList & | artPartList () const |
| Public Member Functions inherited from DtReaderWriter | |
| DtReaderWriter () | |
| default constructor More... | |
| DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| real constructor Setting the readonly flag prevents object from writing itself to the stream. More... | |
| DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false) | |
| DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| pseudo-copy constructor More... | |
| DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL) | |
| DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor More... | |
| const DtReaderWriter & | operator= (const DtReaderWriter &orig) |
| assignment operator More... | |
| bool | operator== (const DtReaderWriter &) const |
| Equivalence operator. More... | |
| bool | operator!= (const DtReaderWriter &rhs) |
| virtual | ~DtReaderWriter () |
| destructor More... | |
| virtual void | putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Top level call to write itself to file. More... | |
| virtual void | postPutSelf () |
| Called after either version of put self (file or environment). Default is no-op. More... | |
| virtual void | prePutSelf () |
| Called before either version of put self (file or environment). Default is no-op. More... | |
| virtual void | postGetSelf () |
| Called after either version of getSelf (mtl or environment). Default is no-op. More... | |
| virtual void | preGetSelf () |
| Called before either version of get self (file or environment). Default is no-op. More... | |
| virtual void | writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename()) |
| Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry. More... | |
| virtual DtSymbolString | name () const |
| Accessor for name of this readable/writable object. More... | |
| virtual void | addAlias (const DtSymbolString &alias) |
| Add an alias as an alternative name for this object. More... | |
| virtual void | addAlias (const DtString &alias) |
| virtual bool | hasAlias (const DtSymbolString &alias) |
| virtual const aliasContainer & | aliases () const |
| virtual void | setReadonly (bool flag) |
| Set read-only flag. More... | |
| bool | isReadonly () const |
| virtual void | reset () |
| For those reader/writer items that support it, resets the reader/writer value to original state Default is no-op. More... | |
| virtual int | alignment () const |
| For those items that are sent over the network via HLA, this will give the network alignment. More... | |
| virtual bool | variableIsBound () const |
| virtual void | unbindVariable () |
| Sets the myVariableIsBound flag to false. More... | |
| virtual void | setName (const DtString &) |
| Set the name of the object. More... | |
| virtual const char * | readerWriterType () const |
| Used to supply a string type that this reader writer type is. More... | |
| virtual const char * | xmlType () const |
| virtual DtString | prettyPrint () const |
| Routine to return a human readable form of the reader/writer variable. More... | |
| std::string | debugText () const |
| virtual void | bindVariables (DtVariableBindingsList variableBindings) |
| Runs a variable binding pass on this reader writer and any of its children. More... | |
| virtual std::list < DtVariableNameType > | unboundVariables () const |
| bool | invalid () const |
| virtual bool | hasChild (const DtReaderWriter *p) const |
| Returns true if this variable has a child p in it's chain. More... | |
| virtual bool | hasVariableReference () const |
| Returns true if this item or any item in the registry (recursive) is a variable reference. More... | |
| virtual void | bindLocalVariables (const DtVariableBindingsList &variableBindings) |
| Checks to see if this RW object is a variable reference that can be bound using the provided bindings. More... | |
| virtual void | recordUpdateTime () const |
| Can be implemented in subclasses to stamp the time when updated. More... | |
| virtual bool | wasUpdatedSince (DtTime t) const |
| Can be implemented in subclasses to return true if an update occurred after the specified time. More... | |
| virtual bool | changedSinceLastChecked () |
| Returns true if this objects value has changed since the last time this function was called. More... | |
| virtual bool | peekChangedSinceLastChecked () const |
| Returns the value that changedSinceLastChecked would return but does not reset the internal flag. More... | |
| virtual void | setValueSpecified (bool specified, bool recurse=false) |
| The specified flags are used for optional values. More... | |
| virtual bool | valueSpecified () const |
| virtual bool | isVariableReference () const |
| Specifies whether or not this reader writer is really a variable that is specified elsewhere. More... | |
| virtual void | setIsVariableReference (bool value) |
| virtual void | clearAllVariableReferenceFlags () |
| Clears out all variable reference flags from all readerwriter items in registry recursively. More... | |
| virtual DtSymbolString | variableName () const |
| The variable name, if this object is a variable reference. More... | |
| virtual void | setVariableName (const DtSymbolString variableName) |
| virtual const DtReaderWriter * | defaultRWValue () const |
| The default value to use if the reader/writer object is a variable and that variable is not specified. More... | |
| virtual DtReaderWriter * | defaultRWValue () |
| virtual void | setDefaultRWValue (DtReaderWriter *) |
| Previous default value, if exists, will be removed and replaced with a clone of the supplied variable. More... | |
| virtual bool | checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference()) |
| Give the stream, if the stream contains a default value then set it here. More... | |
| const DtReaderWriterRegistry & | registry () const |
| Collection of child DtReaderWriter nodes owned by this object. More... | |
| DtReaderWriterRegistry & | registry () |
| virtual DtPropertyInterface * | property () |
| virtual const DtPropertyInterface * | property () const |
| virtual DtString | toXml () const |
| virtual DtRwVariableBindings * | generateVariableBindings () const |
| Iterates over the registry (recursively) and returns a variable bindings object that contains all the variables that are contained in this read/writer class. More... | |
| virtual bool | toXml (const DtFilename &) const |
| Writes contents of xml result to the given filename. More... | |
| virtual bool | fromXml (const DtString &) |
| Restores object from given xml string. Returns true if valid. More... | |
| virtual bool | fromXmlFile (const DtFilename &) |
| Restores object from given xml file. More... | |
| virtual void | putSelf (DtEnvironmentSP, DtEnvValueSP parent) const |
| virtual void | putData (DtEnvironmentSP, DtEnvValueSP value) const |
| Override to add attributes of actual data. More... | |
| virtual void | putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const |
| Called when the item is a variable reference. More... | |
| virtual void | getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| virtual void | getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList()) |
| Gets data from the environment value. More... | |
| virtual void | unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings) |
| Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op. More... | |
| virtual void | getVariableReference (DtEnvironmentSP, DtEnvValueSP value) |
| Called when the item is a variable reference. More... | |
Static Public Member Functions | |
| static DtVrfObjectParameters * | creator (DtEnvironmentSP env, DtEnvValueSP *objectNode) |
| Static Public Member Functions inherited from DtVrfObjectParameters | |
| static DtVrfObjectParameters * | createParameters (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) |
| static DtVrfObjectParameters * | createParameters (const char *name, DtEnvironmentSP env=DtEnvironmentSP(), DtEnvValueSP *objectNode=NULL) |
| static DtVrfObjectParameterFactory * | factory () |
| static void | setFactory (DtVrfObjectParameterFactory *factory) |
| static void | addParameterCreatorFcn (const DtString &type, DtSimObjectParametersCreatorFcn fcn) |
| static DtVrfObjectParameters * | creator (DtEnvironmentSP env, DtEnvValueSP *objectNode) |
| Static Public Member Functions inherited from DtReaderWriter | |
| static void | putIndent (std::string &fp, int indentLevel) |
| static const DtVariableBindingsList & | nullVariableReference () |
| static void | setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData) |
| static void | setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData) |
| static void | setPutIndent (bool) |
| static bool | putIndent () |
| static const char * | theXmlType () |
| The type that is used when archiving to an XML stream. More... | |
| static const DtFilename & | appPath () |
| Gets the current working directory. More... | |
| static void | setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn) |
| Sets the function to create the DtReaderWriterFactory. More... | |
| static void | createReaderWriterFactory () |
| static void | cleanupFactory () |
| static DtReaderWriterFactory * | factory () |
| static void | setOutputStream (DtOutputStream *stream) |
| static DtOutputStream & | outputStream () |
| static DtReaderWriter * | createFromXmlFile (const DtFilename &, bool createAsProperty=false) |
| Given a filename, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromXml (const DtString &, bool createAsProperty=false) |
| Given a xml string, returns a newly created reader/writer object from the object found within. More... | |
| static DtReaderWriter * | createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false) |
| Given a xml environment, returns a newly created reader/writer object from the object found within. More... | |
| static DtString | getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root) |
| Gets the named attribute from a DtEnvValueSP. More... | |
Protected Member Functions | |
| DtMovingObjectParameters (const DtMovingObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor. Use clone instead... More... | |
| DtMovingObjectParameters (const DtMovingObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| Protected Member Functions inherited from DtVrfObjectParameters | |
| DtVrfObjectParameters (const DtVrfObjectParameters &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) | |
| copy constructor. Use clone instead. More... | |
| DtVrfObjectParameters (const DtVrfObjectParameters &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| virtual DtVrfSubObjectParameterList * | createSubordinateObjectsList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry) const |
| Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot mySubordinateObjects in init(). More... | |
| virtual DtVrfSubObjectParameterList * | createAttachedObjectsList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry) const |
| Returns a newly created instance of a DtVrfObjectSubComponentTypes, which gets assigned ot myAttachedObjects in init(). More... | |
| virtual void | addArtPartsFromSystem (DtComponentSystemDescriptor *systemDesc, std::list< DtSimArtPartDescriptor * > &artPartList, std::set< DtArtPartType > &partTypesAdded) |
| Adds any art parts defined within a system to the list. More... | |
| virtual void | createAutomaticConnections (DtRwAutoConnection *autoConnection) |
| virtual void | addArtPartDescriptorProcessor (const DtString &componentType, const ArtPartDescriptorProcessor &fcn) |
| Adds a special function for processing additional art part information from a component descriptor. More... | |
| Protected Member Functions inherited from DtReaderWriter | |
| virtual void | bindToRwAsVariable (const DtReaderWriter *rw) |
| Copies values from the specified DtReaderWriter. More... | |
Protected Attributes | |
| DtRwBoolean | myUsingRailMovement |
| Parameter Name: using-rail-movement Parameter Description: If true entity will clamp to a route segment using the segment's heading as it's heading and will use the rail movement system to to provide smoother driving. More... | |
| DtRwInt | myIlluminationRecalcTime |
| Parameter Name: illumination-recalc-time Parameter Description: Amount of time (in seconds) to recalculate entity illumination value based on location and time of day Parameter Units: Parameter Default Value: 300 (5 minutes) More... | |
| DtRwInt | myWeatherAreaRecalcTime |
| Parameter Name: weather-area-recalc-time Parameter Description: Amount of time (in seconds) to recalculate if an entity is in a new weather area. More... | |
| DtRwBoolean | myProtectEmbarkedFromCollateralDamage |
| Parameter Name: protect-embarked-from-collateral-damage Parameter Description: If true, entities embarked on this object are protected from collateral damange. More... | |
| DtRwBoolean | myUseModelArtPartInformation |
| Whether or not to load articulated part information from model as well. More... | |
parameters | |
These parameters are available for setting in the OPD files. {@ | |
| DtRwBoolean | myCanPivot |
| Parameter Name: can-pivot Parameter Description: Indicates whether not the entity can pivot to turn. More... | |
| DtRwReal | myMaxPivotSpeed |
| Parameter Name: max-pivot-speed Parameter Description: The maximum rate at which a ground entity can turn in place. More... | |
| DtRwOffsetVector | myLeftSupport |
| Parameter Name: left-support Parameter Description: Support contact point in body coordinates. More... | |
| DtRwOffsetVector | myRightSupport |
| Parameter Name: right-support Parameter Description: Support contact point in body coordinates. More... | |
| DtRwOffsetVector | myOtherSupport |
| Parameter Name: other-support Parameter Description: Support contact point in body coordinates. More... | |
| DtRwReal | myMaxSpeed |
| Parameter Name: max-speed Parameter Description: The top speed of the entity. More... | |
| DtRwReal | myMaxReverseSpeed |
| Parameter Name: max-reverse-speed Parameter Description: The maximum speed at which an entity can move in reverse. More... | |
| DtRwReal | myTurningRadius |
| Parameter Name: turning-radius Parameter Description: Minimum turning radius. More... | |
| DtRwReal | myMaxSlope |
| Parameter Name: max-slope Parameter Description: For ground entities, the maximum slope, at which the entity can still have acceleration >= 0 in its direction of motion. More... | |
| DtRwReal | myOrderedSpeed |
| Parameter Name: ordered-speed Parameter Description: The speed the entity will move when tasked, unless or until changed by a set speed message. More... | |
| DtRwReal | myMaxAcceleration |
| Parameter Name: max-acceleration Parameter Description: The maximum acceleration rate for the entity. More... | |
| DtRwReal | myMaxStoppingDeceleration |
| Parameter Name: max-deceleration Parameter Description: The maximum (braking) deceleration for the entity. More... | |
| DtRwReal | myMaxLateralAcceleration |
| Parameter Name: max-lateral-acceleration Parameter Description: The maximum lateral (turning) acceleration for the entity. More... | |
| DtRwReal | myFuelEfficiency |
| Parameter Name: fuel-efficiency Parameter Description: Air and ground entities: the number of meters the entity goes on one liter of fuel. More... | |
| DtReaderWriterFile | myObjectGeometryFile |
| Parameter Name: object-geometry-file Parameter Description: If the object geometry is defined (a polygonal model for the entity comparable to a terrain database), it will be used when entities are embarked to task them to move on the embarked item. More... | |
| DtRwBoolean | myUseObjectGeometry |
| Parameter Name: use-object-geometry Parameter Description: If specified use the geometry file for navigation data, embarkation and line of sight. More... | |
| DtRwBoolean | myUseObjectVisuals |
| Parameter Name: use-object-visuals Parameter Description: If specified, use the visuals as defined for tthe model (including potentially multiple models) rather than the user specified file. More... | |
| DtRwBoolean | myEmbedIntoTerrain |
| Parameter Name: embed-into-terrain Parameter Description: If true this object's geometry will be embedded directly into the terrain Parameter Default: False . More... | |
| DtRwDIGuyCharacterInfo | myDIGuyCharacterInfo |
| Parameter Name: di-guy-character Parameter Description: DI-Guy representation of the entity if any. More... | |
| DtRwReal | myDisaggregationRange |
| Parameter Name: disaggregation-range Parameter Description: Maximum distance from this type of entity that will trigger a aggregate to disaggregate. More... | |
| Protected Attributes inherited from DtVrfObjectParameters | |
| DtObjectType | myMatchType |
| An extended form of the DIS/RPR FOM entity enumerated type. More... | |
| DtObjectType | myObjectType |
| DtTaskExecutionRules | myTaskExecutionRules |
| Task execution rules. More... | |
| DtString | myParameterType |
| String that keeps the type of parameter this is Local only – not part of descriptor. More... | |
| std::list < DtSimArtPartDescriptor * > | myConfiguredArtPartList |
| A list containing all the art part descriptors for parts that will be available to the entity. More... | |
| std::list < DtSimArtPartDescriptor * > | myComponentDefaultArtPartList |
| A list containing all the art part descriptor default settings from attached actuators. More... | |
| DtEnvValueSP | myObjectNode |
| DtEnvironmentSP | myEnvironment |
| DtAutoConnectionsListPtr | myAutoConnections |
| DtRwProperties | myParameterData |
| Properties that are specific to this parameter as read from the OPE file. More... | |
| DtRwProperties | myStateData |
| Properties that will be added to the state repository of this particular entity. More... | |
| DtRwReal | myRangeRingPublisherTickTime |
| The tick time of the range ring "publisher" for range ring parameter and state data. More... | |
| DtRwBoolean | myPublishParameterData |
| Parameter Name: publish-parameter-data Parameter Description: Set to true to publish the parameter data in the extended object data under the parameters name. More... | |
| DtRwBoolean | myIlluminationRecalcTime |
| Parameter Name: illumination-recalc-time Parameter Description: Amount of time (in seconds) to recalculate entity illumination value based on location and time of day Parameter Units: Parameter Default Value: 3000 (5 minutes) More... | |
| DtRwString | myDisplayName |
| Parameter Name: display-name Parameter Description: Name to display to user in Simulation Object Editor Parameter Units: Parameter Default Value: More... | |
| DtRwString | myDisplayDescription |
| Parameter Name: display-description Parameter Description: Description of parameter to display in Simulation Object Editor Parameter Units: Parameter Default Value: More... | |
| DtRwString | myUiFilename |
| Parameter Name: ui-filename Parameter Description: name of the .ui file used to configure this entity in the Simulation Object Editor. More... | |
| DtRwBoolean | myCanCreateAsNew |
| Parameter Name: can-create-as-new Parameter Description: Only for Simulation Object Editor. More... | |
| DtRwBoolean | myCanMoveOntoEmbarked |
| Parameter Name: can-move-onto-embarked Parameter Description: Whether or not this object can be embarked on by checking as to whether or not and entity is moving near it and intersects it at a test location. More... | |
| DtRwString | myHlaFomClass |
| Parameter Name: hla-fom-class Parameter Description: Specifies the HLA FOM class to be published. More... | |
| DtRwEntityType | myDefaultEntityType |
| Parameter Name: display-entity-type Parameter Description: Default entity type for platform to use in Simulation Object Editor Parameter Units: Parameter Default Value: More... | |
| DtRwVisualMetaData | myVisualMetaData |
| Parameter Name: visual-meta-data Parameter Description: If defined how the visual meta data will initially be set when this object is created Parameter Units: Parameter Default Value: More... | |
| DtSimArtPartDescriptorList | myArtPartList |
| Parameter Name: art-parts Parameter Description: List of configured articulated parts on this type of entity. More... | |
| DtVariableBindingsList | myGetSelfVariableBindings |
| Local copy of variable bindings used to seed this parameter entry. More... | |
| ArtPartDescProcMap | myArtPartDescProcs |
| DtRwBoundingGeometryType | myBoundingGeometryType |
| Parameter Name: bounding-geometry-type Parameter Description: Describes an object's bounding volume, bounding area, or lack of bounding geometry (in the case of a true point object). More... | |
| DtRwBoundingVolume | myBvol |
| Parameter Name: bounding-volume Parameter Description: Specifies the bounding volume around an object. More... | |
| DtVrfObjectSubComponentTypes * | myLocalSubComponentTypes |
| Parameter Name: local-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used by locally simulated objects. More... | |
| DtVrfObjectSubComponentTypes * | myRemoteSubComponentTypes |
| Parameter Name: remote-objects Parameter Description: Specifies the state-repository, net-interface, task-manager, radio, and component-manager to be used for remotely simulated objects. More... | |
| DtRwFormationType | myFormationType |
| Parameter Name: formation Parameter Description: (Optional) One of the following: More... | |
| DtRwAppearance | myDefaultAppearance |
| Parameter Name: default-appearance Parameter Description: Unsigned int used to set default valus for the DIS/RPR appearance bits. More... | |
| DtRwForceType | myForceType |
| Parameter Name: force-type Parameter Description: The force to which the object belongs. More... | |
| DtRwString | myCategory |
| Parameter Name: category Parameter Description: The category string to use when creating an echelon ID. More... | |
| DtRwString | myEchelonLevel |
| Parameter Name: echelon-level Parameter Description: The echelon level to use for this entity when creating an echelon ID. More... | |
| DtRwBoolean | myOrganized |
| Parameter Name: is-organized Parameter Description: Specifies that the entity is part of the entity hierarchy and requires an echelon ID. More... | |
| DtRwReal | myMinTickPeriod |
| Parameter Name: min-tick-period Parameter Description: Specifies the shortest period of time, in seconds, that can elapse between ticks of an entity's components. More... | |
| DtRwReal | myMinTickPeriodVariance |
| Parameter Name: min-tick-period-variance Parameter Description: Specifies an amount within which the min-tick-period can vary. More... | |
| DtRwDeadReckonTypes | myDeadReckoningAlgorithm |
| Parameter Name: dr-algorithm Parameter Description: The VR-Link dead-reckoning algorithm to use when publishing this entity. More... | |
| DtRwNavigationParameters | myNavigationParameters |
| DtRwDeadReckonThresholds | myDeadReckoningThresholds |
| Parameter Name: dr-thresholds Parameter Description: The translation, rotation, and aggregate dimension thresholds used when publishing this entity. More... | |
| DtRwBoolean | myDeadReckoningAllowGuiOverrides |
| DtRadioDescriptorList | myRadioDescriptorList |
| Parameter Name: radios Parameter Description: List of all radios on the entity. More... | |
| DtComponentSystemDescriptorList | mySystemDescriptorList |
| Parameter Name: systems Parameter Description: List of system descriptors. More... | |
| DtComponentDescriptorList | mySensorDescriptorList |
| Parameter Name: sensors Parameter Description: List of sensor controller component descriptors. More... | |
| DtComponentDescriptorList | myControllerDescriptorList |
| Parameter Name: controllers Parameter Description: List of controller component descriptors. More... | |
| DtComponentDescriptorList | myActuatorDescriptorList |
| Parameter Name: actuators Parameter Description: List of actuator component descriptors. More... | |
| DtConnectionDescriptorList | myConnectionDescriptorList |
| Parameter Name: connections Parameter Description: The connections (Example 5.2, line 19) entry specifies how the components connect to one another (through ports, port groups, or both). More... | |
| DtRwReal | myMass |
| Parameter Name: mass Parameter Description: The mass of the entity. More... | |
| DtRwSensorSignatureList | mySensorSignatureList |
| Parameter Name: sensor-signatures Parameter Description: Parameter Default Value: More... | |
| DtVrfSubObjectParameterList * | mySubordinateObjects |
| Parameter Name: subordinate-objects Parameter Description: (Optional) List of entries specifying subordinate objects to be created as part of an aggregate object. More... | |
| DtVrfSubObjectParameterList * | myAttachedObjects |
| Parameter Name: attached-objects Parameter Description: Parameter Default Value: . More... | |
| DtRwString | myEngagementRules |
| Parameter Name: engagement-rules Parameter Description: (Optional) The engagement rules the entity will use unless/until changed by a set engagement rules message. More... | |
| DtSimResourceManager | myResourceManager |
| Parameter Name: resources Parameter Description: Specifies the types and amount of resources the entity has. More... | |
| DtRwString | myStateRepositoryUserExtensionType |
| Parameter Name: state-repository-extension-type Parameter Description: Type of state repository extensions class to instantiate. More... | |
| DtRwBoolean | myTaskedBySuperiorUponTaskComplete |
| Parameter Name: tasked-by-superior-upon-task-complete Parameter Description: Flag indicating whether or not subordinates should automatically resume a tasked-by-superior status upon completing an independent task. More... | |
| DtVrfStateRepositoryUserExtension * | myStateRepositoryUserExtension |
| Parameter Name: user-extension Parameter Description: Extension to the state repository class. More... | |
| DtRwTime | myUnderFireTime |
| Parameter Name: under-fire-time Parameter Description: Deprecated. More... | |
| DtRwReal | myUnderFireDistance |
| Parameter Name: under-fire-distance Parameter Description: Deprecated. More... | |
| DtSimSector | myInitialSectorOfResponsibility |
| Parameter Name: initial-sector-of-responsibility Parameter Description: The sector of responsibility for this entity when the entity is first created. More... | |
| DtReaderWriterFile | myTaskExecutionRulesFilename |
| Parameter Name: task-execution-rules Parameter Description: The name of the file that contains the task execution rules for this entity. More... | |
| Protected Attributes inherited from DtReaderWriter | |
| const DtSymbolString | myName |
| DtReaderWriterRegistry | myRegistry |
| DtReaderWriterRegistry * | myParentRegistry |
| bool | myValueSpecified |
| bool | myReadOnlyFlag |
| bool | myIsVariableReference |
| DtSymbolString | myVariableName |
| bool | myVariableIsBound |
| DtReaderWriter * | myDefaultValue |
| aliasContainer | myAliases |
| Container for the aliases which represent alternative names for the object. More... | |
| bool | myInvalid |
| Set to true if there is a problem reading this item. More... | |
| bool | myChangedFlag |
| Set to true when value changes Set to false when value checked with changedSinceLastChecked. More... | |
The moving-object-param parameter type is used for objects that are capable of movement, such as individual entities and aggregates.
Parameters include support points, maximum speed, maximum reverse speed, turning radius, maximum slope, ordered speed, maximum acceleration, maximum deceleration, and fuel efficiency. Aggregates are moving objects and have this parameter type. All of the platform-specific parameter types derive from this one.
| DtMovingObjectParameters::DtMovingObjectParameters | ( | const DtString & | name = DtString::nullString(), |
| DtReaderWriterRegistry * | parentRegistry = NULL, |
||
| DtEnvironmentSP | env = DtEnvironmentSP(), |
||
| DtEnvValueSP * | objectNode = NULL |
||
| ) |
constructor with parameters to set up read/writability correctly
| DtMovingObjectParameters::DtMovingObjectParameters | ( | const DtSymbolString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL, |
||
| DtEnvironmentSP | env = DtEnvironmentSP(), |
||
| DtEnvValueSP * | objectNode = NULL |
||
| ) |
|
virtual |
destructor
|
protected |
copy constructor. Use clone instead...
|
protected |
| const DtMovingObjectParameters& DtMovingObjectParameters::operator= | ( | const DtMovingObjectParameters & | orig | ) |
assignment operator
|
virtual |
Reimplemented from DtVrfObjectParameters.
Reimplemented in DtFixedWingEntityParameters, DtRotaryWingEntityParameters, DtAggregateObjectParameters, DtGroundVehicleParameters, DtCulturalFeatureParameters, DtHumanParameters, DtSubSurfaceEntityParameters, DtSurfaceEntityParameters, DtMissileParameters, DtBombParameters, and DtBallisticMissileParameters.
|
virtual |
Reimplemented from DtVrfObjectParameters.
Reimplemented in DtFixedWingEntityParameters, DtAggregateObjectParameters, DtGroundVehicleParameters, DtCulturalFeatureParameters, DtRotaryWingEntityParameters, DtSurfaceEntityParameters, DtHumanParameters, DtMissileParameters, DtBombParameters, DtBallisticMissileParameters, and DtSubSurfaceEntityParameters.
|
virtual |
Should return the type of object this is a parameter block for.
Use the strings in vrfParamTypes.h.
Reimplemented from DtVrfObjectParameters.
Reimplemented in DtMissileParameters, DtFixedWingEntityParameters, DtGroundVehicleParameters, DtBombParameters, DtCulturalFeatureParameters, DtAggregateObjectParameters, DtRotaryWingEntityParameters, DtHumanParameters, DtSurfaceEntityParameters, DtSubSurfaceEntityParameters, and DtBallisticMissileParameters.
|
static |
|
virtual |
For example, US ground vehicle (1 1 225 0 0 0 0) and US Large wheeled utility vehicle (1 1 225 7 0 0 0) might both have DtGroundVehicleParameters parameter blocks. If some or even all parameters are left unspecified for (1 1 225 7 0 0 0), it can inherit them from (1 1 225 0 0 0 0), its DIS/RPR ancestor.
The direct ancestor of a parameter block might use a parameter type that is different (and most likely a class the parameter block is derived from). Every parameter block type also knows how to inherit from the type it is derived from.
Reimplemented from DtVrfObjectParameters.
Reimplemented in DtFixedWingEntityParameters, DtRotaryWingEntityParameters, DtHumanParameters, DtAggregateObjectParameters, DtGroundVehicleParameters, DtSurfaceEntityParameters, DtCulturalFeatureParameters, DtSubSurfaceEntityParameters, DtBombParameters, and DtMissileParameters.
|
virtual |
|
virtual |
Accessor/mutator for myIlluminationRecalcTime.
|
virtual |
|
virtual |
Accessor/mutator for myWeatherAreaRecalcTime.
|
virtual |
|
virtual |
Accessor/mutator for myCanPivot.
|
virtual |
|
virtual |
Accessor/mutator for myProtectEmbarkedFromCollateralDamage.
|
virtual |
|
virtual |
Accessor/mutator for myMaxPivotSpeed.
|
virtual |
|
virtual |
Accessor/mutator for myLeftSupport.
|
virtual |
|
virtual |
Accessor/mutator for myRightSupport.
|
virtual |
|
virtual |
Accessor/mutator for myOtherSupport.
|
virtual |
|
virtual |
Accessor/mutator for myMaxSpeed.
|
virtual |
|
virtual |
Accessor/mutator for myMaxReverseSpeed.
|
virtual |
|
virtual |
Accessor/mutator for myUseModelArtPartInformation.
|
virtual |
|
virtual |
Accessor/mutator for myTurningRadius.
|
virtual |
|
virtual |
Accessor/mutator for myMaxSlope.
|
virtual |
|
virtual |
Accessor/mutator for myOrderedSpeed.
|
virtual |
|
virtual |
Accessor/mutator for myMaxAcceleration.
|
virtual |
|
virtual |
Accessor/mutator for myMaxStoppingDeceleration.
|
virtual |
|
virtual |
Accessor/mutator for myMaxLateralAcceleration.
|
virtual |
|
virtual |
Accessor/mutator for myFuelEfficiency.
|
virtual |
|
virtual |
Accessor/mutator for myUseObjectGeometry.
|
virtual |
|
virtual |
Accessor/mutator for myUseObjectVisuals.
|
virtual |
|
virtual |
Accessor/mutator for myObjectGeometryFile.
|
virtual |
|
virtual |
Accessor/mutator for myEmbedIntoTerrain.
|
virtual |
|
virtual |
Accessor/mutator for #myDIGuyCharacter.
|
virtual |
|
virtual |
Maximum disaggregation distance in meters.
|
virtual |
|
virtual |
Accessor/mutator for myUsingRailMovement.
|
virtual |
|
protected |
Parameter Name: can-pivot
Parameter Description: Indicates whether not the entity can pivot to turn.
Parameter Default: False
|
protected |
Parameter Name: max-pivot-speed
Parameter Description: The maximum rate at which a ground entity can turn in place.
Parameter Default Value: 0.
Parameter Units: meters/second
|
protected |
Parameter Name: left-support
Parameter Description: Support contact point in body coordinates.
Sub-parameter:
|
protected |
Parameter Name: right-support
Parameter Description: Support contact point in body coordinates.
Sub-parameter:
|
protected |
Parameter Name: other-support
Parameter Description: Support contact point in body coordinates.
Sub-parameter:
|
protected |
Parameter Name: max-speed
Parameter Description: The top speed of the entity.
Parameter Default Value: 15.
Parameter Units: meters/second
|
protected |
Parameter Name: max-reverse-speed
Parameter Description: The maximum speed at which an entity can move in reverse.
Parameter Default Value: 10.
Parameter Units: meters/second
|
protected |
Parameter Name: turning-radius
Parameter Description: Minimum turning radius.
This will be used differently by different movement models, and does not apply to all of them (such as missiles). Used by non-pivoting ground vehicles; used by surface and subsurface entities for low-speed turns (at high speed, lateral acceleration limits minimum turn radius).
Parameter Default Value: 5.
Parameter Units: meters
|
protected |
Parameter Name: max-slope
Parameter Description: For ground entities, the maximum slope, at which the entity can still have acceleration >= 0 in its direction of motion.
Therefore, if a ground vehicle is heading up a hill, as soon as the slope of the hill is greater than the max-slope, it will no longer be able to accelerate up the slope. At best, without any friction or other source of negative acceleration, it will remain at its current speed. If the slope increases, it will start decelerating and even start rolling backwards. If the entity is moving down a hill, the opposite is true.
For subsurface entities, this is the maximum pitch that they will adopt in the simple actuator model when ascending or descending.
The units are the fraction rise-over-run, i.e. tangent of the angle of inclination. Parameter Default Value: 1. Parameter Units: ratio
|
protected |
Parameter Name: ordered-speed
Parameter Description: The speed the entity will move when tasked, unless or until changed by a set speed message.
Parameter Default Value: 10.
Parameter Units: meters/second
|
protected |
Parameter Name: max-acceleration
Parameter Description: The maximum acceleration rate for the entity.
Parameter Default Value: 4.5
Parameter Units: meters/second/second
|
protected |
Parameter Name: max-deceleration
Parameter Description: The maximum (braking) deceleration for the entity.
Parameter Default Value: 4.5
Parameter Units: meters/second/second
|
protected |
Parameter Name: max-lateral-acceleration
Parameter Description: The maximum lateral (turning) acceleration for the entity.
For fixed wing aircraft, this is the maximum acceleration during flying maneuvers (i.e., in horizontal and vertical turns). FWA default value is 49.0.
Parameter Default Value: 5.0
Parameter Units: meters/second/second
|
protected |
Parameter Name: fuel-efficiency
Parameter Description: Air and ground entities: the number of meters the entity goes on one liter of fuel.
Surface and subsurface entities: The speed, in m/s, that is specified corresponding to the fuel range specified in the movement system. E.g. if a ship range is specified as 1000km at 8 m/s, then the fuel efficiency parameter value is 8.0 (and the fuel range is 1000). A value of 0 indicates we are not modeling fuel consumption (i.e. we will never run out of fuel).
Parameter Default Value: 1000.
Parameter Units: meters/liter
|
protected |
Parameter Name: object-geometry-file
Parameter Description: If the object geometry is defined (a polygonal model for the entity comparable to a terrain database), it will be used when entities are embarked to task them to move on the embarked item.
If this item is not defined (or cannot be loaded) then entities cannot be tasked once embarked on this item.
Parameter Default Value:
|
protected |
Parameter Name: use-object-geometry
Parameter Description: If specified use the geometry file for navigation data, embarkation and line of sight.
If false, even if specified, do not use.
Parameter Default Value: True
|
protected |
Parameter Name: use-object-visuals
Parameter Description: If specified, use the visuals as defined for tthe model (including potentially multiple models) rather than the user specified file.
Parameter Default Value: False
|
protected |
Parameter Name: embed-into-terrain
Parameter Description: If true this object's geometry will be embedded directly into the terrain Parameter Default: False
.
|
protected |
Parameter Name: di-guy-character
Parameter Description: DI-Guy representation of the entity if any.
Set the DI Guy Character, it's default appearance and animation
Parameter Default Value:
|
protected |
Parameter Name: disaggregation-range
Parameter Description: Maximum distance from this type of entity that will trigger a aggregate to disaggregate.
Parameter Units: meters Parameter Default Value: 1000.0
|
protected |
Parameter Name: using-rail-movement
Parameter Description: If true entity will clamp to a route segment using the segment's heading as it's heading and will use the rail movement system to to provide smoother driving.
If no segments are available to follow will default to regular movement system. Parameter Units: Parameter Default Value: false
|
protected |
Parameter Name: illumination-recalc-time
Parameter Description: Amount of time (in seconds) to recalculate entity illumination value based on location and time of day Parameter Units: Parameter Default Value: 300 (5 minutes)
|
protected |
Parameter Name: weather-area-recalc-time
Parameter Description: Amount of time (in seconds) to recalculate if an entity is in a new weather area.
Parameter Units: Parameter Default Value: 10 seconds
|
protected |
Parameter Name: protect-embarked-from-collateral-damage
Parameter Description: If true, entities embarked on this object are protected from collateral damange.
This will be true for any entity that is also embarked on any entity embarked on this object (etc.) Parameter Units: Parameter Default Value: True
|
protected |
Whether or not to load articulated part information from model as well.
If there is an object geometry model will use that rather than looking for the model in the definitions Parameter Units: Parameter Default Value: true