VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
movingObjectParameters.h
Go to the documentation of this file.
1 /****************************************************************************
2  * Copyright (c) 2021 MAK Technologies, Inc.
3  * All rights reserved.
4  ****************************************************************************/
5 
9 
10 #pragma once
11 
14 #include "readerWriter/rwVector.h"
17 
18 class DtEnvironment;
19 
33 {
34 public:
35 
37  DtMovingObjectParameters(const DtString& name = DtString::nullString(),
38  DtReaderWriterRegistry* parentRegistry = NULL,
39  DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);
41  DtReaderWriterRegistry* parentRegistry = NULL,
42  DtEnvironmentSP env = DtEnvironmentSP(), DtEnvValueSP* objectNode = NULL);
43 
45  virtual ~DtMovingObjectParameters() override;
46 
47 protected:
50  const DtString& name = DtString::nullString(),
51  DtReaderWriterRegistry* parentRegistry = NULL);
53  const DtSymbolString& name,
54  DtReaderWriterRegistry* parentRegistry = NULL);
55 
56 public:
58  const DtMovingObjectParameters& operator=
59  (const DtMovingObjectParameters& orig);
60 
62  const DtString& name = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = NULL) const override;
64  const DtSymbolString& name, DtReaderWriterRegistry* parentRegistry = NULL) const override;
65 
68  virtual DtString type() const override;
69 
71  static DtVrfObjectParameters * creator(DtEnvironmentSP env, DtEnvValueSP* objectNode);
72 
75  virtual bool inheritValues(const DtVrfObjectParameters* benefactor) override;
76  virtual void inheritValuesFromThisType (
77  const DtMovingObjectParameters* benefactor);
78 
79 private:
82 public:
83 
86  virtual int illuminationRecalcTime() const;
87  virtual void setIlluminationRecalcTime(int newValue);
89 
92  virtual int weatherAreaRecalcTime() const;
93  virtual void setWeatherAreaRecalcTime(int newValue);
95 
98  virtual bool canPivot() const;
99  virtual void setCanPivot (bool newValue);
101 
104  virtual bool protectEmbarkedFromCollateralDamage() const;
105  virtual void setProtectEmbarkedFromCollateralDamage (bool newValue);
107 
110  virtual DtReal maxPivotSpeed() const;
111  virtual void setMaxPivotSpeed (DtReal maxSpeed);
113 
116  virtual const DtVector& leftSupport() const;
117  virtual void setLeftSupport (const DtVector& newLeftSupport);
119 
122  virtual const DtVector& rightSupport() const;
123  virtual void setRightSupport (const DtVector& newRightSupport);
125 
128  virtual const DtVector& otherSupport() const;
129  virtual void setOtherSupport (const DtVector& newOtherSupport);
131 
134  virtual DtReal maxSpeed() const;
135  virtual void setMaxSpeed (DtReal speed);
137 
140  virtual DtReal maxReverseSpeed() const;
141  virtual void setMaxReverseSpeed (DtReal speed);
143 
146  virtual bool useModelArtPartInformation() const;
147  virtual void setUseModelArtPartInformation(bool);
149 
152  virtual DtReal turningRadius() const;
153  virtual void setTurningRadius (DtReal turningRadius);
155 
158  virtual DtReal maxSlope() const;
159  virtual void setMaxSlope (DtReal slope);
161 
164  virtual DtReal orderedSpeed() const;
165  virtual void setOrderedSpeed (DtReal speed);
167 
170  virtual DtReal maxAcceleration() const;
171  virtual void setMaxAcceleration (const DtReal maxAcceleration);
173 
176  virtual DtReal maxStoppingDeceleration() const;
177  virtual void setMaxStoppingDeceleration (const DtReal maxStoppingDeceleration);
179 
182  virtual DtReal maxLateralAcceleration() const;
183  virtual void setMaxLateralAcceleration (const DtReal maxLateralAcceleration);
185 
188  virtual bool useObjectGeometry() const;
189  virtual void setUseObjectGeometry(bool);
191 
194  virtual bool useObjectVisuals() const;
195  virtual void setUseObjectVisuals(bool);
197 
200  virtual const DtString& objectGeometryFile() const;
201  virtual void setObjectGeometryFile(const DtFilename&);
203 
206  virtual bool embedIntoTerrain() const;
207  virtual void setEmbedIntoTerrain(bool);
209 
212  virtual void setDIGuyCharacterInfo(const DtRwDIGuyCharacterInfo & info);
213  virtual const DtRwDIGuyCharacterInfo & diguyCharacterInfo() const;
215 
218  virtual void setUsingRailMovement(bool rails);
219  virtual bool usingRailMovement() const;
221 
222  virtual void postGetSelf() override;
223 
224 protected:
225 
229 
235 
242 
252 
262 
272 
278 
285 
294 
311 
318 
324 
330 
338 
347 
353 
359 
364 
370 
379 
386 
393 
400 
406 
407 };
Instances of DtVrfObjectParameters are the readable/writeable objects that contain the information ne...
Definition: vrfObjectParameters.h:64
This class allows one to collect and compare strings using an index number instead of having to do st...
Definition: symbolString.h:27
#define DT_DLL_vrfobjparam
This file is used to determine how to build.
Definition: vrfobjparamDefines.h:28
DtRwReal myMaxStoppingDeceleration
Parameter Name: max-deceleration Parameter Description: The maximum (braking) deceleration for the en...
Definition: movingObjectParameters.h:329
DtRwBoolean myUseObjectVisuals
Parameter Name: use-object-visuals Parameter Description: If specified, use the visuals as defined fo...
Definition: movingObjectParameters.h:358
DtRwDIGuyCharacterInfo myDIGuyCharacterInfo
Parameter Name: di-guy-character Parameter Description: DI-Guy representation of the entity if any...
Definition: movingObjectParameters.h:369
virtual bool inheritValues(const DtVrfObjectParameters *benefactor)
Values left unspecified may be inherited from a parameter block of the same type, typically an ancest...
virtual DtVrfObjectParameters * clone(const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void postGetSelf() override
Override to fill out the resource manager with resources provided by systems.
Definition: readerWriterRegistry.h:39
DtRwReal myMaxSlope
Parameter Name: max-slope Parameter Description: For ground entities, the maximum slope...
Definition: movingObjectParameters.h:310
static DtVrfObjectParameters * creator(DtEnvironmentSP env, DtEnvValueSP *objectNode)
DtRwReal myOrderedSpeed
Parameter Name: ordered-speed Parameter Description: The speed the entity will move when tasked...
Definition: movingObjectParameters.h:317
DtRwBoolean myProtectEmbarkedFromCollateralDamage
Parameter Name: protect-embarked-from-collateral-damage Parameter Description: If true...
Definition: movingObjectParameters.h:399
DtRwReal myMaxReverseSpeed
Parameter Name: max-reverse-speed Parameter Description: The maximum speed at which an entity can mov...
Definition: movingObjectParameters.h:284
DtRwOffsetVector myOtherSupport
Parameter Name: other-support Parameter Description: Support contact point in body coordinates...
Definition: movingObjectParameters.h:271
Contains the DtRwDIGuyCharacterInfo class declaration.
DtRwOffsetVector myRightSupport
Parameter Name: right-support Parameter Description: Support contact point in body coordinates...
Definition: movingObjectParameters.h:261
DtRwInt myWeatherAreaRecalcTime
Parameter Name: weather-area-recalc-time Parameter Description: Amount of time (in seconds) to recalc...
Definition: movingObjectParameters.h:392
Description: Readable, Writable int.
Definition: rwInt.h:25
DtRwBoolean myEmbedIntoTerrain
Parameter Name: embed-into-terrain Parameter Description: If true this object's geometry will be embe...
Definition: movingObjectParameters.h:363
virtual void inheritValuesFromThisType(const DtVrfObjectParameters *benefactor)
The moving-object-param parameter type is used for objects that are capable of movement, such as individual entities and aggregates. DtMovingObjectParameters; holds all of the configurable parameters for the DtVrfMovingObjectStateRepository class. 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. .
Definition: movingObjectParameters.h:32
DtRwBoolean myCanPivot
Parameter Name: can-pivot Parameter Description: Indicates whether not the entity can pivot to turn...
Definition: movingObjectParameters.h:234
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
DtRwReal myMaxLateralAcceleration
Parameter Name: max-lateral-acceleration Parameter Description: The maximum lateral (turning) acceler...
Definition: movingObjectParameters.h:337
The DtRwDIGuyCharactertInfo class is a readable/writable class that can store itself and read itself ...
Definition: rwDIGuyCharacterInfo.h:32
DtRwBoolean myUseObjectGeometry
Parameter Name: use-object-geometry Parameter Description: If specified use the geometry file for nav...
Definition: movingObjectParameters.h:352
Specialized vector that can be used for the knowledge of an "offset" rather than location vector...
Definition: rwVector.h:112
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
DtRwReal myTurningRadius
Parameter Name: turning-radius Parameter Description: Minimum turning radius. This will be used diffe...
Definition: movingObjectParameters.h:293
DtRwInt myIlluminationRecalcTime
Parameter Name: illumination-recalc-time Parameter Description: Amount of time (in seconds) to recalc...
Definition: movingObjectParameters.h:385
virtual DtString type() const
Returns a string identifying the type of parameter descriptor. Used to create the descriptor on read ...
DT_DLL_readerWriter std::shared_ptr< DtEnvironment > DtEnvironmentSP
Definition: readerWriter.h:30
DtRwReal myMaxSpeed
Parameter Name: max-speed Parameter Description: The top speed of the entity. Parameter Default Value...
Definition: movingObjectParameters.h:277
DtRwReal myMaxPivotSpeed
Parameter Name: max-pivot-speed Parameter Description: The maximum rate at which a ground entity can ...
Definition: movingObjectParameters.h:241
DtRwReal myMaxAcceleration
Parameter Name: max-acceleration Parameter Description: The maximum acceleration rate for the entity...
Definition: movingObjectParameters.h:323
Using a DtReaderWriterFile allows a DtReaderWriter object to be read in from an MTL stream contained ...
Definition: readerWriterFile.h:35
DtRwBoolean myUsingRailMovement
Parameter Name: using-rail-movement Parameter Description: If true entity will clamp to a route segme...
Definition: movingObjectParameters.h:378
DtReaderWriterFile myObjectGeometryFile
Parameter Name: object-geometry-file Parameter Description: If the object geometry is defined (a poly...
Definition: movingObjectParameters.h:346
File: rwVector.h.
DtRwOffsetVector myLeftSupport
Parameter Name: left-support Parameter Description: Support contact point in body coordinates...
Definition: movingObjectParameters.h:251
DtRwBoolean myUseModelArtPartInformation
Whether or not to load articulated part information from model as well. If there is an object geometr...
Definition: movingObjectParameters.h:405

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)