makVre::DtVreHumanGunActuatorDescriptor Class Reference

Detailed Description

This class defines a descriptor for human gun actuator components in VREngage. It extends the base human gun actuator descriptor to add configuration for realistic human weapon handling, including maximum range, burst fire behavior, and recoil effects. These parameters affect how human entities interact with and operate weapons in VREngage simulations.

#include <vreHumanGunActuatorDescriptor.h>

Inheritance diagram for makVre::DtVreHumanGunActuatorDescriptor:

Public Member Functions
	DtVreHumanGunActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVreHumanGunActuatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVreHumanGunActuatorDescriptor (const DtVreHumanGunActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtVreHumanGunActuatorDescriptor &	operator= (const DtVreHumanGunActuatorDescriptor &orig)
virtual	~DtVreHumanGunActuatorDescriptor () override
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const override
virtual DtReal	maxRange () const
virtual void	setMaxRange (DtReal maxRange)
virtual DtInt16	burstPerTrigger () const
virtual void	setBurstPerTrigger (DtInt16 rounds)
virtual const DtVector &	recoilOffset () const
virtual void	setRecoilOffset (const DtVector &muzzleOffset)
virtual bool	isRecoilOffsetSpecified () const

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtVreHumanGunActuatorDescriptor ()

Protected Attributes
DtRwReal	myMaxRange
DtRwInt	myBurstPerTrigger
DtRwOffsetVector	myRecoilOffset

Constructor & Destructor Documentation

DtVreHumanGunActuatorDescriptor() [1/4]

makVre::DtVreHumanGunActuatorDescriptor::DtVreHumanGunActuatorDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Constructor with component name.

Parameters

name	The name of this component
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new human gun actuator descriptor with the specified name.

Referenced by DtVreHumanGunActuatorDescriptor(), and operator=().

DtVreHumanGunActuatorDescriptor() [2/4]

makVre::DtVreHumanGunActuatorDescriptor::DtVreHumanGunActuatorDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Constructor with component name as symbol string.

Parameters

name	The name of this component as a symbol string
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new human gun actuator descriptor with the specified name.

DtVreHumanGunActuatorDescriptor() [3/4]

makVre::DtVreHumanGunActuatorDescriptor::DtVreHumanGunActuatorDescriptor	(	const DtVreHumanGunActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Copy constructor.

Parameters

orig	The source descriptor to copy from
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new human gun actuator descriptor as a copy of the provided original.

References DtVreHumanGunActuatorDescriptor().

~DtVreHumanGunActuatorDescriptor()

virtual makVre::DtVreHumanGunActuatorDescriptor::~DtVreHumanGunActuatorDescriptor ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

DtVreHumanGunActuatorDescriptor() [4/4]

makVre::DtVreHumanGunActuatorDescriptor::DtVreHumanGunActuatorDescriptor ( )

protected

Default constructor (not implemented)

Default constructor is protected and not implemented to prevent creation of instances without proper initialization.

Member Function Documentation

operator=()

DtVreHumanGunActuatorDescriptor & makVre::DtVreHumanGunActuatorDescriptor::operator=

(

const DtVreHumanGunActuatorDescriptor &

orig

)

Assignment operator.

Parameters

orig	The source descriptor to copy from

Returns

Reference to this descriptor after assignment

Assigns the contents of the provided descriptor to this one.

References DtVreHumanGunActuatorDescriptor().

type()

virtual DtString makVre::DtVreHumanGunActuatorDescriptor::type ( ) const

overridevirtual

Gets the type identifier for this descriptor.

Returns

String identifying this descriptor type

Returns a unique type identifier string for this descriptor type. Will return DtVreHumanGunActuatorDescriptorType.

clone()

virtual DtComponentDescriptor * makVre::DtVreHumanGunActuatorDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = NULL ) const

overridevirtual

Creates a clone of this descriptor.

Parameters

parentRegistry

Parent registry for reader/writer functionality (optional)

Returns

Pointer to a new descriptor that is a clone of this one

Creates a new human gun actuator descriptor as a deep copy of this one.

maxRange()

virtual DtReal makVre::DtVreHumanGunActuatorDescriptor::maxRange ( ) const

virtual

Gets the maximum range of the weapon.

Returns

The maximum range in meters

Returns the maximum possible range of the weapon, beyond which projectiles cannot travel. This limits the length of the chord used in intersection tests for determining targets.

Referenced by setMaxRange().

setMaxRange()

virtual void makVre::DtVreHumanGunActuatorDescriptor::setMaxRange ( DtReal maxRange )

virtual

Sets the maximum range of the weapon.

Parameters

maxRange

The maximum range in meters

Sets the maximum possible range of the weapon, beyond which projectiles cannot travel. This limits the length of the chord used in intersection tests for determining targets.

References maxRange().

burstPerTrigger()

virtual DtInt16 makVre::DtVreHumanGunActuatorDescriptor::burstPerTrigger ( ) const

virtual

Gets the number of rounds per trigger pull.

Returns

The number of bullets fired per trigger pull

Returns the number of bullets fired per trigger pull for burst fire mode.

setBurstPerTrigger()

virtual void makVre::DtVreHumanGunActuatorDescriptor::setBurstPerTrigger ( DtInt16 rounds )

virtual

Sets the number of rounds per trigger pull.

Parameters

rounds

The number of bullets fired per trigger pull

Sets the number of bullets fired per trigger pull for burst fire mode.

recoilOffset()

virtual const DtVector & makVre::DtVreHumanGunActuatorDescriptor::recoilOffset ( ) const

virtual

Gets the recoil offset vector.

Returns

Reference to the recoil offset vector

Returns the offset vector that controls weapon orientation changes during rapid fire (burst) mode, simulating recoil effects.

setRecoilOffset()

virtual void makVre::DtVreHumanGunActuatorDescriptor::setRecoilOffset ( const DtVector & muzzleOffset )

virtual

Sets the recoil offset vector.

Parameters

muzzleOffset

The recoil offset vector

Sets the offset vector that controls weapon orientation changes during rapid fire (burst) mode, simulating recoil effects.

isRecoilOffsetSpecified()

virtual bool makVre::DtVreHumanGunActuatorDescriptor::isRecoilOffsetSpecified ( ) const

virtual

Checks if recoil offset is specified.

Returns

True if recoil offset is specified, false otherwise

Returns whether a custom recoil offset has been specified for this weapon.

creator()

static DtComponentDescriptor * makVre::DtVreHumanGunActuatorDescriptor::creator ( )

static

Factory function to create a new instance of this descriptor.

Returns

Pointer to a newly created descriptor

Static factory function used by the descriptor creation system to instantiate new instances of this descriptor type.

Member Data Documentation

myMaxRange

DtRwReal makVre::DtVreHumanGunActuatorDescriptor::myMaxRange

protected

Maximum range of the weapon in meters.

The maximum possible range of the weapon, beyond which projectiles cannot travel. This limits the length of the chord used in intersection tests for determining targets. Parameter name: "max-range" Default value: 500.0 meters

myBurstPerTrigger

DtRwInt makVre::DtVreHumanGunActuatorDescriptor::myBurstPerTrigger

protected

Number of bullets fired per trigger pull.

Defines the number of bullets fired in sequence when the trigger is pulled once. Used for burst fire mode configuration. Parameter name: "rounds-per-trigger" Default value: 1 (single shot) Units: Bullets

myRecoilOffset

DtRwOffsetVector makVre::DtVreHumanGunActuatorDescriptor::myRecoilOffset

protected

Recoil offset vector for weapon orientation during rapid fire.

This vector defines how the weapon orientation changes during rapid fire (burst) mode, simulating recoil effects. In a body coordinate system, the axes are specified as follows:

• x: limits of the randomized change in weapon 'heading' (yaw)
• y: limits of the randomized change in weapon 'pitch'
• z: unused

Parameter name: "recoil-offset" Default value: 0.0 Units: Degrees

---

The documentation for this class was generated from the following file:

• include/vrfExtensions/vreVrfobjparam/vreHumanGunActuatorDescriptor.h