VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
aggregatedMovementActuatorPSR.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2014 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
6 #pragma once
7 
10 
11 
13 #include "vrfobjcore/simObject.h"
14 #include <readerWriter/rwBoolean.h>
15 #include <readerWriter/rwString.h>
16 #include <readerWriter/rwReal.h>
20 
22 class DtEntityIdentifier;
23 
25 {
26 public:
27 
30  const DtString& rwName = DtString::nullString(),
31  DtReaderWriterRegistry* parentRegistry = 0);
32 
35  const DtString& rwName = DtString::nullString(),
36  DtReaderWriterRegistry* parentRegistry = 0);
37 
40 
43 
46  const DtString& rwName = DtString::nullString(),
47  DtReaderWriterRegistry* parentRegistry = 0) const;
48 
50  virtual DtString type() const;
51 
54  virtual bool haltMovementForObstacles() const;
55  virtual void setHaltMovementForObstacles(bool value);
57 
60  virtual const DtString& obstacleQueryName() const;
61  virtual void setObstacleQueryName(const DtString& objectTypes);
63 
66  virtual bool isHalted() const;
67  virtual void setIsHalted(bool value);
69 
72  virtual DtSimObjectReference blockingObstacle() const;
73  virtual void setBlockingObstacle(const DtUUID& obstacleName);
75 
78  virtual DtTime timeHalted() const;
79  virtual void setTimeHalted(DtTime timeHalted);
81 
84  virtual const DtRwNLengthStringVector& obstaclesToIgnore() const;
85  virtual void setObstaclesToIgnore(const DtRwNLengthStringVector& obstacleNames);
86  virtual void addObstacleToIgnore(const DtString& obstacleName);
87  virtual void removeObstacleToIgnore(const DtString& obstacleName);
88  virtual void clearObstaclesToIgnore();
90 
93  virtual const DtRwNLengthStringVector& unencounteredObstaclesToIgnore() const;
94  virtual void setUnencounteredObstaclesToIgnore(const DtRwNLengthStringVector& obstacleNames);
95  virtual void addUnencounteredObstacleToIgnore(const DtString& obstacleName);
96  virtual void removeUnencounteredObstacleToIgnore(const DtString& obstacleName);
97  virtual void clearUnencounteredObstaclesToIgnore();
99 
101  static DtVrfProcessStateRepository* creator (const DtString& rwName,
102  DtLocalObject* vrfObject, DtReaderWriterRegistry* parentRegistry);
103 
104 protected:
107 
111 
114 
117 
120 
123 
127 };
UUID is a unique ID wrapper class.
Definition: uuid.h:59
Definition: aggregatedMovementActuatorPSR.h:24
DtRwNLengthStringVector is a named, readable/writable vector of strings of arbitrary length...
Definition: rwNLengthStringVector.h:28
DtRwBoolean myIsHalted
Whether the actuator is currently halted due to obstacles.
Definition: aggregatedMovementActuatorPSR.h:113
DtRwString myObstacleQueryName
The feature query name for obstacles for which the actuator should halt if myHaltMovementForObstacles...
Definition: aggregatedMovementActuatorPSR.h:110
The DtSimObjectReference is a shared pointer that can be used amongst many object for access to the u...
Definition: simObjectReference.h:26
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20
Definition: readerWriterRegistry.h:39
DtRwNLengthStringVector myObstaclesToIgnore
List of obstacle names which do not need to be halted for.
Definition: aggregatedMovementActuatorPSR.h:122
Specialized reader/writer version of the shared object reference that will encapsulate the actual sha...
Definition: rwSimObjectReference.h:21
#define DT_DLL_vrfobjcore
This file is used to determine how to build.
Definition: vrfobjcoreDefines.h:24
DtRwBoolean myHaltMovementForObstacles
Whether the actuator should halt movement when encountering obstacles.
Definition: aggregatedMovementActuatorPSR.h:106
virtual DtVrfProcessStateRepository * clone(const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const =0
DtRwReal myTimeHalted
The time that the actuator halted due to an obstacle.
Definition: aggregatedMovementActuatorPSR.h:119
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
Class DtVrfProcessStateRepository: Abstract base class for all process state repositories. Process state repositories represent (potentially) shared, savable information for one or more components functioning together to achieve some process or set of processes; such as aiming and firing a weapon; moving an object; or just waiting a specified amount of time.
Definition: vrfProcessStateRepository.h:45
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
DtRwNLengthStringVector myUnencounteredObstaclesToIgnore
List of obstacle names which do not need to be halted for that we have not yet encountered.
Definition: aggregatedMovementActuatorPSR.h:126
virtual DtString type() const =0
Returns the string type of the repository, as defined in procSRTypes.h.
DtRwSimObjectReference myBlockingObstacle
The name of the obstacle that is currently causing us to halt.
Definition: aggregatedMovementActuatorPSR.h:116
const DtVrfProcessStateRepository & operator=(const DtVrfProcessStateRepository &orig)
A locally simulated VRF object. Holds all internal and external data for the object, and provides access to both the current frame and next frame state data for the object. All current frame data is read-only, and next-frame data can be written to. No thread safety guarantees are made on this object during the simulation frame and it should only be accessed by the thread that is simulating the object.
Definition: localObject.h:86

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)