Brian M. Ames
and 1 contributors

NAME

Rinchi::CIGIPP::TrajectoryDefinition - Perl extension for the Common Image Generator Interface - Trajectory Definition data packet. data packet. =head1 SYNOPSIS

  use Rinchi::CIGIPP::TrajectoryDefinition;
  my $traj_def = Rinchi::CIGIPP::TrajectoryDefinition->new();

  $packet_type = $traj_def->packet_type();
  $packet_size = $traj_def->packet_size();
  $entity_ident = $traj_def->entity_ident(55021);
  $x_acceleration = $traj_def->x_acceleration(60.29);
  $y_acceleration = $traj_def->y_acceleration(33.53);
  $z_acceleration = $traj_def->z_acceleration(3.749);
  $retardation_rate = $traj_def->retardation_rate(5.483);
  $terminal_velocity = $traj_def->terminal_velocity(84.799);

DESCRIPTION

The Trajectory Definition packet enables the Host to describe a trajectory along which an IG-driven entity, such as a tracer round or particulate debris, travels. This is useful for simulating gravity and other static forces acting upon the entity. This packet is commonly used in conjunction with the Rate Control packet.

EXPORT

None by default.

#==============================================================================

new $traj_def = Rinchi::CIGIPP::TrajectoryDefinition->new()

Constructor for Rinchi::TrajectoryDefinition.

sub packet_type()
 $value = $traj_def->packet_type();

Data Packet Identifier.

This attribute identifies this data packet as the Trajectory Definition packet. The value of this attribute must be 20.

sub packet_size()
 $value = $traj_def->packet_size();

Data Packet Size.

This attribute indicates the number of bytes in this data packet. The value of this attribute must be 24.

sub entity_ident([$newValue])
 $value = $traj_def->entity_ident($newValue);

Entity ID.

This attribute identifies the entity for which the trajectory is defined.

sub x_acceleration([$newValue])
 $value = $traj_def->x_acceleration($newValue);

Acceleration X.

This attribute specifies the X component of the acceleration vector.

sub y_acceleration([$newValue])
 $value = $traj_def->y_acceleration($newValue);

Acceleration Y.

This attribute specifies the Y component of the acceleration vector.

sub z_acceleration([$newValue])
 $value = $traj_def->z_acceleration($newValue);

Acceleration Z.

This attribute specifies the Z component of the acceleration vector.

sub retardation_rate([$newValue])
 $value = $traj_def->retardation_rate($newValue);

Retardation Rate.

This attribute specifies the magnitude of an acceleration applied against the entity's instantaneous linear velocity vector. This is used to simulate drag and other frictional forces acting upon the entity.

sub terminal_velocity([$newValue])
 $value = $traj_def->terminal_velocity($newValue);

Terminal Velocity.

This attribute specifies the maximum velocity the entity can sustain.

sub pack()
 $value = $traj_def->pack();

Returns the packed data packet.

sub unpack()
 $value = $traj_def->unpack();

Unpacks the packed data packet.

sub byte_swap()
 $obj_name->byte_swap();

Byte swaps the packed data packet.

SEE ALSO

Refer the the Common Image Generator Interface ICD which may be had at this URL: http://cigi.sourceforge.net/specification.php

AUTHOR

Brian M. Ames, <bmames@apk.net>

COPYRIGHT AND LICENSE

Copyright (C) 2009 by Brian M. Ames

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.6 or, at your option, any later version of Perl 5 you may have available.

2 POD Errors

The following errors were encountered while parsing the POD:

Around line 72:

'=item' outside of any '=over'

Around line 355:

You forgot a '=back' before '=head1'