VR-Link JAVA API Documentation
 All Classes Namespaces Files Functions Variables Enumerator Pages
List of all members | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes
com.mak.vrlj.interaction.DetonateInteraction Class Reference

Simulated munition detonation. More...

+ Inheritance diagram for com.mak.vrlj.interaction.DetonateInteraction:
+ Collaboration diagram for com.mak.vrlj.interaction.DetonateInteraction:

Public Member Functions

boolean equals (Object obj)
List< ArticulatedPartgetArticulatedParts ()
ConstVector3f getEntityLocation ()
int getEventId ()
GlobalObjectDesignator getFiringId ()
FuzeType getFuzeType ()
GlobalObjectDesignator getMunitionId ()
EntityType getMunitionType ()
int getQuantity ()
double getRange ()
int getRate ()
ResultType getResult ()
GlobalObjectDesignator getTargetId ()
ConstVector3f getVelocity ()
WarheadType getWarheadType ()
ConstVector3d getWorldPosition ()
int hashCode ()
void setArticulatedParts (List< ArticulatedPart > theArticulatedParts)
void setEntityLocation (ConstVector3f entityLocation)
void setEventId (int eventId)
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 setResult (ResultType result)
void setTargetId (GlobalObjectDesignator targetId)
void setVelocity (ConstVector3f velocity)
void setWarheadType (WarheadType warheadType)
void setWorldPosition (ConstVector3d worldPosition)
String toString ()

Static Public Member Functions

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

Static Public Attributes

static final String NAME = ":Detonate"
 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
EntityType myMunitionType = new EntityType(-1, -1, -1, -1, -1, -1, -1)
FuzeType myFuzeType = FuzeType.OTHER
WarheadType myWarheadType = WarheadType.OTHER
int myQuantity
int myRate
ConstVector3f myEntityLocation
ResultType myResult = ResultType.OTHER
List< ArticulatedPartmyArticulatedParts = new ArrayList<ArticulatedPart>()

Detailed Description

Simulated munition detonation.

Member Function Documentation

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

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

Parameters
exConnExerciseConnection to listen to.
listenercallback receiver.
Returns
the listener argument, for call chaining.

References com.mak.vrlj.vl.ExerciseConnection.getInteractionDispatcher(), and com.mak.vrlj.interaction.DetonateInteraction.NAME.

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

boolean com.mak.vrlj.interaction.DetonateInteraction.equals ( Object  obj)
inline
List<ArticulatedPart> com.mak.vrlj.interaction.DetonateInteraction.getArticulatedParts ( )
inline
Returns
the myArticulatedParts

References com.mak.vrlj.interaction.DetonateInteraction.myArticulatedParts.

ConstVector3f com.mak.vrlj.interaction.DetonateInteraction.getEntityLocation ( )
inline
Returns
location of detonation in coordinate system of target entity.

References com.mak.vrlj.interaction.DetonateInteraction.myEntityLocation.

int com.mak.vrlj.interaction.DetonateInteraction.getEventId ( )
inline
Returns
event ID (sequence number) of this firing event.

References com.mak.vrlj.interaction.DetonateInteraction.myEventId.

GlobalObjectDesignator com.mak.vrlj.interaction.DetonateInteraction.getFiringId ( )
inline
FuzeType com.mak.vrlj.interaction.DetonateInteraction.getFuzeType ( )
inline
Returns
the FuzeType used by the munition fired.

References com.mak.vrlj.interaction.DetonateInteraction.myFuzeType.

GlobalObjectDesignator com.mak.vrlj.interaction.DetonateInteraction.getMunitionId ( )
inline
EntityType com.mak.vrlj.interaction.DetonateInteraction.getMunitionType ( )
inline
Returns
the type of munition fired.

References com.mak.vrlj.interaction.DetonateInteraction.myMunitionType.

int com.mak.vrlj.interaction.DetonateInteraction.getQuantity ( )
inline
Returns
the number of munitions fired.

References com.mak.vrlj.interaction.DetonateInteraction.myQuantity.

double com.mak.vrlj.interaction.DetonateInteraction.getRange ( )
inline
Returns
the range of the weapon fired in meters.

References com.mak.vrlj.interaction.DetonateInteraction.myRange.

int com.mak.vrlj.interaction.DetonateInteraction.getRate ( )
inline
Returns
rate of fire per second.

References com.mak.vrlj.interaction.DetonateInteraction.myRate.

ResultType com.mak.vrlj.interaction.DetonateInteraction.getResult ( )
inline
GlobalObjectDesignator com.mak.vrlj.interaction.DetonateInteraction.getTargetId ( )
inline
ConstVector3f com.mak.vrlj.interaction.DetonateInteraction.getVelocity ( )
inline
Returns
the velocity of the fired munition.

References com.mak.vrlj.interaction.DetonateInteraction.myVelocity.

WarheadType com.mak.vrlj.interaction.DetonateInteraction.getWarheadType ( )
inline
Returns
the WarheadType of the fired munition.

References com.mak.vrlj.interaction.DetonateInteraction.myWarheadType.

ConstVector3d com.mak.vrlj.interaction.DetonateInteraction.getWorldPosition ( )
inline
Returns
the position of where the munition detonated.

References com.mak.vrlj.interaction.DetonateInteraction.myWorldPosition.

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

int com.mak.vrlj.interaction.DetonateInteraction.hashCode ( )
inline
static void com.mak.vrlj.interaction.DetonateInteraction.removeListener ( ExerciseConnection  exConn,
InteractionListener< DetonateInteraction listener 
)
inlinestatic

Remove a subscription for interactions callbacks on an ExerciseConnection.

