VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
snapIntoFormationRequest.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 1999 MaK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 
10 #pragma once
11 
12 
14 #include <vlpi/netStructs.h>
15 #include "readerWriter/rwVector.h"
16 #include <readerWriter/rwReal.h>
17 #include <readerWriter/rwString.h>
18 #include <readerWriter/rwBoolean.h>
19 
40 {
41 
42 public:
43 
46 
49  DtSnapIntoFormationRequest(const DtString & writeName,
50  DtReaderWriterRegistry * parentRegistry = 0);
51 
53  DtSnapIntoFormationRequest(const DtString & writeName,
54  const DtSnapIntoFormationRequest & orig,
55  DtReaderWriterRegistry * parentRegistry = 0);
56 
59 
60  virtual ~DtSnapIntoFormationRequest();
61 
63  virtual const DtSetMessageType& type() const;
64 
66  virtual DtSetDataRequest * clone(const DtString & name,
67  DtReaderWriterRegistry * parentRegistry = 0) const;
68 
70  virtual DtString stringRep() const;
71 
74  virtual const DtVector & location() const;
75  virtual void setLocation(const DtVector & point);
76 
78  virtual double heading() const;
79  virtual void setHeading(double heading);
80 
81  virtual DtString formationName() const;
82  virtual void setFormationName(const DtString& formation);
83 
85  virtual void setApplyHeading(bool applyHeading);
86  virtual bool applyHeading() const;
87 
90  virtual int netRepSize() const;
91 
93  virtual bool setFromNet(const char* contentBuffer,
94  unsigned contentSize);
95 
98  virtual bool setToNet();
99 
102  virtual void getSelf(DtlObjPtr args,
104  const DtVariableBindingsList& variableBindings = nullVariableReference());
105 
106 
107  static DtSetDataRequest * creator();
108 
109 protected:
110 
115 };
116 
virtual bool setToNet()
Sets netRep buffer to the contents of this set request. Base class does nothing and returns true...
DtRwVector myLocation
Definition: snapIntoFormationRequest.h:111
DtSnapIntoFormationRequest is used to set the formation type for an (aggregate) entity. It inherits read/writableness from DtSetDataRequest. The name of the formation is specified in the request. All units, whether aggregate or disaggregated units (i.e. &quot;pseudo aggregates&quot;) can have a formation. For pseudo-aggregates, this request causes the subordinate entities to be instantly moved to the formation positions described in the object parameter data-base. The Set request does the same thing as setFormationRequest except that it allows more formation parameters to be specified.
Definition: snapIntoFormationRequest.h:39
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20
Definition: readerWriterRegistry.h:39
virtual int netRepSize() const
Definition: rwVector.h:23
DtSetDataRequest is an abstract base class from which real setDataRequests can derive. It manages the read/write capability; derived classes need only use and register read/writatble data types for derived information.
Definition: setDataRequest.h:41
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29
DtRwString myFormationName
Definition: snapIntoFormationRequest.h:113
DtRwReal myHeading
Definition: snapIntoFormationRequest.h:112
DtRwBoolean myApplyHeading
Definition: snapIntoFormationRequest.h:114
virtual const DtSetMessageType & type() const =0
What kind of setDataRequest am I? (from radioMsgTypes.h). Returns a string representing the kind of d...
std::vector< DtFilename > SearchPaths
Definition: readerWriter.h:92
virtual DtSetDataRequest * clone(const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0
Make a copy of this request. Returns a pointer to a newly created copy of this data request...
const DtSetDataRequest & operator=(const DtSetDataRequest &orig)
assignment operator; same as copy costructor.
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Sets the contents of this set request based on the network buffer. Base class does nothing and return...
virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter member...
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.h:26
static const DtVariableBindingsList & nullVariableReference()
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
virtual DtString stringRep() const =0
Get a readable string representation of this setDataRequest. Returns a human readable string represen...
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
File: rwVector.h.

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)