com.mak.vrlj.interaction.FireInteraction Class Reference

Simulated weapon firing interaction, describes the firing of a single weapon. More...

Inheritance diagram for com.mak.vrlj.interaction.FireInteraction:

Collaboration diagram for com.mak.vrlj.interaction.FireInteraction:

Public Member Functions
boolean	equals (Object obj)
int	getEventId ()
int	getFireMissionIndex ()
GlobalObjectDesignator	getFiringId ()
FuzeType	getFuzeType ()
GlobalObjectDesignator	getMunitionId ()
EntityType	getMunitionType ()
int	getQuantity ()
double	getRange ()
int	getRate ()
GlobalObjectDesignator	getTargetId ()
ConstVector3f	getVelocity ()
WarheadType	getWarheadType ()
ConstVector3d	getWorldPosition ()
int	hashCode ()
void	setEventId (int eventId)
void	setFireMissionIndex (int theFireMissionIndex)
void	setFiringId (GlobalObjectDesignator firingId)
void	setFuzeType (FuzeType fuzeType)
void	setMunitionId (GlobalObjectDesignator munitionId)
void	setMunitionType (EntityType munitionType)
void	setQuantity (int quantity)
void	setRange (double range)
void	setRate (int rate)
void	setTargetId (GlobalObjectDesignator targetId)
void	setVelocity (ConstVector3f velocity)
void	setWarheadType (WarheadType warheadType)
void	setWorldPosition (ConstVector3d worldPosition)
String	toString ()
String	getInteractionName ()
Public Member Functions inherited from com.mak.vrlj.interaction.BaseInteraction
double	getTimeStamp ()
void	setTimeStamp (double ts)

Static Public Member Functions
static InteractionListener < FireInteraction >	addListener (ExerciseConnection exConn, InteractionListener< FireInteraction > listener)
	Subscribe for callbacks when new interactions are received over the specified ExerciseConnection.
static void	removeListener (ExerciseConnection exConn, InteractionListener< FireInteraction > listener)
	Remove a subscription for interactions callbacks on an ExerciseConnection.

Static Public Attributes
static final String	NAME = ":Fire"
	Interaction class name.

Private Attributes
GlobalObjectDesignator	myFiringId = new GlobalObjectDesignator("")
GlobalObjectDesignator	myTargetId = new GlobalObjectDesignator("")
GlobalObjectDesignator	myMunitionId = new GlobalObjectDesignator("")
ConstVector3d	myWorldPosition
ConstVector3f	myVelocity
double	myRange
int	myEventId
int	myFireMissionIndex
EntityType	myMunitionType = new EntityType(-1, -1, -1, -1, -1, -1, -1)
FuzeType	myFuzeType = FuzeType.OTHER
WarheadType	myWarheadType = WarheadType.OTHER
int	myQuantity
int	myRate

Detailed Description

Simulated weapon firing interaction, describes the firing of a single weapon.

Member Function Documentation

static InteractionListener<FireInteraction> com.mak.vrlj.interaction.FireInteraction.addListener ( ExerciseConnection  exConn, InteractionListener< FireInteraction >  listener  )

inlinestatic

Subscribe for callbacks when new interactions are received over the specified ExerciseConnection.

Parameters

exConn	ExerciseConnection to listen to.
listener	callback receiver.

Returns

the listener argument, for call chaining.

References com.mak.vrlj.vl.ExerciseConnection.addInteractionListener(), and com.mak.vrlj.interaction.FireInteraction.NAME.

Referenced by com.mak.vrlj.example.listen.Listen.main(), and com.mak.vrlj.example.f18.VehicleSim.VehicleSim().

boolean com.mak.vrlj.interaction.FireInteraction.equals ( Object  obj )

inline

References com.mak.vrlj.object.GlobalObjectDesignator.equals(), com.mak.vrlj.datatype.EntityType.equals(), com.mak.vrlj.interaction.FireInteraction.myEventId, com.mak.vrlj.interaction.FireInteraction.myFiringId, com.mak.vrlj.interaction.FireInteraction.myFuzeType, com.mak.vrlj.interaction.FireInteraction.myMunitionId, com.mak.vrlj.interaction.FireInteraction.myMunitionType, com.mak.vrlj.interaction.FireInteraction.myQuantity, com.mak.vrlj.interaction.FireInteraction.myRange, com.mak.vrlj.interaction.FireInteraction.myRate, com.mak.vrlj.interaction.FireInteraction.myTargetId, com.mak.vrlj.interaction.FireInteraction.myVelocity, com.mak.vrlj.interaction.FireInteraction.myWarheadType, and com.mak.vrlj.interaction.FireInteraction.myWorldPosition.

