VR-Forces 5.0.2 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
flyAlongTask.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2015 MaK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 #pragma once
10 
11 #include "vrftasks/simTask.h"
12 #include <readerWriter/rwString.h>
13 #include <readerWriter/rwInt.h>
14 #include <readerWriter/rwBoolean.h>
15 #include <vlutil/vlNetTypes.h>
16 #include "vrfutil/iteratorBase.h"
17 #include "vrfutil/rwUUID.h"
18 
41 
44 {
45 
46 public:
47 
50 
53  DtFlyAlongTask(const DtString & writeName,
54  DtReaderWriterRegistry * parentRegistry = 0);
55 
57  DtFlyAlongTask(const DtString & writeName, const DtFlyAlongTask & orig,
58  DtReaderWriterRegistry * parentRegistry = 0);
59 
61  const DtFlyAlongTask & operator=(const DtFlyAlongTask & orig);
62 
63  virtual ~DtFlyAlongTask();
64 
65  virtual const DtSimTaskMessageType& type() const;
66 
68  virtual DtSimTask * clone(const DtString & name, DtReaderWriterRegistry *
69  parentRegistry = 0) const;
70 
72  virtual DtString stringRep() const;
73 
76  virtual const DtUUID & route() const;
77 
79  virtual void setRoute(const DtUUID &);
80 
83  virtual void setTraversalDirection(DtIteratorDirection traversalDirection);
84  virtual DtIteratorDirection traversalDirection() const;
85 
90  virtual void setStartAtClosestPoint(bool startAtClosestPoint);
91  virtual bool startAtClosestPoint() const;
92 
95  virtual int netRepSize() const;
96 
98  virtual bool setFromNet(const char* contentBuffer,
99  unsigned contentSize);
100 
101  virtual void setUseFixedPitch(bool);
102  virtual bool useFixedPitch() const;
103 
106  virtual bool setToNet();
107 
108  static DtSimTask * creator();
109 
110 protected:
111 
116 };
UUID is a unique ID wrapper class.
Definition: rwUUID.h:229
DtRwBoolean myStartAtClosestPoint
Definition: flyAlongTask.h:114
Definition: readerWriterRegistry.h:39
Contains the DtUUID class declaration.
virtual DtSimTask * clone(const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0
Make a copy of this task. Returns a newly allocated instance of a DtSimTask. Override this member fun...
DtRwInt myTraversalDirection
Definition: flyAlongTask.h:113
Description: Readable, Writable uuid string. Use this class in order to convert from object marking t...
Definition: rwUUID.h:431
DtIteratorDirection
Definition: iteratorBase.h:23
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask). Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimTask::netRepSize().
Description: Readable, Writable int.
Definition: rwInt.h:25
virtual bool setToNet()
Calls netRep() to create the network buffer. Casts the resulting myNetRep to type DtNetSimTask*...
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.h:26
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
DtSimTask is an abstract base class from which real tasks can derive. It manages the read/write capab...
Definition: simTask.h:30
virtual DtString stringRep() const =0
Returns a human-readable string representation of the task. This string representation is used to dis...
const DtSimTask & operator=(const DtSimTask &orig)
assignment operator; same as copy constructor
DtFlyAlongTask represents a Fly Along Route task for an entity to perform. It inherits read/writablen...
Definition: flyAlongTask.h:43
DtRwUUID myRoute
Definition: flyAlongTask.h:112
DtRwBoolean myUseFixedPitch
Definition: flyAlongTask.h:115
virtual const DtSimTaskMessageType & type() const =0
What kind of task am I? Returns a string indicating the kind of task (for example, “move-to”, “follow-entity”). Derived classes must implement this member function to return a unique string representing the type of task. The set of standard task types supplied with VR-Forces is in taskTypes.h.
virtual int netRepSize() const
Returns the size in bytes of the network representation of the class. This is the size in bytes of th...

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)