DtCharacterModel.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2025 MAK Technologies, Inc.
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <vrvCore/DtModel.h>

#include <vrvUtil/DtCharacterTextureVariationInfo.h>

namespace makVrv
{

   namespace EntityStateListener
   {
      enum class WeaponState;
   }

   class DT_DLL_VRVCORE DtCharacterModel : public DtModel
   {
   public:

      enum Posture
      {
         Upright,
         Crouched,
         Prone,
         Sitting,
         Kneeling,
         Swimming,
         Parachuting,
         Jumping,
         Squatting,
         Wading
      };

      DtCharacterModel( DtDe& de, DtUniqueID id );

      virtual ~DtCharacterModel();

   private:

      DtCharacterModel( const DtCharacterModel& ) = delete;

      DtCharacterModel& operator = ( const DtCharacterModel& ) = delete;

   public:



      virtual void setCharacterModel(const std::string& characterType) = 0;


      virtual void setDefaultAppearance(const std::string& appearanceName) = 0;
      virtual void setAppearance(const std::string& appearanceName) = 0;

      virtual void setHeadAppearance(const std::string& appearanceName) = 0;
      virtual void setItemAppearance(const std::string& appearanceName) = 0;
      virtual void setCharacterEquipment( const std::string& appearanceName ) = 0;


      virtual void setUnit( unsigned short country, unsigned char service, unsigned short patch, bool setPersonal ) = 0;
      virtual void setPersonalUnit( unsigned short country, unsigned char service, unsigned short patch ) = 0;
      virtual void setRank( unsigned short country, unsigned char service, unsigned short patch ) = 0;
      virtual void setCharacterName( const std::string& name ) = 0;


      virtual void setFlamesPresent(bool val) = 0;
      virtual void setEnginePlume(bool val) = 0;
      virtual void setEngineSmoke(bool val) = 0;
      virtual void setTrailState(bool val) = 0;
      virtual void setLightState(unsigned int light, unsigned int lightState) = 0;

      virtual void beginAppearanceEffect(const std::string& effect, const std::string& overrideLink,
         float overrideScale, const DtVector& overrideOffset, float overrideDuration) = 0;
      virtual void endAppearanceEffect(int instantly, const std::string& effect, const std::string& overrideLink) = 0;

      virtual void executeGesture(const std::string& gestureName, int reps, float overallDuration, float channelAWeight) = 0;
      virtual void endGesture(const std::string& gestureName, float rampDown) = 0;


      virtual void setEnableAnimationSmoothing(bool) = 0;

      virtual void setDesiredAction(const std::string& action, float speed) = 0;

      virtual void fireWeapon() = 0;

      virtual void forceAction(const std::string& action, float speed, bool usePositioning,
         const DtVector& offset, int autoChooseTransitionBehavior, float transitionSpeed) = 0;

      virtual void forceTemporaryAction(const std::string& action, double duration) = 0;

      virtual void unforceAction() = 0;

      virtual void setSpeed(float speed) = 0;

      virtual void setPosture(int posture) = 0;

      virtual bool weaponDeployed() const = 0;

      virtual EntityStateListener::WeaponState weaponState() const = 0;

      virtual void setWeaponState(EntityStateListener::WeaponState deployed) = 0;


      virtual void die(const std::string& deathAction) = 0;

      virtual void revive(const std::string& aliveAction) = 0;

      virtual void setPaused(bool paused) = 0;

      virtual const std::string& className() const;

      virtual void setModelScalingEnabled(bool b) = 0;

      virtual void setEmbarked(bool b) = 0;

      virtual void setStationName(int name) = 0;

      virtual void setStationNumber(DtU16 number) = 0;

      virtual void setScale(const DtVector& scale) = 0;
      virtual void setWeight(float weightScale) = 0;

      virtual void setPartOrientation(int partNumber,
         const DtTaitBryan& orientation, const DtVector& rotationalVelocity) = 0;

      virtual void setPartTranslation(int partNumber,
         const DtVector& translation, const DtVector& velocity) = 0;

      virtual void setPartVisibility(int partNumber, bool visible) = 0;

      virtual void removePart( unsigned int partNumber ) = 0;

      virtual void setSelected(bool value) = 0;
      virtual void setTextureVariations(std::vector<DtCharacterTextureVariationInfo>& varationInfoArray, int force) = 0;

      virtual void setDynamicSensorRegion(const std::string& region, bool state) = 0;

      virtual void setUseTransitions(bool use) = 0;

      virtual void setIsOccupant(bool occupant) = 0;

      virtual void setEnabled(bool enabled) = 0;


   };

}