BotNavSim  v0.4.3
Mobile Robot Simulation
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ProximityData Struct Reference

Proximity data structure. More...

Public Member Functions

 ProximityData (Vector3 direction, bool obstructed)
 Initializes a new instance of the ProximityData struct. More...
 

Static Public Member Functions

static bool operator< (ProximityData d1, ProximityData d2)
 Compares direction.magnitudes More...
 
static bool operator> (ProximityData d1, ProximityData d2)
 Compares direction.magnitudes More...
 

Public Attributes

Vector3 direction
 The direction of the proximity More...
 
bool obstructed
 Indicates whether or not the location at the end of the direction is obstructed. More...
 

Detailed Description

Proximity data structure.

Definition at line 7 of file ProximityData.cs.

Constructor & Destructor Documentation

ProximityData.ProximityData ( Vector3  direction,
bool  obstructed 
)

Initializes a new instance of the ProximityData struct.

Parameters
directionDirection.
obstructedIf set to true obstructed.

Definition at line 23 of file ProximityData.cs.

23  {
24  this.direction = direction;
25  this.obstructed = obstructed;
26  }
ProximityData.obstructed
bool obstructed
Indicates whether or not the location at the end of the direction is obstructed.
Definition: ProximityData.cs:16
ProximityData.direction
Vector3 direction
The direction of the proximity
Definition: ProximityData.cs:11

Member Function Documentation

static bool ProximityData.operator< ( ProximityData  d1,
ProximityData  d2 
)
static

Compares direction.magnitudes

Parameters
d1D1.
d2D2.

Definition at line 31 of file ProximityData.cs.

31  {
32  return d1.direction.magnitude < d2.direction.magnitude;
33  }
ProximityData.direction
Vector3 direction
The direction of the proximity
Definition: ProximityData.cs:11
static bool ProximityData.operator> ( ProximityData  d1,
ProximityData  d2 
)
static

Compares direction.magnitudes

Parameters
d1D1.
d2D2.

Definition at line 38 of file ProximityData.cs.

38  {
39  return d1.direction.magnitude > d2.direction.magnitude;
40  }
ProximityData.direction
Vector3 direction
The direction of the proximity
Definition: ProximityData.cs:11

Member Data Documentation

Vector3 ProximityData.direction

The direction of the proximity

Definition at line 11 of file ProximityData.cs.

bool ProximityData.obstructed

Indicates whether or not the location at the end of the direction is obstructed.

Definition at line 16 of file ProximityData.cs.

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