VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
rwJoystickControls.h
Go to the documentation of this file.
1 /******************************************************************************
2 ** Copyright (c) 2015 MaK Technologies, Inc.
3 ** All rights reserved.
4 ******************************************************************************/
5 
8 
14 
15 #pragma once
16 
17 #include "vrfutil/vrfutilDefines.h"
19 #include <readerWriter/rwString.h>
20 #include <readerWriter/rwReal.h>
21 #include <readerWriter/rwBoolean.h>
22 
29 {
30 public:
31 
34 
36  DtRwJoystickControl(const DtString& name,
37  DtReaderWriterRegistry* parentRegistry = NULL);
38 
40  DtReaderWriterRegistry* parentRegistry = NULL);
41 
44  DtReaderWriterRegistry* parentRegistry = NULL);
45 
50 
52  virtual ~DtRwJoystickControl() override;
53 
55  static const char* theXmlType();
56 
57  virtual const char* xmlType() const override
58  {
59  return theXmlType();
60  }
61 
62  virtual void setFunctionName(const DtString&);
63  virtual const DtString& functionName() const;
64 
65  virtual void setFunctionGroup(const DtString&);
66  virtual const DtString& functionGroup() const;
67 
68  virtual void setDescription(const DtString&);
69  virtual const DtString& description() const;
70 
71  virtual void setMinimumValue(double);
72  virtual double minimumValue() const;
73 
74  virtual void setMaximumValue(double);
75  virtual double maximumValue() const;
76 
77  virtual void setCycle(bool);
78  virtual bool cycle() const;
79 
80  bool operator==(const DtRwJoystickControl&) const;
81  bool operator!=(const DtRwJoystickControl& rhs) { return !(*this == rhs); };
82 
83  virtual char* encode(char*) const;
84  virtual const char* decode(const char*);
85  virtual int getSize() const;
86 
90  virtual const char* readerWriterType() const override;
91 
92 protected:
96 
103 
108 
113 
121 
129 
138 };
139 
bool operator==(const DtReaderWriter &) const
Equivalence operator.
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...
DT_DLL_readerWriter int getSize(const DtString &val)
The number of bytes required to encode the value.
This class allows one to collect and compare strings using an index number instead of having to do st...
Definition: symbolString.h:27
DtRwReal myMinimumValue
Parameter Name: min-value Parameter Description: The minimum value of this joystick control...
Definition: rwJoystickControls.h:120
DtRwBoolean myCycle
Parameter Name: cycle Parameter Description: Whether or not the values between min and max are cycled...
Definition: rwJoystickControls.h:136
virtual const char * xmlType() const override
Definition: rwJoystickControls.h:57
DtRwString myFunctionGroup
Parameter Name: function-group Parameter Description: A collection of functions that can be implement...
Definition: rwJoystickControls.h:107
Definition: readerWriter.h:85
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20
Definition: readerWriterRegistry.h:39
DtRwReal myMaximumValue
Parameter Name: max-value Parameter Description: The maximum value of this joystick control...
Definition: rwJoystickControls.h:128
File: rwJoystickControlInformation.h.
Definition: rwJoystickControls.h:28
DtRwString myFunctionName
Parameter Name: function-name Parameter Description: As part of a funtion group, within a controller ...
Definition: rwJoystickControls.h:102
DT_DLL_readerWriter char * encode(const DtFilename &val, char *buffer)
Serializes the provided value val into buffer. buffer must have at least the number of bytes returned...
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
DtRwTemplatedListPtr< DtRwJoystickControl, true > DtRwJoystickControls
Definition: rwJoystickControls.h:140
bool operator!=(const DtRwJoystickControl &rhs)
Definition: rwJoystickControls.h:81
#define DT_DLL_vrfutil
This file is used to determine how to build Disable inconsistent dll linkage warning Visual Studio 6...
Definition: vrfutilDefines.h:34
const DtReaderWriter & operator=(const DtReaderWriter &orig)
assignment operator
DT_DLL_readerWriter const char * decode(DtString &val, const char *buffer)
Decodes a value from buffer and places the result in val of the type specified by val...
static const char * theXmlType()
The type that is used when archiving to an XML stream.
DtRwString myDescription
Parameter Name: description Parameter Description: A user friendly description of this joystick funct...
Definition: rwJoystickControls.h:112

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)