stateDefines.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file stateDefines.h
//! \brief Common enumeration definitions used throughout the VREngage system
//! \ingroup vreCommonComponents
 
#pragma once
 
namespace makVre
{
//! \brief Enumeration of available sensor view modes
//!
//! Defines the different sensor vision modes that can be used in the simulation
enum SensorViews
{
   VISUAL,        //!< Standard visual spectrum view
   NVG,           //!< Night vision goggles view
   THERMAL_WHITE, //!< Thermal imaging with hot objects appearing white
   THERMAL_BLACK, //!< Thermal imaging with hot objects appearing black
   MAX_SENSORS    //!< Sentinel value indicating the number of sensor types
};
 
//! \brief Enumeration of human posture states
//!
//! Defines the possible postures that a human entity can assume in the simulation
enum HumanPosture
{
   PRONE,       //!< Lying flat on the ground
   SITTING,     //!< Seated position
   CROUCHING,   //!< Lowered stance with bent knees
   KNEELING,    //!< One or both knees on the ground
   STANDING,    //!< Upright position
   JUMPING,     //!< Mid-air during a jump
   PARACHUTING, //!< Descending with a parachute
   MAX_POSTURES //!< Sentinel value indicating the number of posture types
};
//! \brief Enumeration of camera/observer attachment offsets
//!
//! Defines which observer offset is used by DtHumanObserverUpdater
enum ObserverAttachMode
{
   FIRST_PERSON,             //!< Offset when in first-person view mode
   THIRD_PERSON,             //!< Offset when in third-person view mode
   CARRY,                    //!< Offset when carrying wounded
   WEAPON_ATTACH,            //!< Offset when using aim-down-sights
   MAX_OBSERVER_ATTACH_MODES //!< Sentinel value indicating the number of offset modes
};
//! \brief Enumeration of equipment types that can be held or used
//!
//! Defines the types of equipment that an entity can have equipped or active
enum Equipment
{
   NONE,         //!< No equipment currently active
   GUN,          //!< Firearm (rifle, pistol, etc.)
   LAUNCHER,     //!< Projectile launcher (RPG, missile launcher, etc.)
   GRENADE,      //!< Hand grenade or thrown explosive
   BINOCULARS,   //!< Optical viewing device for distance observation
   MAX_EQUIPMENT //!< Sentinel value indicating the number of equipment types
};
//! \brief Enumeration of launcher equipment states
//!
//! Defines the possible states for launcher-type equipment
enum LauncherState
{
   NO_LAUNCHER, //!< No launcher is equipped
   DEPLOYED,    //!< Launcher is equipped and ready to use
   AIMING       //!< Launcher is being aimed at a target
};
//! \brief Enumeration of launcher equipment types
//!
//! Defines the physical configuration types for launchers
enum LauncherType
{
   UNKNOWN,          //!< Launcher type is not specified or recognized
   SHOULDER_MOUNTED, //!< Launcher designed to be fired from the shoulder
   TRIPOD_MOUNTED    //!< Launcher mounted on a tripod or fixed support
};
//! \brief Enumeration of interactive terrain elements
//!
//! Defines the types of terrain elements that can be interacted with
enum TerrainElement
{
   DOOR,  //!< Doorway or door element
   WINDOW //!< Window element
};
 
//! \brief Enumeration of actions that can be performed on terrain elements
//!
//! Defines the possible actions that can be applied to interactive terrain elements
enum TerrainAction
{
   OPEN, //!< Open the terrain element
   CLOSE //!< Close the terrain element
};
} // namespace makVre