int com.mak.vrlj.interaction.FireInteraction.getEventId ( )

inline

Returns

event ID (sequence number) of this firing event.

References com.mak.vrlj.interaction.FireInteraction.myEventId.

Referenced by com.mak.vrlj.example.f18.VehicleSim.detonateMunition().

int com.mak.vrlj.interaction.FireInteraction.getFireMissionIndex ( )

inline

Returns

the myFireMissionIndex

References com.mak.vrlj.interaction.FireInteraction.myFireMissionIndex.

GlobalObjectDesignator com.mak.vrlj.interaction.FireInteraction.getFiringId ( )

inline

Returns

GlobalObjectDesignator of the firing entity.

References com.mak.vrlj.interaction.FireInteraction.myFiringId.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

FuzeType com.mak.vrlj.interaction.FireInteraction.getFuzeType ( )

inline

Returns

the FuzeType used by the munition fired.

References com.mak.vrlj.interaction.FireInteraction.myFuzeType.

Referenced by com.mak.vrlj.example.f18.VehicleSim.detonateMunition().

String com.mak.vrlj.interaction.FireInteraction.getInteractionName ( )

inlinevirtual

Implements com.mak.vrlj.interaction.Interaction.

References com.mak.vrlj.interaction.FireInteraction.NAME.

GlobalObjectDesignator com.mak.vrlj.interaction.FireInteraction.getMunitionId ( )

inline

Returns

GlobalObjectDesignator of the munition entity.

References com.mak.vrlj.interaction.FireInteraction.myMunitionId.

EntityType com.mak.vrlj.interaction.FireInteraction.getMunitionType ( )

inline

Returns

the type of munition fired.

References com.mak.vrlj.interaction.FireInteraction.myMunitionType.

int com.mak.vrlj.interaction.FireInteraction.getQuantity ( )

inline

Returns

the number of munitions fired.

References com.mak.vrlj.interaction.FireInteraction.myQuantity.

Referenced by com.mak.vrlj.example.f18.VehicleSim.detonateMunition().

double com.mak.vrlj.interaction.FireInteraction.getRange ( )

inline

Returns

the range of the weapon fired in meters.

References com.mak.vrlj.interaction.FireInteraction.myRange.

int com.mak.vrlj.interaction.FireInteraction.getRate ( )

inline

Returns

rate of fire per second.

References com.mak.vrlj.interaction.FireInteraction.myRate.

Referenced by com.mak.vrlj.example.f18.VehicleSim.detonateMunition().

GlobalObjectDesignator com.mak.vrlj.interaction.FireInteraction.getTargetId ( )

inline

Returns

GlobalObjectDesignator of the target entity.

References com.mak.vrlj.interaction.FireInteraction.myTargetId.

Referenced by com.mak.vrlj.example.f18.VehicleSim.detonateMunition(), and com.mak.vrlj.example.f18.VehicleSim.fireMunition().

ConstVector3f com.mak.vrlj.interaction.FireInteraction.getVelocity ( )

inline

Returns

the velocity of the fired munition.

References com.mak.vrlj.interaction.FireInteraction.myVelocity.

WarheadType com.mak.vrlj.interaction.FireInteraction.getWarheadType ( )

inline

Returns

the WarheadType of the fired munition.

References com.mak.vrlj.interaction.FireInteraction.myWarheadType.

Referenced by com.mak.vrlj.example.f18.VehicleSim.detonateMunition().

ConstVector3d com.mak.vrlj.interaction.FireInteraction.getWorldPosition ( )

inline

Returns

the position of where the fired munition was fired from.

References com.mak.vrlj.interaction.FireInteraction.myWorldPosition.

Referenced by com.mak.vrlj.example.f18.VehicleSim.detonateMunition().

int com.mak.vrlj.interaction.FireInteraction.hashCode ( )

inline

