VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
embarkationSlotEntry.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2024 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
10 
11 #pragma once
12 
14 
15 #include "readerWriter/rwVector.h"
16 #include "vrfutil/rwTaitBryan.h"
17 #include "vrfutil/rwAppearance.h"
19 #include <readerWriter/rwInt.h>
20 #include <readerWriter/rwString.h>
21 #include <readerWriter/rwBoolean.h>
22 
28 {
29 public:
32  parentRegistry = NULL);
33 
35  virtual ~DtEmbarkationSlotEntry() override;
36 
38  DtEmbarkationSlotEntry(const DtString& name,
39  const DtEmbarkationSlotEntry& orig,
40  DtReaderWriterRegistry* parentRegistry = NULL);
41 
44  const DtEmbarkationSlotEntry& orig,
45  DtReaderWriterRegistry* parentRegistry = NULL);
46 
49 
50  virtual DtEmbarkationSlotEntry* clone(const DtString& name,
51  DtReaderWriterRegistry* parentRegistry = NULL) const;
52 
55  const DtRangedEntityType& object() const;
56  void setObject(const DtRangedEntityType&);
58 
61  const DtVector& position() const;
62  void setPosition(const DtVector&);
64 
67  const DtRwTaitBryan orientation() const;
68  void setOrientation(const DtTaitBryan&);
70 
73  int numberOfEntities() const;
74  void setNumberOfEntities(int);
76 
79  const DtAppearance& appearance() const;
80  void setAppearance(const DtAppearance&);
81  void setAppearance(int);
83 
86  bool jumpToLocation() const;
87  void setJumpToLocation(bool);
89 
92  bool turnToHeading() const;
93  void setTurnToHeading(bool);
95 
98  bool orientOnIngress() const;
99  void setOrientOnIngress(bool);
101 
104  bool invisibleWhenEmbarked() const;
105  void setInvisibleWhenEmbarked(bool);
107 
110  const DtString& slotName() const;
111  void setSlotName(const DtString&);
113 
116  const DtString& slotType() const;
117  void setSlotType(const DtString&);
119 
122  const DtString& stationName() const;
123  void setStationName(const DtString&);
125 
128  const DtString& ingressTechnique() const;
129  void setIngressTechnique(const DtString&);
131 
134  const DtString& egressTechnique() const;
135  void setEgressTechnique(const DtString&);
137 
140  const DtString& animation() const;
141  void setAnimation(const DtString&);
143 
144  virtual const char* readerWriterType() const override;
145 
146  virtual DtEmbarkationSlotEntry* clone() const;
147 
149  virtual bool operator==(const DtEmbarkationSlotEntry&) const;
150  virtual bool operator!=(const DtEmbarkationSlotEntry&) const;
151 
154  virtual void putData(DtEnvironmentSP, DtEnvValueSP parent) const override;
155  virtual void getData(const DtEnvironmentSP, const DtEnvValueSP value,
157  const DtVariableBindingsList& bindings = DtVariableBindingsList()) override;
158 
160  static const char* theXmlType();
161 
162  virtual const char* xmlType() const override {
163  return theXmlType();
164  }
166 
167 private:
170 
171 protected:
172 
176 
181 
186 
191 
196 
202 
208 
214 
220 
226 
232 
238 
244 
249 
255 
262 };
263 
265 {
266  myObject = o;
267 }
268 
270 {
271  return myObject;
272 }
273 
274 inline void DtEmbarkationSlotEntry::setPosition(const DtVector& v)
275 {
276  myPosition = v;
277 }
278 
279 inline const DtVector& DtEmbarkationSlotEntry::position() const
280 {
281  return myPosition;
282 }
283 
284 inline void DtEmbarkationSlotEntry::setOrientation(const DtTaitBryan& o)
285 {
286  myOrientation = o;
287 }
288 
290 {
291  return myOrientation;
292 }
293 
294 inline void DtEmbarkationSlotEntry::setAppearance(const DtAppearance& a)
295 {
296  myAppearance = a;
297 }
298 
300 {
301  myAppearance.setAppearance(a);
302 }
303 
304 inline const DtAppearance& DtEmbarkationSlotEntry::appearance() const
305 {
306  return myAppearance;
307 }
308 
310 {
311  myNumberOfEntities = a;
312 }
313 
315 {
316  return myNumberOfEntities;
317 }
318 
320 {
321  myJumpToLocation = b;
322 }
323 
325 {
326  return myJumpToLocation;
327 }
328 
330 {
331  myTurnToHeading = b;
332 }
333 
335 {
336  return myTurnToHeading;
337 }
338 
340 {
341  myOrientOnIngress = b;
342 }
343 
345 {
346  return myOrientOnIngress;
347 }
348 
350 {
352 }
353 
355 {
357 }
358 
360 {
361  mySlotName = s;
362 }
363 
365 {
366  return mySlotName;
367 }
368 
370 {
371  mySlotType = s;
372 }
373 
375 {
376  return mySlotType;
377 }
378 
380 {
381  myStationName = s;
382 }
383 
385 {
386  return myStationName;
387 }
388 
390 {
391  myIngressTechnique = s;
392 }
393 
395 {
396  return myIngressTechnique;
397 }
398 
400 {
401  myEgressTechnique = s;
402 }
403 
405 {
406  return myEgressTechnique;
407 }
408 
410 {
411  myAnimation = s;
412 }
413 
415 {
416  return myAnimation;
417 }
418 
bool operator==(const DtReaderWriter &) const
Equivalence operator.
DtRwAppearance myAppearance
Parameter Name: embarked-appearance Parameter Description: Parameter Default Value: ...
Definition: embarkationSlotEntry.h:195
DtRwBoolean myInvisibleWhenEmbarked
Parameter Name: invisible-when-embarked Parameter Description: Whether or not, when embarked...
Definition: embarkationSlotEntry.h:231
virtual const char * readerWriterType() const
Used to supply a string type that this reader writer type is. This can be used in place of dynamic-ca...
void setOrientOnIngress(bool)
Accessor/mutator for myOrientOnIngress.
Definition: embarkationSlotEntry.h:339
DtRwInt myNumberOfEntities
Parameter Name: number-of-entities Parameter Description: Number of entities that can occupy this slo...
Definition: embarkationSlotEntry.h:207
#define DT_DLL_vrfobjparam
This file is used to determine how to build.
Definition: vrfobjparamDefines.h:28
virtual const char * xmlType() const override
Routines to archive/dearchive from an XML Environment.
Definition: embarkationSlotEntry.h:162
DtRwString myEgressTechnique
Parameter Name: egress-technique Parameter Description: When getting out of slot, rather than doing t...
Definition: embarkationSlotEntry.h:260
const DtString & animation() const
Accessor/mutator for myAnimation.
Definition: embarkationSlotEntry.h:414
DtRwBoolean myTurnToHeading
Parameter Name: turn-to-heading Parameter Description: Turn to correct heading on start of egress rou...
Definition: embarkationSlotEntry.h:219
DtRwString myStationName
Parameter Name: station-name Parameter Description: DIS station name for this slot Parameter Default ...
Definition: embarkationSlotEntry.h:248
void setAppearance(const DtAppearance &)
Accessor/mutator for myAppearance.
Definition: embarkationSlotEntry.h:294
const DtRwTaitBryan orientation() const
Accessor/mutator for myOrientation.
Definition: embarkationSlotEntry.h:289
virtual DtlObjPtr getData(DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
Deriving class overrides these to get/put class specific data.
const DtAppearance & appearance() const
Accessor/mutator for myAppearance.
Definition: embarkationSlotEntry.h:304
Definition: readerWriter.h:85
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20
void setSlotType(const DtString &)
Accessor/mutator for mySlotType.
Definition: embarkationSlotEntry.h:369
Description: Readable, Writable DtTaitBryan.
Definition: rwTaitBryan.h:20
Definition: readerWriterRegistry.h:39
DtRwString myAnimation
Parameter Name: animation Parameter Description: The DI-Guy animation to use when embarked...
Definition: embarkationSlotEntry.h:201
void setIngressTechnique(const DtString &)
Accessor/mutator for myIngressTechnique.
Definition: embarkationSlotEntry.h:389
void setTurnToHeading(bool)
Accessor/mutator for myTurnToHeading.
Definition: embarkationSlotEntry.h:329
class DtRwEntityType:
Definition: rwRangedEntityType.h:20
void setPosition(const DtVector &)
Accessor/mutator for myPosition.
Definition: embarkationSlotEntry.h:274
DtEmbarkationSlotEntry.
Definition: embarkationSlotEntry.h:27
const DtString & egressTechnique() const
Accessor/mutator for myEgressTechnique.
Definition: embarkationSlotEntry.h:404
DtRwTaitBryan myOrientation
Parameter Name: embarked-orientation Parameter Description: Parameter Default Value: ...
Definition: embarkationSlotEntry.h:190
bool invisibleWhenEmbarked() const
Accessor/mutator for myInvisibleWhenEmbarked.
Definition: embarkationSlotEntry.h:354
Contains the DtRwTaitBryan class declaration.
bool jumpToLocation() const
Accessor/mutator for myJumpToLocation.
Definition: embarkationSlotEntry.h:324
Definition: rwVector.h:23
bool turnToHeading() const
Accessor/mutator for myTurnToHeading.
Definition: embarkationSlotEntry.h:334
bool operator!=(const DtReaderWriter &rhs) const
Definition: readerWriter.h:121
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29
const DtVector & position() const
Accessor/mutator for myPosition.
Definition: embarkationSlotEntry.h:279
void setStationName(const DtString &)
Accessor/mutator for myStationName.
Definition: embarkationSlotEntry.h:379
void setEgressTechnique(const DtString &)
Accessor/mutator for myEgressTechnique.
Definition: embarkationSlotEntry.h:399
Class Description: Readable, writable form of DtAppearance.
Definition: rwAppearance.h:16
const DtString & slotType() const
Accessor/mutator for mySlotType.
Definition: embarkationSlotEntry.h:374
Description: Readable, Writable int.
Definition: rwInt.h:25
const DtString & ingressTechnique() const
Accessor/mutator for myIngressTechnique.
Definition: embarkationSlotEntry.h:394
std::vector< DtFilename > SearchPaths
Definition: readerWriter.h:92
DtRwBoolean myJumpToLocation
Parameter Name: jump-to-location Parameter Description: Jump to this location from the end of the in...
Definition: embarkationSlotEntry.h:213
Definition: rangedEntityType.h:19
DtRwString mySlotType
Parameter Name: slot-type Parameter Description: Free for string that defines the type of slot...
Definition: embarkationSlotEntry.h:243
const DtString & slotName() const
Accessor/mutator for mySlotName.
Definition: embarkationSlotEntry.h:364
int numberOfEntities() const
Accessor/mutator for myNumberOfEntities.
Definition: embarkationSlotEntry.h:314
void setAnimation(const DtString &)
Accessor/mutator for myAnimation.
Definition: embarkationSlotEntry.h:409
virtual void putData(std::string &fp, int indentLevel=0)
Deriving class overrides these to get/put class specific data.
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
DtRwString myIngressTechnique
Parameter Name: ingress-technique Parameter Description: When getting into a slot, rather than doing the default behavior, execute a script with this technique (as defined in DtEmbarkationDescriptor) with values that define this slot Parameter Default Value: .
Definition: embarkationSlotEntry.h:254
DtRwString mySlotName
Parameter Name: slot-name Parameter Description: Free form string that will give the name of this slo...
Definition: embarkationSlotEntry.h:237
DtRwRangedEntityType myObject
Parameter Name: embarkable-object Parameter Description: Parameter Default Value: ...
Definition: embarkationSlotEntry.h:180
DtRwBoolean myOrientOnIngress
Parameter Name: orient-on-ingress Parameter Description: For the ingress route only, snap to an orientation that will point the entity along the direction of ingress movement Parameter Default Value: false .
Definition: embarkationSlotEntry.h:225
const DtReaderWriter & operator=(const DtReaderWriter &orig)
assignment operator
void setSlotName(const DtString &)
Accessor/mutator for mySlotName.
Definition: embarkationSlotEntry.h:359
static const char * theXmlType()
The type that is used when archiving to an XML stream.
DT_DLL_readerWriter std::shared_ptr< DtEnvironment > DtEnvironmentSP
Definition: readerWriter.h:30
void setOrientation(const DtTaitBryan &)
Accessor/mutator for myOrientation.
Definition: embarkationSlotEntry.h:284
bool orientOnIngress() const
Accessor/mutator for myOrientOnIngress.
Definition: embarkationSlotEntry.h:344
void setInvisibleWhenEmbarked(bool)
Accessor/mutator for myInvisibleWhenEmbarked.
Definition: embarkationSlotEntry.h:349
void setJumpToLocation(bool)
Accessor/mutator for myJumpToLocation.
Definition: embarkationSlotEntry.h:319
const DtString & stationName() const
Accessor/mutator for myStationName.
Definition: embarkationSlotEntry.h:384
const DtRangedEntityType & object() const
Accessor/mutator for myObject.
Definition: embarkationSlotEntry.h:269
void setObject(const DtRangedEntityType &)
Accessor/mutator for myObject.
Definition: embarkationSlotEntry.h:264
File: rwVector.h.
void setNumberOfEntities(int)
Accessor/mutator for myNumberOfEntities.
Definition: embarkationSlotEntry.h:309
DtRwVector myPosition
Parameter Name: embarked-position Parameter Description: Parameter Default Value: ...
Definition: embarkationSlotEntry.h:185

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)