DtVortexMovementActuatorDescriptor Class Reference

Detailed Description

DtVortexMovementActuatorDescriptor provides configuration for a Vortex physics-based movement actuator. It stores the mechanism name, articulated part mappings, interface descriptors, and configuration parameters for the Vortex physics engine. It also defines various thresholds for position, orientation, velocity, and other physics properties that control when updates are triggered.

This descriptor is used for configuring vehicle movement and other entity physics in the simulation using the Vortex physics engine.

#include <vortexMovementActuatorDescriptor.h>

Inheritance diagram for DtVortexMovementActuatorDescriptor:

Public Member Functions
	DtVortexMovementActuatorDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	DtVortexMovementActuatorDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVortexMovementActuatorDescriptor (const DtVortexMovementActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtVortexMovementActuatorDescriptor () override
DtVortexMovementActuatorDescriptor &	operator= (const DtVortexMovementActuatorDescriptor &orig)
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const override
virtual std::string	mechanismName () const
virtual void	setMechanismName (const std::string &name)
virtual void	setVortexArtPartDescriptorList (const makVre::DtVortexSimArtPartDescriptorList &artPartDescriptorList)
virtual const makVre::DtVortexSimArtPartDescriptorList &	vortexArtPartDescriptorList () const
virtual void	setVortexInterfaceDescriptorList (const makVre::DtVortexInterfaceDescriptorList &interfaceDescriptorList)
virtual const makVre::DtVortexInterfaceDescriptorList &	vortexInterfaceDescriptorList () const
virtual void	setVortexConfigurationDescriptor (const makVre::DtVortexConfigurationDescriptor &configurationDescriptor)
virtual const makVre::DtVortexConfigurationDescriptor &	vortexConfigurationDescriptor () const
virtual double	positionThreshold () const
virtual void	setPositionThreshold (double val)
virtual double	orientationThreshold () const
virtual void	setOrientationThreshold (double val)
virtual double	velocityThreshold () const
virtual void	setVelocityThreshold (double val)
virtual double	angularVelocityThreshold () const
virtual void	setAngularVelocityThreshold (double val)
virtual double	accelerationThreshold () const
virtual void	setAccelerationThreshold (double val)
virtual double	partPositionThreshold () const
virtual void	setPartPositionThreshold (double val)
virtual double	partOrientationThreshold () const
virtual void	setPartOrientationThreshold (double val)
virtual double	partVelocityThreshold () const
virtual void	setPartVelocityThreshold (double val)
virtual double	partAngularVelocityThreshold () const
virtual void	setPartAngularVelocityThreshold (double val)
virtual double	extendedDataThreshold () const
virtual void	setExtendedDataThreshold (double val)
virtual void	setUseArtPartWheelPositions (const bool yesNo)
virtual bool	useArtPartWheelPositions () const
virtual void	setUseMassFromEntity (const bool yesNo)
virtual bool	useMassFromEntity () const
virtual double	fuelEfficiency () const
virtual void	setFuelEfficiency (double d)
virtual double	additionalDropHeight () const
virtual void	setAdditionalDropHeight (double d)
virtual bool	allowVortexWhileDestroyed () const
virtual void	setAllowVortexWhileDestroyed (bool allow)
virtual bool	detectTerrainFallthrough () const
virtual void	setDetectTerrainFallthrough (bool detect)
virtual const DtEntityType &	fuelType () const
virtual void	setFuelType (const DtEntityType &fuelType)

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Attributes
DtRwString	myMechanismFilename
DtRwBoolean	myUseArtPartWheelPositions
DtRwBoolean	myUseMassFromEntity
makVre::DtVortexSimArtPartDescriptorList	myVortexArtPartDescriptorList
makVre::DtVortexInterfaceDescriptorList	myVortexInterfaceDescriptorList
makVre::DtVortexConfigurationDescriptor	myVortexConfigurationDescriptor
DtRwReal	myPositionThreshold
DtRwReal	myOrientationThreshold
DtRwReal	myVelocityThreshold
DtRwReal	myAngularVelocityThreshold
DtRwReal	myPartPositionThreshold
DtRwReal	myPartOrientationThreshold
DtRwReal	myAccelerationThreshold
DtRwReal	myPartLinearVelocityThreshold
DtRwReal	myPartAngularVelocityThreshold
DtRwResource	myFuelType
DtRwReal	myFuelEfficiency
DtRwReal	myExtendedDataThreshold
DtRwBoolean	myAllowVortexWhileDestroyed
DtRwBoolean	myDetectTerrainFallthrough
DtRwReal	myAdditionalHeightToDrop

Private Member Functions
	DtVortexMovementActuatorDescriptor ()

Constructor & Destructor Documentation

DtVortexMovementActuatorDescriptor() [1/4]

DtVortexMovementActuatorDescriptor::DtVortexMovementActuatorDescriptor ( )

private

Default constructor (not implemented)

Private to prevent use - requires component name

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

DtVortexMovementActuatorDescriptor() [2/4]

DtVortexMovementActuatorDescriptor::DtVortexMovementActuatorDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor with component name and registry.

Parameters

componentName	Name of the actuator component
parentRegistry	Optional parent registry for reader/writer operations

DtVortexMovementActuatorDescriptor() [3/4]

DtVortexMovementActuatorDescriptor::DtVortexMovementActuatorDescriptor	(	const DtSymbolString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Constructor with symbol component name and registry.

Parameters

componentName	Symbol string name of the actuator component
parentRegistry	Optional parent registry for reader/writer operations

DtVortexMovementActuatorDescriptor() [4/4]

DtVortexMovementActuatorDescriptor::DtVortexMovementActuatorDescriptor	(	const DtVortexMovementActuatorDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Copy constructor.

Parameters

orig	Original actuator descriptor to copy from
parentRegistry	Optional parent registry for reader/writer operations

References DtVortexMovementActuatorDescriptor().

~DtVortexMovementActuatorDescriptor()

virtual DtVortexMovementActuatorDescriptor::~DtVortexMovementActuatorDescriptor ( )

overridevirtual

Virtual destructor.

Member Function Documentation

operator=()

DtVortexMovementActuatorDescriptor & DtVortexMovementActuatorDescriptor::operator=

(

const DtVortexMovementActuatorDescriptor &

orig

)

Assignment operator.

Parameters

orig	Original actuator descriptor to copy from

Returns

Reference to this actuator descriptor after assignment

References DtVortexMovementActuatorDescriptor().

type()

virtual DtString DtVortexMovementActuatorDescriptor::type ( ) const

overridevirtual

Gets the type of this component descriptor.

Returns

The type string for this component descriptor

Implementation of the DtComponentDescriptor::type() method

clone()

virtual DtComponentDescriptor * DtVortexMovementActuatorDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = 0 ) const

overridevirtual

Creates a clone of this actuator descriptor.

Parameters

parentRegistry

Optional parent registry for reader/writer operations

Returns

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

Implementation of the DtComponentDescriptor::clone() method

creator()

static DtComponentDescriptor * DtVortexMovementActuatorDescriptor::creator ( )

static

Factory method for creating instances of this class.

Returns

Pointer to a new default instance of this descriptor

Implementation of the DtComponentDescriptor::creator() method

mechanismName()

virtual std::string DtVortexMovementActuatorDescriptor::mechanismName ( ) const

virtual

Gets the name of the Vortex mechanism.

Returns

The name of the mechanism file used by this actuator

setMechanismName()

virtual void DtVortexMovementActuatorDescriptor::setMechanismName ( const std::string & name )

virtual

Sets the name of the Vortex mechanism.

Parameters

name	The name of the mechanism file to use

setVortexArtPartDescriptorList()

virtual void DtVortexMovementActuatorDescriptor::setVortexArtPartDescriptorList ( const makVre::DtVortexSimArtPartDescriptorList & artPartDescriptorList )

virtual

Sets the list of Vortex articulated part descriptors.

Parameters

artPartDescriptorList

The list of articulated part descriptors to set

Defines the articulated parts that will be mapped to Vortex physics components

vortexArtPartDescriptorList()

virtual const makVre::DtVortexSimArtPartDescriptorList & DtVortexMovementActuatorDescriptor::vortexArtPartDescriptorList ( ) const

virtual

Gets the list of Vortex articulated part descriptors.

Returns

Constant reference to the list of articulated part descriptors

setVortexInterfaceDescriptorList()

virtual void DtVortexMovementActuatorDescriptor::setVortexInterfaceDescriptorList ( const makVre::DtVortexInterfaceDescriptorList & interfaceDescriptorList )

virtual

Sets the list of Vortex interface descriptors.

Parameters

interfaceDescriptorList

The list of interface descriptors to set

Defines the interfaces for communication with the Vortex physics engine

vortexInterfaceDescriptorList()

virtual const makVre::DtVortexInterfaceDescriptorList & DtVortexMovementActuatorDescriptor::vortexInterfaceDescriptorList ( ) const

virtual

Gets the list of Vortex interface descriptors.

Returns

Constant reference to the list of interface descriptors

setVortexConfigurationDescriptor()

virtual void DtVortexMovementActuatorDescriptor::setVortexConfigurationDescriptor ( const makVre::DtVortexConfigurationDescriptor & configurationDescriptor )

virtual

Sets the Vortex configuration descriptor.

Parameters

configurationDescriptor

The configuration descriptor to set

Defines the configuration parameters for the Vortex physics engine

vortexConfigurationDescriptor()

virtual const makVre::DtVortexConfigurationDescriptor & DtVortexMovementActuatorDescriptor::vortexConfigurationDescriptor ( ) const

virtual

Gets the Vortex configuration descriptor.

Returns

Constant reference to the configuration descriptor

positionThreshold()

virtual double DtVortexMovementActuatorDescriptor::positionThreshold ( ) const

virtual

Gets the position threshold value.

Returns

The threshold value for position updates in meters

Position changes below this threshold will not trigger updates

setPositionThreshold()

virtual void DtVortexMovementActuatorDescriptor::setPositionThreshold ( double val )

virtual

Sets the position threshold value.

Parameters

val	The threshold value to set for position updates in meters

orientationThreshold()

virtual double DtVortexMovementActuatorDescriptor::orientationThreshold ( ) const

virtual

Gets the orientation threshold value.

Returns

The threshold value for orientation updates in radians

Orientation changes below this threshold will not trigger updates

setOrientationThreshold()

virtual void DtVortexMovementActuatorDescriptor::setOrientationThreshold ( double val )

virtual

Sets the orientation threshold value.

Parameters

val	The threshold value to set for orientation updates in radians

velocityThreshold()

virtual double DtVortexMovementActuatorDescriptor::velocityThreshold ( ) const

virtual

Gets the velocity threshold value.

Returns

The threshold value for velocity updates in meters per second

Velocity changes below this threshold will not trigger updates

setVelocityThreshold()

virtual void DtVortexMovementActuatorDescriptor::setVelocityThreshold ( double val )

virtual

Sets the velocity threshold value.

Parameters

val	The threshold value to set for velocity updates in meters per second

angularVelocityThreshold()

virtual double DtVortexMovementActuatorDescriptor::angularVelocityThreshold ( ) const

virtual

Gets the angular velocity threshold value.

Returns

The threshold value for angular velocity updates in radians per second

Angular velocity changes below this threshold will not trigger updates

setAngularVelocityThreshold()

virtual void DtVortexMovementActuatorDescriptor::setAngularVelocityThreshold ( double val )

virtual

Sets the angular velocity threshold value.

Parameters

val	The threshold value to set for angular velocity updates in radians per second

accelerationThreshold()

virtual double DtVortexMovementActuatorDescriptor::accelerationThreshold ( ) const

virtual

Gets the acceleration threshold value.

Returns

The threshold value for acceleration updates in meters per second squared

Acceleration changes below this threshold will not trigger updates

setAccelerationThreshold()

virtual void DtVortexMovementActuatorDescriptor::setAccelerationThreshold ( double val )

virtual

Sets the acceleration threshold value.

Parameters

val	The threshold value to set for acceleration updates in meters per second squared

partPositionThreshold()

virtual double DtVortexMovementActuatorDescriptor::partPositionThreshold ( ) const

virtual

Gets the articulated part position threshold value.

Returns

The threshold value for part position updates in meters

Part position changes below this threshold will not trigger updates

setPartPositionThreshold()

virtual void DtVortexMovementActuatorDescriptor::setPartPositionThreshold ( double val )

virtual

Sets the articulated part position threshold value.

Parameters

val	The threshold value to set for part position updates in meters

partOrientationThreshold()

virtual double DtVortexMovementActuatorDescriptor::partOrientationThreshold ( ) const

virtual

Gets the articulated part orientation threshold value.

Returns

The threshold value for part orientation updates in radians

Part orientation changes below this threshold will not trigger updates

setPartOrientationThreshold()

virtual void DtVortexMovementActuatorDescriptor::setPartOrientationThreshold ( double val )

virtual

Sets the articulated part orientation threshold value.

Parameters

val	The threshold value to set for part orientation updates in radians

partVelocityThreshold()

virtual double DtVortexMovementActuatorDescriptor::partVelocityThreshold ( ) const

virtual

Gets the articulated part velocity threshold value.

Returns

The threshold value for part velocity updates in meters per second

Part velocity changes below this threshold will not trigger updates

setPartVelocityThreshold()

virtual void DtVortexMovementActuatorDescriptor::setPartVelocityThreshold ( double val )

virtual

Sets the articulated part velocity threshold value.

Parameters

val	The threshold value to set for part velocity updates in meters per second

partAngularVelocityThreshold()

virtual double DtVortexMovementActuatorDescriptor::partAngularVelocityThreshold ( ) const

virtual

Gets the articulated part angular velocity threshold value.

Returns

The threshold value for part angular velocity updates in radians per second

Part angular velocity changes below this threshold will not trigger updates

setPartAngularVelocityThreshold()

virtual void DtVortexMovementActuatorDescriptor::setPartAngularVelocityThreshold ( double val )

virtual

Sets the articulated part angular velocity threshold value.

Parameters

val	The threshold value to set for part angular velocity updates in radians per second

extendedDataThreshold()

virtual double DtVortexMovementActuatorDescriptor::extendedDataThreshold ( ) const

virtual

Gets the extended data threshold value.

Returns

The threshold value for extended data updates

Extended data changes below this threshold will not trigger updates

setExtendedDataThreshold()

virtual void DtVortexMovementActuatorDescriptor::setExtendedDataThreshold ( double val )

virtual

Sets the extended data threshold value.

Parameters

val	The threshold value to set for extended data updates

setUseArtPartWheelPositions()

virtual void DtVortexMovementActuatorDescriptor::setUseArtPartWheelPositions ( const bool yesNo )

virtual

Sets whether to use articulated part wheel positions.

Parameters

yesNo

True to use wheel positions from articulated parts, false to use positions from Vortex model

When true, wheel positions in the Vortex model will be adjusted to match the positions specified in articulated parts. When false, the wheel positions in the Vortex model are used as-is. Default is true.

useArtPartWheelPositions()

virtual bool DtVortexMovementActuatorDescriptor::useArtPartWheelPositions ( ) const

virtual

Checks if articulated part wheel positions are being used.

Returns

True if wheel positions from articulated parts are being used, false otherwise

setUseMassFromEntity()

virtual void DtVortexMovementActuatorDescriptor::setUseMassFromEntity ( const bool yesNo )

virtual

Sets whether to use mass from the entity.

Parameters

yesNo

True to use mass from entity definition, false to use mass from Vortex model

When true, the Vortex model will use the mass value specified in the entity definition. When false, the mass value defined in the Vortex mechanism model is used as-is.

useMassFromEntity()

virtual bool DtVortexMovementActuatorDescriptor::useMassFromEntity ( ) const

virtual

Checks if entity mass is being used instead of Vortex model mass.

Returns

True if mass from entity definition is being used, false if Vortex model mass is used

fuelEfficiency()

virtual double DtVortexMovementActuatorDescriptor::fuelEfficiency ( ) const

virtual

Gets the fuel efficiency value.

Returns

The fuel efficiency value in fuel units per distance traveled

Determines how much fuel is consumed when a ground vehicle moves

setFuelEfficiency()

virtual void DtVortexMovementActuatorDescriptor::setFuelEfficiency ( double d )

virtual

Sets the fuel efficiency value.

Parameters

d	The fuel efficiency value in fuel units per distance traveled

additionalDropHeight()

virtual double DtVortexMovementActuatorDescriptor::additionalDropHeight ( ) const

virtual

Gets the additional height to add when dropping a vehicle above terrain.

Returns

The additional drop height in meters (default: 0.5)

This value is used by dropAboveTerrain() to position the vehicle slightly above the calculated terrain height to prevent the vehicle from getting stuck in or clipping through the terrain surface.

See also

setAdditionalDropHeight()

DtVortexMovementActuator::dropAboveTerrain()

setAdditionalDropHeight()

virtual void DtVortexMovementActuatorDescriptor::setAdditionalDropHeight ( double d )

virtual

Sets the additional height to add when dropping a vehicle above terrain.

Parameters

d	The additional drop height in meters (default: 0.5)

Configures the vertical offset added to the terrain height when positioning a vehicle using dropAboveTerrain(). This ensures the vehicle spawns slightly above the terrain to avoid intersection issues.

See also

additionalDropHeight()

DtVortexMovementActuator::dropAboveTerrain()

fuelType()

virtual const DtEntityType & DtVortexMovementActuatorDescriptor::fuelType ( ) const

virtual

Accessor/mutator for myFuelType.

Referenced by setFuelType().

setFuelType()

virtual void DtVortexMovementActuatorDescriptor::setFuelType ( const DtEntityType & fuelType )

virtual

Accessor/mutator for myFuelType.

References fuelType().

allowVortexWhileDestroyed()

virtual bool DtVortexMovementActuatorDescriptor::allowVortexWhileDestroyed ( ) const

virtual

Gets the allow-vortex-while-destroyed flag.

Returns

True if Vortex physics should continue for destroyed entities, false otherwise

When this flag is true, Vortex physics simulation will remain active even when the entity is destroyed or mobility-killed. This allows for realistic physics behavior of destroyed vehicles (e.g., continued rolling, settling, debris physics).

When false (default), Vortex control is disabled for destroyed or mobility-killed entities, and the entity uses standard movement behavior.

Note

Default value is false.

See also

setAllowVortexWhileDestroyed()

setAllowVortexWhileDestroyed()

virtual void DtVortexMovementActuatorDescriptor::setAllowVortexWhileDestroyed ( bool allow )

virtual

Sets the allow-vortex-while-destroyed flag.

Parameters

allow

True to allow Vortex physics for destroyed entities, false to disable

Controls whether Vortex physics simulation continues when the entity is destroyed or mobility-killed. Set to true to enable realistic post-destruction physics (vehicle settling, rolling, etc.). Set to false to use standard movement behavior for destroyed entities.

This setting is read during the actuator's initialization phase and stored in the actuator's myAllowVortexWhileDestroyed member variable.

Note

The default is false, which disables Vortex for destroyed entities.

See also

allowVortexWhileDestroyed()

detectTerrainFallthrough()

virtual bool DtVortexMovementActuatorDescriptor::detectTerrainFallthrough ( ) const

virtual

Gets the detect-terrain-fallthrough flag.

Returns

True if terrain fallthrough detection is enabled, false otherwise

When this flag is true, the actuator will check for terrain availability during Vortex simulation and log diagnostic information when the vehicle falls through the terrain due to missing terrain data.

When false (default), terrain fallthrough detection is disabled.

Note

Default value is false.

See also

setDetectTerrainFallthrough()

setDetectTerrainFallthrough()

virtual void DtVortexMovementActuatorDescriptor::setDetectTerrainFallthrough ( bool detect )

virtual

Sets the detect-terrain-fallthrough flag.

Parameters

detect

True to enable terrain fallthrough detection, false to disable

Controls whether the actuator monitors for terrain fallthrough conditions. When enabled, the actuator will check terrain availability and log warnings when the vehicle position indicates a fall-through scenario.

This setting is read during the actuator's initialization phase.

Note

The default is false, which disables fallthrough detection.

See also

detectTerrainFallthrough()

Member Data Documentation

myMechanismFilename

DtRwString DtVortexMovementActuatorDescriptor::myMechanismFilename

protected

The name of the Vortex mechanism file.

myUseArtPartWheelPositions

DtRwBoolean DtVortexMovementActuatorDescriptor::myUseArtPartWheelPositions

protected

Flag indicating whether to use wheel positions from articulated parts.

myUseMassFromEntity

DtRwBoolean DtVortexMovementActuatorDescriptor::myUseMassFromEntity

protected

Flag indicating whether to use wheel positions from articulated parts.

myVortexArtPartDescriptorList

makVre::DtVortexSimArtPartDescriptorList DtVortexMovementActuatorDescriptor::myVortexArtPartDescriptorList

protected

List of articulated part descriptors for Vortex physics.

myVortexInterfaceDescriptorList

makVre::DtVortexInterfaceDescriptorList DtVortexMovementActuatorDescriptor::myVortexInterfaceDescriptorList

protected

List of interface descriptors for communication with Vortex.

myVortexConfigurationDescriptor

makVre::DtVortexConfigurationDescriptor DtVortexMovementActuatorDescriptor::myVortexConfigurationDescriptor

protected

Configuration descriptor for Vortex physics parameters.

myPositionThreshold

DtRwReal DtVortexMovementActuatorDescriptor::myPositionThreshold

protected

Threshold for vehicle position updates in meters.

myOrientationThreshold

DtRwReal DtVortexMovementActuatorDescriptor::myOrientationThreshold

protected

Threshold for vehicle orientation updates in radians.

myVelocityThreshold

DtRwReal DtVortexMovementActuatorDescriptor::myVelocityThreshold

protected

Threshold for vehicle velocity updates in meters per second.

myAngularVelocityThreshold

DtRwReal DtVortexMovementActuatorDescriptor::myAngularVelocityThreshold

protected

Threshold for vehicle angular velocity updates in radians per second.

myPartPositionThreshold

DtRwReal DtVortexMovementActuatorDescriptor::myPartPositionThreshold

protected

Threshold for articulated part position updates in meters.

myPartOrientationThreshold

DtRwReal DtVortexMovementActuatorDescriptor::myPartOrientationThreshold

protected

Threshold for articulated part orientation updates in radians.

myAccelerationThreshold

DtRwReal DtVortexMovementActuatorDescriptor::myAccelerationThreshold

protected

Threshold for vehicle acceleration updates in meters per second squared.

myPartLinearVelocityThreshold

DtRwReal DtVortexMovementActuatorDescriptor::myPartLinearVelocityThreshold

protected

Threshold for articulated part velocity updates in meters per second.

myPartAngularVelocityThreshold

DtRwReal DtVortexMovementActuatorDescriptor::myPartAngularVelocityThreshold

protected

Threshold for articulated part angular velocity updates in radians per second.

myFuelType

DtRwResource DtVortexMovementActuatorDescriptor::myFuelType

protected

Parameter Name: fuel-type
Parameter Description: The fuel that will be consumed by the surface vessel.
Parameter Default Value: 6:3:0:2:1:0:0 Gasoline
Parameter Units: Entity Type
.

myFuelEfficiency

DtRwReal DtVortexMovementActuatorDescriptor::myFuelEfficiency

protected

Fuel efficiency value in fuel units per distance traveled.

When a ground vehicle moves, this determines how much fuel is consumed. The value is dependent on the unit of measurement of the resource. Default value is 100.

myExtendedDataThreshold

DtRwReal DtVortexMovementActuatorDescriptor::myExtendedDataThreshold

protected

Threshold for extended data updates.

Controls the rate at which extended data changes trigger updates.

myAllowVortexWhileDestroyed

DtRwBoolean DtVortexMovementActuatorDescriptor::myAllowVortexWhileDestroyed

protected

Controls whether Vortex physics continues for destroyed entities.

When true, Vortex physics simulation remains active even when the entity is destroyed or mobility-killed. When false (default), Vortex control is disabled for destroyed or mobility-killed entities.

This setting allows for realistic post-destruction physics behavior, such as a destroyed vehicle continuing to roll down a hill or settle into position.

The value is read by DtVortexMovementActuator during initialization and affects the entity's physics simulation behavior.

Note

Default value is false.

See also

allowVortexWhileDestroyed()

setAllowVortexWhileDestroyed()

myDetectTerrainFallthrough

DtRwBoolean DtVortexMovementActuatorDescriptor::myDetectTerrainFallthrough

protected

Controls whether terrain fallthrough detection is enabled.

When true, the actuator monitors terrain availability during Vortex simulation and logs diagnostic information when terrain fallthrough is detected. When false (default), fallthrough detection is disabled.

This setting is read by DtVortexMovementActuator during initialization and controls whether detectTerrainFallthrough() is called during simulation.

Note

Default value is false.

See also

detectTerrainFallthrough()

setDetectTerrainFallthrough()

myAdditionalHeightToDrop

DtRwReal DtVortexMovementActuatorDescriptor::myAdditionalHeightToDrop

protected

Additional height offset applied when dropping vehicles above terrain.

Specifies the vertical distance (in meters) to add above the calculated terrain height when positioning a vehicle using dropAboveTerrain(). This offset prevents the vehicle from spawning at exactly the terrain surface level, which could cause clipping or intersection issues with the terrain geometry.

The value is used by DtVortexMovementActuator::dropAboveTerrain() to ensure the vehicle's lowest bounding point is positioned slightly above the terrain.

Sysdef parameter: additional-drop-height

Note

Default value is 0.5 meters.

See also

additionalDropHeight()

setAdditionalDropHeight()

DtVortexMovementActuator::dropAboveTerrain()

---

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

• include/vrfExtensions/vreVrfVortexObjparam/vortexMovementActuatorDescriptor.h