References com.mak.vrlj.interaction.FireInteraction.myEventId, com.mak.vrlj.interaction.FireInteraction.myFiringId, com.mak.vrlj.interaction.FireInteraction.myFuzeType, com.mak.vrlj.interaction.FireInteraction.myMunitionId, com.mak.vrlj.interaction.FireInteraction.myMunitionType, com.mak.vrlj.interaction.FireInteraction.myQuantity, com.mak.vrlj.interaction.FireInteraction.myRange, com.mak.vrlj.interaction.FireInteraction.myRate, com.mak.vrlj.interaction.FireInteraction.myTargetId, com.mak.vrlj.interaction.FireInteraction.myVelocity, com.mak.vrlj.interaction.FireInteraction.myWarheadType, and com.mak.vrlj.interaction.FireInteraction.myWorldPosition.

static void com.mak.vrlj.interaction.FireInteraction.removeListener ( ExerciseConnection  exConn, InteractionListener< FireInteraction >  listener  )

inlinestatic

Remove a subscription for interactions callbacks on an ExerciseConnection.

Parameters

exConn	ExerciseConnection listened to.
listener	the callback to remove.

References com.mak.vrlj.interaction.FireInteraction.NAME, and com.mak.vrlj.vl.ExerciseConnection.removeInteractionListener().

void com.mak.vrlj.interaction.FireInteraction.setEventId ( int  eventId )

inline

Parameters

eventId

event ID (sequence number) of this firing event.

References com.mak.vrlj.interaction.FireInteraction.myEventId.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

void com.mak.vrlj.interaction.FireInteraction.setFireMissionIndex ( int  theFireMissionIndex )

inline

Parameters

theFireMissionIndex

the myFireMissionIndex to set

References com.mak.vrlj.interaction.FireInteraction.myFireMissionIndex.

void com.mak.vrlj.interaction.FireInteraction.setFiringId ( GlobalObjectDesignator  firingId )

inline

Parameters

firingId

GlobalObjectDesignator of the firing entity.

References com.mak.vrlj.interaction.FireInteraction.myFiringId.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

void com.mak.vrlj.interaction.FireInteraction.setFuzeType ( FuzeType  fuzeType )

inline

Parameters

fuzeType

the FuzeType used by the munition fired.

References com.mak.vrlj.interaction.FireInteraction.myFuzeType.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

void com.mak.vrlj.interaction.FireInteraction.setMunitionId ( GlobalObjectDesignator  munitionId )

inline

Parameters

munitionId

GlobalObjectDesignator of the munition entity.

References com.mak.vrlj.interaction.FireInteraction.myMunitionId.

void com.mak.vrlj.interaction.FireInteraction.setMunitionType ( EntityType  munitionType )

inline

Parameters

munitionType

the type of munition fired.

References com.mak.vrlj.interaction.FireInteraction.myMunitionType.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

void com.mak.vrlj.interaction.FireInteraction.setQuantity ( int  quantity )

inline

Parameters

quantity

the number of munitioned fired.

References com.mak.vrlj.interaction.FireInteraction.myQuantity.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

void com.mak.vrlj.interaction.FireInteraction.setRange ( double  range )

inline

Parameters

range

the range of the weapon fired in meters.

References com.mak.vrlj.interaction.FireInteraction.myRange.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

void com.mak.vrlj.interaction.FireInteraction.setRate ( int  rate )

inline

Parameters

rate	rate of fire per second.

References com.mak.vrlj.interaction.FireInteraction.myRate.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

void com.mak.vrlj.interaction.FireInteraction.setTargetId ( GlobalObjectDesignator  targetId )

inline

Parameters

targetId

GlobalObjectDesignator of the targeted entity.

References com.mak.vrlj.interaction.FireInteraction.myTargetId.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

void com.mak.vrlj.interaction.FireInteraction.setVelocity ( ConstVector3f  velocity )

inline

Parameters

velocity

the velocity of the fired munition.

References com.mak.vrlj.interaction.FireInteraction.myVelocity.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

void com.mak.vrlj.interaction.FireInteraction.setWarheadType ( WarheadType  warheadType )

inline

Parameters

warheadType

the WarheadType of the fired munition.

References com.mak.vrlj.interaction.FireInteraction.myWarheadType.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

void com.mak.vrlj.interaction.FireInteraction.setWorldPosition ( ConstVector3d  worldPosition )

inline

Parameters

worldPosition

the position of where the fired munition was fired from.

References com.mak.vrlj.interaction.FireInteraction.myWorldPosition.

