diguy_module_net.h File Reference

Contains the diguyNetInterface class declaration. More...

#include <declspec_diguy.h>
#include <diguy_constants.h>
#include <stddef.h>

Go to the source code of this file.

Classes
class	diguyNetInterface
	This class provides accessors to the interface parameters, as well as functions for going online and offline. More...

Enumerations
enum	diguyCoordinateSystemType { DIGUY_COORDINATE_SYSTEM_NONE = 0, DIGUY_COORDINATE_SYSTEM_UTM = 1, DIGUY_COORDINATE_SYSTEM_FLAT_EARTH = 2, DIGUY_COORDINATE_SYSTEM_GEOCENTRIC = 3 }

Functions
int	diguy_module_net_initialize ()
	This function allows VR-Link to install some callbacks so that DSS file load and save will include VR-Link-specific info. More...
int	diguy_module_net_deinitialize ()
	This function allows DI-Guy networking to clean up. More...
diguyNetInterface *	get_net_interface ()
	This function returns a diguyNetInterface which can be used to change settings on the networking module. More...

Variables
comment line count1comment line count1comment line count1comment line count1comment line count1comment line	count1

Detailed Description

Contains the diguyNetInterface class declaration.

Enumeration Type Documentation

enum diguyCoordinateSystemType

Enumerator
DIGUY_COORDINATE_SYSTEM_NONE
DIGUY_COORDINATE_SYSTEM_UTM
DIGUY_COORDINATE_SYSTEM_FLAT_EARTH
DIGUY_COORDINATE_SYSTEM_GEOCENTRIC

Function Documentation

int diguy_module_net_initialize

(

)

This function allows VR-Link to install some callbacks so that DSS file load and save will include VR-Link-specific info.

It should be called BEFORE the scenario object is constructed.

Returns:

0 on success, -1 on failure

Example:

diguy_module_net_initialize();

int diguy_module_net_deinitialize

(

)

This function allows DI-Guy networking to clean up.

It should be called once, on application shutdown, after the scenario object has been destroyed.

Returns:

0 on success, -1 on failure

Example:

diguy_module_net_deinitialize();

diguyNetInterface* get_net_interface

(

)

This function returns a diguyNetInterface which can be used to change settings on the networking module.

This will be an appropriate version of the net interface, i.e. a DIS or a HLA interface, depending on which library was linked in.

Returns:

pointer to a diguyNetInterface

Variable Documentation

comment line count1comment line count1comment line count1comment line count1comment line count1comment line count1