src/DataTypes/ArticulatedPart.cpp

   1 /*********************************************************************
   2 Copyright 2013 Karl Jones
   3 All rights reserved.
   4
   5 Redistribution and use in source and binary forms, with or without
   6 modification, are permitted provided that the following conditions are met:
   7
   8 1. Redistributions of source code must retain the above copyright notice, this
   9    list of conditions and the following disclaimer.
  10 2. Redistributions in binary form must reproduce the above copyright notice,
  11    this list of conditions and the following disclaimer in the documentation
  12    and/or other materials provided with the distribution.
  13
  14 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  15 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  18 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  21 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  23 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24
  25 For Further Information Please Contact me at
  26 Karljj1@yahoo.com
  27 http://p.sf.net/kdis/UserGuide
  28 *********************************************************************/
  29
  30 #include "KDIS/DataTypes/ArticulatedPart.hpp"
  31
  32 //////////////////////////////////////////////////////////////////////////
  33
  34 using namespace std;
  35 using namespace KDIS;
  36 using namespace DATA_TYPE;
  37 using namespace ENUMS;
  38
  39 //////////////////////////////////////////////////////////////////////////
  40 // Public:
  41 //////////////////////////////////////////////////////////////////////////
  42
  43 ArticulatedPart::ArticulatedPart()
  44     : m_ui8ParmeterChange(0),
  45       m_ui16AttachementID(0),
  46       m_ui32ParamTypeVariant(0),
  47       m_f32ParamValue(0),
  48       m_ui32Padding(0) {
  49   m_ui8VarParamType = ArticulatedPartType;
  50 }
  51
  52 //////////////////////////////////////////////////////////////////////////
  53
  54 ArticulatedPart::ArticulatedPart(KDataStream& stream) { Decode(stream); }
  55
  56 //////////////////////////////////////////////////////////////////////////
  57
  58 ArticulatedPart::ArticulatedPart(KUINT8 ParamChangeIndicator, KUINT16 AttachID,
  59                                  ArticulatedPartsClass C,
  60                                  ArticulatedPartsMetric M, KFLOAT32 Value)
  61     : m_ui8ParmeterChange(ParamChangeIndicator),
  62       m_ui16AttachementID(AttachID),
  63       m_f32ParamValue(Value),
  64       m_ui32Padding(0) {
  65   m_ui8VarParamType = ArticulatedPartType;
  66   m_ui32ParamTypeVariant = C + M;
  67 }
  68 //////////////////////////////////////////////////////////////////////////
  69
  70 ArticulatedPart::ArticulatedPart(KUINT8 ParamChangeIndicator, KUINT16 AttachID,
  71                                  KUINT32 TypeVariant, KFLOAT32 Value)
  72     : m_ui8ParmeterChange(ParamChangeIndicator),
  73       m_ui16AttachementID(AttachID),
  74       m_ui32ParamTypeVariant(TypeVariant),
  75       m_f32ParamValue(Value),
  76       m_ui32Padding(0) {
  77   m_ui8VarParamType = ArticulatedPartType;
  78 }
  79
  80 //////////////////////////////////////////////////////////////////////////
  81
  82 ArticulatedPart::~ArticulatedPart() {}
  83
  84 //////////////////////////////////////////////////////////////////////////
  85
  86 void ArticulatedPart::SetParameterChangeIndicator(KUINT8 PCI) {
  87   m_ui8ParmeterChange = PCI;
  88 }
  89
  90 //////////////////////////////////////////////////////////////////////////
  91
  92 KUINT8 ArticulatedPart::GetParameterChangeIndicator() const {
  93   return m_ui8ParmeterChange;
  94 }
  95
  96 //////////////////////////////////////////////////////////////////////////
  97
  98 void ArticulatedPart::SetAttachementID(KUINT16 ID) { m_ui16AttachementID = ID; }
  99
 100 //////////////////////////////////////////////////////////////////////////
 101
 102 KUINT16 ArticulatedPart::GetAttachementID() const {
 103   return m_ui16AttachementID;
 104 }
 105
 106 //////////////////////////////////////////////////////////////////////////
 107
 108 void ArticulatedPart::SetTypeVariantClass(ArticulatedPartsClass C) {
 109   m_ui32ParamTypeVariant = C + (m_ui32ParamTypeVariant % 32);
 110 }
 111
 112 //////////////////////////////////////////////////////////////////////////
 113
 114 ArticulatedPartsClass ArticulatedPart::GetTypeVariantClass() const {
 115   return (ArticulatedPartsClass)(m_ui32ParamTypeVariant -
 116                                  (m_ui32ParamTypeVariant % 32));
 117 }
 118
 119 //////////////////////////////////////////////////////////////////////////
 120
 121 void ArticulatedPart::SetTypeVariantMetric(ArticulatedPartsMetric M) {
 122   m_ui32ParamTypeVariant =
 123       m_ui32ParamTypeVariant - (m_ui32ParamTypeVariant % 32) + M;
 124 }
 125
 126 //////////////////////////////////////////////////////////////////////////
 127
 128 ArticulatedPartsMetric ArticulatedPart::GetTypeVariantMetric() const {
 129   return (ArticulatedPartsMetric)(m_ui32ParamTypeVariant % 32);
 130 }
 131
 132 //////////////////////////////////////////////////////////////////////////
 133
 134 void ArticulatedPart::SetTypeVariant(KUINT32 TV) {
 135   m_ui32ParamTypeVariant = TV;
 136 }
 137
 138 //////////////////////////////////////////////////////////////////////////
 139
 140 KUINT32 ArticulatedPart::GetTypeVariant() const {
 141   return m_ui32ParamTypeVariant;
 142 }
 143
 144 //////////////////////////////////////////////////////////////////////////
 145
 146 void ArticulatedPart::SetValue(KFLOAT32 val) { m_f32ParamValue = val; }
 147
 148 //////////////////////////////////////////////////////////////////////////
 149
 150 KFLOAT32 ArticulatedPart::GetValue() const { return m_f32ParamValue; }
 151
 152 //////////////////////////////////////////////////////////////////////////
 153
 154 KString ArticulatedPart::GetAsString() const {
 155   KStringStream ss;
 156
 157   ss << "Articulation Parameters:"
 158      << "\n\tParameter Change:     " << (KUINT16)m_ui8ParmeterChange
 159      << "\n\tAttachement ID:       " << m_ui16AttachementID
 160      << "\n\tType Metric:          "
 161      << GetEnumAsStringArticulatedPartsMetric(GetTypeVariantMetric())
 162      << "\n\tType High Bits:       "
 163      << GetEnumAsStringArticulatedPartsClass(GetTypeVariantClass())
 164      << "\n\tValue:                " << m_f32ParamValue << "\n";
 165
 166   return ss.str();
 167 }
 168
 169 //////////////////////////////////////////////////////////////////////////
 170
 171 void ArticulatedPart::Decode(KDataStream& stream) {
 172   if (stream.GetBufferSize() < VariableParameter::VARIABLE_PARAMETER_SIZE)
 173     throw KException(__FUNCTION__, NOT_ENOUGH_DATA_IN_BUFFER);
 174
 175   stream >> m_ui8VarParamType >> m_ui8ParmeterChange >> m_ui16AttachementID >>
 176       m_ui32ParamTypeVariant >> m_f32ParamValue >> m_ui32Padding;
 177 }
 178
 179 //////////////////////////////////////////////////////////////////////////
 180
 181 KDataStream ArticulatedPart::Encode() const {
 182   KDataStream stream;
 183
 184   ArticulatedPart::Encode(stream);
 185
 186   return stream;
 187 }
 188
 189 //////////////////////////////////////////////////////////////////////////
 190
 191 void ArticulatedPart::Encode(KDataStream& stream) const {
 192   stream << m_ui8VarParamType << m_ui8ParmeterChange << m_ui16AttachementID
 193          << m_ui32ParamTypeVariant << m_f32ParamValue << m_ui32Padding;
 194 }
 195
 196 //////////////////////////////////////////////////////////////////////////
 197
 198 KBOOL ArticulatedPart::operator==(const ArticulatedPart& Value) const {
 199   if (m_ui8VarParamType != Value.m_ui8VarParamType) return false;
 200   if (m_ui8ParmeterChange != Value.m_ui8ParmeterChange) return false;
 201   if (m_ui16AttachementID != Value.m_ui16AttachementID) return false;
 202   if (m_ui32ParamTypeVariant != Value.m_ui32ParamTypeVariant) return false;
 203   if (m_f32ParamValue != Value.m_f32ParamValue) return false;
 204   return true;
 205 }
 206
 207 //////////////////////////////////////////////////////////////////////////
 208
 209 KBOOL ArticulatedPart::operator!=(const ArticulatedPart& Value) const {
 210   return !(*this == Value);
 211 }
 212
 213 //////////////////////////////////////////////////////////////////////////