Referenced by com.mak.vrlj.example.f18.VehicleSim.fireMunition().

String com.mak.vrlj.interaction.FireInteraction.toString ( )

inline

References com.mak.vrlj.interaction.FireInteraction.myEventId, com.mak.vrlj.interaction.FireInteraction.myFiringId, com.mak.vrlj.interaction.FireInteraction.myFuzeType, com.mak.vrlj.interaction.FireInteraction.myMunitionId, com.mak.vrlj.interaction.FireInteraction.myMunitionType, com.mak.vrlj.interaction.FireInteraction.myQuantity, com.mak.vrlj.interaction.FireInteraction.myRange, com.mak.vrlj.interaction.FireInteraction.myRate, com.mak.vrlj.interaction.FireInteraction.myTargetId, com.mak.vrlj.interaction.FireInteraction.myVelocity, com.mak.vrlj.interaction.FireInteraction.myWarheadType, and com.mak.vrlj.interaction.FireInteraction.myWorldPosition.

Member Data Documentation

int com.mak.vrlj.interaction.FireInteraction.myEventId

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getEventId(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setEventId(), and com.mak.vrlj.interaction.FireInteraction.toString().

int com.mak.vrlj.interaction.FireInteraction.myFireMissionIndex

private

Referenced by com.mak.vrlj.interaction.FireInteraction.getFireMissionIndex(), and com.mak.vrlj.interaction.FireInteraction.setFireMissionIndex().

GlobalObjectDesignator com.mak.vrlj.interaction.FireInteraction.myFiringId = new GlobalObjectDesignator("")

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getFiringId(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setFiringId(), and com.mak.vrlj.interaction.FireInteraction.toString().

FuzeType com.mak.vrlj.interaction.FireInteraction.myFuzeType = FuzeType.OTHER

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getFuzeType(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setFuzeType(), and com.mak.vrlj.interaction.FireInteraction.toString().

GlobalObjectDesignator com.mak.vrlj.interaction.FireInteraction.myMunitionId = new GlobalObjectDesignator("")

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getMunitionId(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setMunitionId(), and com.mak.vrlj.interaction.FireInteraction.toString().

EntityType com.mak.vrlj.interaction.FireInteraction.myMunitionType = new EntityType(-1, -1, -1, -1, -1, -1, -1)

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getMunitionType(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setMunitionType(), and com.mak.vrlj.interaction.FireInteraction.toString().

int com.mak.vrlj.interaction.FireInteraction.myQuantity

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getQuantity(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setQuantity(), and com.mak.vrlj.interaction.FireInteraction.toString().

double com.mak.vrlj.interaction.FireInteraction.myRange

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getRange(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setRange(), and com.mak.vrlj.interaction.FireInteraction.toString().

int com.mak.vrlj.interaction.FireInteraction.myRate

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getRate(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setRate(), and com.mak.vrlj.interaction.FireInteraction.toString().

GlobalObjectDesignator com.mak.vrlj.interaction.FireInteraction.myTargetId = new GlobalObjectDesignator("")

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getTargetId(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setTargetId(), and com.mak.vrlj.interaction.FireInteraction.toString().

ConstVector3f com.mak.vrlj.interaction.FireInteraction.myVelocity

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getVelocity(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setVelocity(), and com.mak.vrlj.interaction.FireInteraction.toString().

WarheadType com.mak.vrlj.interaction.FireInteraction.myWarheadType = WarheadType.OTHER

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getWarheadType(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setWarheadType(), and com.mak.vrlj.interaction.FireInteraction.toString().

ConstVector3d com.mak.vrlj.interaction.FireInteraction.myWorldPosition

private

Referenced by com.mak.vrlj.interaction.FireInteraction.equals(), com.mak.vrlj.interaction.FireInteraction.getWorldPosition(), com.mak.vrlj.interaction.FireInteraction.hashCode(), com.mak.vrlj.interaction.FireInteraction.setWorldPosition(), and com.mak.vrlj.interaction.FireInteraction.toString().

final String com.mak.vrlj.interaction.FireInteraction.NAME = ":Fire"

static

Interaction class name.

Referenced by com.mak.vrlj.interaction.FireInteraction.addListener(), com.mak.vrlj.interaction.FireInteraction.getInteractionName(), and com.mak.vrlj.interaction.FireInteraction.removeListener().

---

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

• FireInteraction.java