Parameters
exConnExerciseConnection listened to.
listenerthe callback to remove.

References com.mak.vrlj.vl.ExerciseConnection.getInteractionDispatcher(), and com.mak.vrlj.interaction.DetonateInteraction.NAME.

void com.mak.vrlj.interaction.DetonateInteraction.setArticulatedParts ( List< ArticulatedPart theArticulatedParts)
inline
Parameters
theArticulatedPartsthe myArticulatedParts to set

References com.mak.vrlj.interaction.DetonateInteraction.myArticulatedParts.

void com.mak.vrlj.interaction.DetonateInteraction.setEntityLocation ( ConstVector3f  entityLocation)
inline
Parameters
entityLocationlocation of detonation in coordinate system of target entity.

References com.mak.vrlj.interaction.DetonateInteraction.myEntityLocation.

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

void com.mak.vrlj.interaction.DetonateInteraction.setEventId ( int  eventId)
inline
Parameters
eventIdevent ID (sequence number) of this firing event.

References com.mak.vrlj.interaction.DetonateInteraction.myEventId.

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

void com.mak.vrlj.interaction.DetonateInteraction.setFiringId ( GlobalObjectDesignator  firingId)
inline
void com.mak.vrlj.interaction.DetonateInteraction.setFuzeType ( FuzeType  fuzeType)
inline
Parameters
fuzeTypethe FuzeType used by the munition fired.

References com.mak.vrlj.interaction.DetonateInteraction.myFuzeType.

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

void com.mak.vrlj.interaction.DetonateInteraction.setMunitionId ( GlobalObjectDesignator  munitionId)
inline
Parameters
munitionIdGlobalObjectDesignator of the firing entity.

References com.mak.vrlj.interaction.DetonateInteraction.myMunitionId.

void com.mak.vrlj.interaction.DetonateInteraction.setMunitionType ( EntityType  munitionType)
inline
Parameters
munitionTypethe type of munition fired.

References com.mak.vrlj.interaction.DetonateInteraction.myMunitionType.

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

void com.mak.vrlj.interaction.DetonateInteraction.setQuantity ( int  quantity)
inline
Parameters
quantitythe number of munitioned fired.

References com.mak.vrlj.interaction.DetonateInteraction.myQuantity.

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

void com.mak.vrlj.interaction.DetonateInteraction.setRange ( double  range)
inline
Parameters
rangethe range of the weapon fired in meters.

References com.mak.vrlj.interaction.DetonateInteraction.myRange.

void com.mak.vrlj.interaction.DetonateInteraction.setRate ( int  rate)
inline
Parameters
raterate of fire per second.

References com.mak.vrlj.interaction.DetonateInteraction.myRate.

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

void com.mak.vrlj.interaction.DetonateInteraction.setResult ( ResultType  result)
inline
void com.mak.vrlj.interaction.DetonateInteraction.setTargetId ( GlobalObjectDesignator  targetId)
inline
void com.mak.vrlj.interaction.DetonateInteraction.setVelocity ( ConstVector3f  velocity)
inline
Parameters
velocitythe velocity of the fired munition.

References com.mak.vrlj.interaction.DetonateInteraction.myVelocity.

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

void com.mak.vrlj.interaction.DetonateInteraction.setWarheadType ( WarheadType  warheadType)
inline
void com.mak.vrlj.interaction.DetonateInteraction.setWorldPosition ( ConstVector3d  worldPosition)
inline
Parameters
worldPositionthe position of where the munition detonated.

References com.mak.vrlj.interaction.DetonateInteraction.myWorldPosition.

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

String com.mak.vrlj.interaction.DetonateInteraction.toString ( )
inline

Member Data Documentation

List<ArticulatedPart> com.mak.vrlj.interaction.DetonateInteraction.myArticulatedParts = new ArrayList<ArticulatedPart>()
private
ConstVector3f com.mak.vrlj.interaction.DetonateInteraction.myEntityLocation
private
int com.mak.vrlj.interaction.DetonateInteraction.myEventId
private
GlobalObjectDesignator com.mak.vrlj.interaction.DetonateInteraction.myFiringId = new GlobalObjectDesignator("")
private
FuzeType com.mak.vrlj.interaction.DetonateInteraction.myFuzeType = FuzeType.OTHER
private
GlobalObjectDesignator com.mak.vrlj.interaction.DetonateInteraction.myMunitionId = new GlobalObjectDesignator("")
private
EntityType com.mak.vrlj.interaction.DetonateInteraction.myMunitionType = new EntityType(-1, -1, -1, -1, -1, -1, -1)
private
int com.mak.vrlj.interaction.DetonateInteraction.myQuantity
private
double com.mak.vrlj.interaction.DetonateInteraction.myRange
private
int com.mak.vrlj.interaction.DetonateInteraction.myRate
private
ResultType com.mak.vrlj.interaction.DetonateInteraction.myResult = ResultType.OTHER
private
GlobalObjectDesignator com.mak.vrlj.interaction.DetonateInteraction.myTargetId = new GlobalObjectDesignator("")
private
ConstVector3f com.mak.vrlj.interaction.DetonateInteraction.myVelocity
private
WarheadType com.mak.vrlj.interaction.DetonateInteraction.myWarheadType = WarheadType.OTHER
private
ConstVector3d com.mak.vrlj.interaction.DetonateInteraction.myWorldPosition
private
final String com.mak.vrlj.interaction.DetonateInteraction.NAME = ":Detonate"
static

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

Document ID: Generated on Tue Mar 1 02:56:17 EST 2016 from SVN revision 162687
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)