VR-Forces 5.0.2 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) 2013 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();
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 DtRangedObjectType& object() const;
56  void setObject(const DtRangedObjectType&);
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;
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;
155  virtual void getData(const DtEnvironmentSP, const DtEnvValueSP value,
157  const DtVariableBindingsList& bindings = DtVariableBindingsList());
158 
160  static const char* theXmlType();
161 
162  virtual const char* xmlType() const
163  {
164  return theXmlType();
165  }
167 
168 private:
171 
172 protected:
173 
177 
182 
187 
192 
197 
203 
209 
215 
221 
227 
233 
239 
245 
250 
256 
263 };
264 
266 {
267  myObject = o;
268 }
269 
271 {
272  return myObject;
273 }
274 
276 {
277  myPosition = v;
278 }
279 
281 {
282  return myPosition;
283 }
284 
285 inline void DtEmbarkationSlotEntry::setOrientation(const DtTaitBryan& o)
286 {
287  myOrientation = o;
288 }
289 
291 {
292  return myOrientation;
293 }
294 
295 inline void DtEmbarkationSlotEntry::setAppearance(const DtAppearance& a)
296 {
297  myAppearance = a;
298 }
299 
301 {
302  myAppearance.setAppearance(a);
303 }
304 
305 inline const DtAppearance& DtEmbarkationSlotEntry::appearance() const
306 {
307  return myAppearance;
308 }
309 
311 {
312  myNumberOfEntities = a;
313 }
314 
316 {
317  return myNumberOfEntities;
318 }
319 
321 {
322  myJumpToLocation = b;
323 }
324 
326 {
327  return myJumpToLocation;
328 }
329 
331 {
332  myTurnToHeading = b;
333 }
334 
336 {
337  return myTurnToHeading;
338 }
339 
341 {
342  myOrientOnIngress = b;
343 }
344 
346 {
347  return myOrientOnIngress;
348 }
349 
351 {
353 }
354 
356 {
358 }
359 
361 {
362  mySlotName = s;
363 }
364 
366 {
367  return mySlotName;
368 }
369 
371 {
372  mySlotType = s;
373 }
374 
376 {
377  return mySlotType;
378 }
379 
381 {
382  myStationName = s;
383 }
384 
386 {
387  return myStationName;
388 }
389 
391 {
392  myIngressTechnique = s;
393 }
394 
396 {
397  return myIngressTechnique;
398 }
399 
401 {
402  myEgressTechnique = s;
403 }
404 
406 {
407  return myEgressTechnique;
408 }
409 
411 {
412  myAnimation = s;
413 }
414 
416 {
417  return myAnimation;
418 }
419 
bool operator==(const DtReaderWriter &) const
Equivalence operator.
DtRwAppearance myAppearance
Parameter Name: embarked-appearance Parameter Description: Parameter Default Value: ...
Definition: embarkationSlotEntry.h:196
DtRwBoolean myInvisibleWhenEmbarked
Parameter Name: invisible-when-embarked Parameter Description: Whether or not, when embarked...
Definition: embarkationSlotEntry.h:232
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...
class DtRwObjectType:
Definition: rwRangedObjectType.h:19
void setOrientOnIngress(bool)
Accessor/mutator for myOrientOnIngress.
Definition: embarkationSlotEntry.h:340
DtRwInt myNumberOfEntities
Parameter Name: number-of-entities Parameter Description: Number of entities that can occupy this slo...
Definition: embarkationSlotEntry.h:208
#define DT_DLL_vrfobjparam
This file is used to determine how to build.
Definition: vrfobjparamDefines.h:28
DtRwString myEgressTechnique
Parameter Name: egress-technique Parameter Description: When getting out of slot, rather than doing t...
Definition: embarkationSlotEntry.h:261
DtRwRangedObjectType myObject
Parameter Name: embarkable-object Parameter Description: Parameter Default Value: ...
Definition: embarkationSlotEntry.h:181
DT_DLL_readerWriter DtBoost::shared_ptr< DtEnvironment > DtEnvironmentSP
Definition: readerWriter.h:30
const DtString & animation() const
Accessor/mutator for myAnimation.
Definition: embarkationSlotEntry.h:415
DtRwBoolean myTurnToHeading
Parameter Name: turn-to-heading Parameter Description: Turn to correct heading on start of egress rou...
Definition: embarkationSlotEntry.h:220
DtRwString myStationName
Parameter Name: station-name Parameter Description: DIS station name for this slot Parameter Default ...
Definition: embarkationSlotEntry.h:249
void setAppearance(const DtAppearance &)
Accessor/mutator for myAppearance.
Definition: embarkationSlotEntry.h:295
const DtRwTaitBryan orientation() const
Accessor/mutator for myOrientation.
Definition: embarkationSlotEntry.h:290
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:305
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:370
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:202
void setIngressTechnique(const DtString &)
Accessor/mutator for myIngressTechnique.
Definition: embarkationSlotEntry.h:390
void setTurnToHeading(bool)
Accessor/mutator for myTurnToHeading.
Definition: embarkationSlotEntry.h:330
void setPosition(const DtVector &)
Accessor/mutator for myPosition.
Definition: embarkationSlotEntry.h:275
DtEmbarkationSlotEntry.
Definition: embarkationSlotEntry.h:27
const DtString & egressTechnique() const
Accessor/mutator for myEgressTechnique.
Definition: embarkationSlotEntry.h:405
DtRwTaitBryan myOrientation
Parameter Name: embarked-orientation Parameter Description: Parameter Default Value: ...
Definition: embarkationSlotEntry.h:191
bool invisibleWhenEmbarked() const
Accessor/mutator for myInvisibleWhenEmbarked.
Definition: embarkationSlotEntry.h:355
Definition: rangedObjectType.h:19
Contains the DtRwTaitBryan class declaration.
bool jumpToLocation() const
Accessor/mutator for myJumpToLocation.
Definition: embarkationSlotEntry.h:325
Definition: rwVector.h:23
bool turnToHeading() const
Accessor/mutator for myTurnToHeading.
Definition: embarkationSlotEntry.h:335
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29
const DtVector & position() const
Accessor/mutator for myPosition.
Definition: embarkationSlotEntry.h:280
void setStationName(const DtString &)
Accessor/mutator for myStationName.
Definition: embarkationSlotEntry.h:380
void setEgressTechnique(const DtString &)
Accessor/mutator for myEgressTechnique.
Definition: embarkationSlotEntry.h:400
Class Description: Readable, writable form of DtAppearance.
Definition: rwAppearance.h:16
void setObject(const DtRangedObjectType &)
Accessor/mutator for myObject.
Definition: embarkationSlotEntry.h:265
const DtString & slotType() const
Accessor/mutator for mySlotType.
Definition: embarkationSlotEntry.h:375
Description: Readable, Writable int.
Definition: rwInt.h:25
const DtString & ingressTechnique() const
Accessor/mutator for myIngressTechnique.
Definition: embarkationSlotEntry.h:395
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:214
DtRwString mySlotType
Parameter Name: slot-type Parameter Description: Free for string that defines the type of slot...
Definition: embarkationSlotEntry.h:244
const DtString & slotName() const
Accessor/mutator for mySlotName.
Definition: embarkationSlotEntry.h:365
int numberOfEntities() const
Accessor/mutator for myNumberOfEntities.
Definition: embarkationSlotEntry.h:315
void setAnimation(const DtString &)
Accessor/mutator for myAnimation.
Definition: embarkationSlotEntry.h:410
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:255
const DtRangedObjectType & object() const
Accessor/mutator for myObject.
Definition: embarkationSlotEntry.h:270
DtRwString mySlotName
Parameter Name: slot-name Parameter Description: Free form string that will give the name of this slo...
Definition: embarkationSlotEntry.h:238
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:226
const DtReaderWriter & operator=(const DtReaderWriter &orig)
assignment operator
void setSlotName(const DtString &)
Accessor/mutator for mySlotName.
Definition: embarkationSlotEntry.h:360
static const char * theXmlType()
The type that is used when archiving to an XML stream.
void setOrientation(const DtTaitBryan &)
Accessor/mutator for myOrientation.
Definition: embarkationSlotEntry.h:285
bool operator!=(const DtReaderWriter &rhs)
Definition: readerWriter.h:121
bool orientOnIngress() const
Accessor/mutator for myOrientOnIngress.
Definition: embarkationSlotEntry.h:345
void setInvisibleWhenEmbarked(bool)
Accessor/mutator for myInvisibleWhenEmbarked.
Definition: embarkationSlotEntry.h:350
void setJumpToLocation(bool)
Accessor/mutator for myJumpToLocation.
Definition: embarkationSlotEntry.h:320
const DtString & stationName() const
Accessor/mutator for myStationName.
Definition: embarkationSlotEntry.h:385
virtual const char * xmlType() const
Routines to archive/dearchive from an XML Environment.
Definition: embarkationSlotEntry.h:162
File: rwVector.h.
void setNumberOfEntities(int)
Accessor/mutator for myNumberOfEntities.
Definition: embarkationSlotEntry.h:310
DtRwVector myPosition
Parameter Name: embarked-position Parameter Description: Parameter Default Value: ...
Definition: embarkationSlotEntry.h:186

Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)