<!-- ##### SECTION Title ##### -->
visu_pairs

<!-- ##### SECTION Short_Description ##### -->
V_Sim can draw link between nodes. This part defines a pair object and interface to draw pairs.

<!-- ##### SECTION Long_Description ##### -->
<para>
The visu_pairs.c defines only general methods to draw pairs. It introduces a
new object called #PairsData. This stores some characteristics on links between two
#VisuElement. The main characteristic is that pairs are drawn only if the length between two
nodes is in a specific range. Use setPairsDistance() and getPairsDistance() to tune this range.
</para>
<para>
This file does not draw any pairs. But it gives some interface to create rendering capabilities.
To create a new pair rendering module, called #PairsExtension, use pairsExtension_new().
Basically, a #PairsExtension is characterized by it drawing method. But it can have other
methods that are called in different cases. See initEndOpenGlPairsFunc() and startEndPairsFunc()
prototypes to have more informations.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### MACRO PAIRS_MIN ##### -->
<para>

</para>



<!-- ##### MACRO PAIRS_MAX ##### -->
<para>

</para>



<!-- ##### MACRO PAIRS_COLOR_R ##### -->
<para>

</para>



<!-- ##### MACRO PAIRS_COLOR_G ##### -->
<para>

</para>



<!-- ##### MACRO PAIRS_COLOR_B ##### -->
<para>

</para>



<!-- ##### USER_FUNCTION foreachPairsFunc ##### -->
<para>

</para>

@data: 
@userData: 


<!-- ##### STRUCT pairsData_struct ##### -->
<para>

</para>

@name1: 
@name2: 
@minMax: 
@properties: 
@drawn: 

<!-- ##### TYPEDEF PairsData ##### -->
<para>

</para>


<!-- ##### FUNCTION setPairsOnOff ##### -->
<para>

</para>

@onOff: 
@Returns: 


<!-- ##### FUNCTION setPairsAll ##### -->
<para>

</para>

@data: 
@rgb: 
@minMax: 
@Returns: 


<!-- ##### FUNCTION setPairsDistance ##### -->
<para>

</para>

@val: 
@data: 
@minOrMax: 
@Returns: 
<!-- # Unused Parameters # -->
@ele1: 
@ele2: 


<!-- ##### FUNCTION setPairsDrawn ##### -->
<para>

</para>

@data: 
@drawn: 
@Returns: 


<!-- ##### FUNCTION setPairsColor ##### -->
<para>

</para>

@data: 
@color: 
@Returns: 
<!-- # Unused Parameters # -->
@val: 
@ele1: 
@ele2: 


<!-- ##### FUNCTION setPairsProperty ##### -->
<para>

</para>

@data: 
@key: 
@value: 


<!-- ##### FUNCTION getPairsOnOff ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION getPairsDistance ##### -->
<para>

</para>

@ele1: 
@ele2: 
@minOrMax: 
@Returns: 


<!-- ##### FUNCTION getPairsData ##### -->
<para>

</para>

@ele1: 
@ele2: 
@Returns: 


<!-- ##### FUNCTION getPairsDrawn ##### -->
<para>

</para>

@data: 
@Returns: 


<!-- ##### FUNCTION getPairsProperty ##### -->
<para>

</para>

@data: 
@key: 
@Returns: 


<!-- ##### FUNCTION foreachPairsData ##### -->
<para>

</para>

@whatToDo: 
@userData: 


<!-- ##### FUNCTION createPairs ##### -->
<para>

</para>

@dataObj: 
@Returns: 


<!-- ##### USER_FUNCTION initEndOpenGlPairsFunc ##### -->
<para>

</para>



<!-- ##### USER_FUNCTION startEndPairsFunc ##### -->
<para>

</para>

@ele1: 
@ele2: 
@data: 


<!-- ##### USER_FUNCTION pairDefinitionFunc ##### -->
<para>

</para>

@ele1: 
@ele2: 
@data: 
@view: 
@x1: 
@y1: 
@z1: 
@x2: 
@y2: 
@z2: 
@d2: 


<!-- ##### STRUCT PairsExtension_struct ##### -->
<para>

</para>

@name: 
@printName: 
@description: 
@sensitiveToFacette: 
@initOpenGl: 
@stopOpenGl: 
@beginDrawingPairs: 
@endDrawingPairs: 
@drawPairs: 

<!-- ##### TYPEDEF PairsExtension ##### -->
<para>

</para>


<!-- ##### FUNCTION pairsExtension_new ##### -->
<para>

</para>

@name: 
@printName: 
@description: 
@sensitive: 
@init: 
@stop: 
@start: 
@end: 
@draw: 
@Returns: 


<!-- ##### FUNCTION PairsExtension_free ##### -->
<para>

</para>

@extension: 


<!-- ##### FUNCTION registerPairsExtension ##### -->
<para>

</para>

@extension: 


<!-- ##### FUNCTION setPairsMethod ##### -->
<para>

</para>

@extension: 
@Returns: 


<!-- ##### FUNCTION setPairsAreOutOfDate ##### -->
<para>

</para>



<!-- ##### FUNCTION getCurrentPairsMethods ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION isValidPairsExtension ##### -->
<para>

</para>

@pairsModel: 
@Returns: 


<!-- ##### FUNCTION getAllPairsMethods ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION getNameOfPairsMethod ##### -->
<para>

</para>

@extension: 
@Returns: 


<!-- ##### FUNCTION initPairsModule ##### -->
<para>

</para>

@Returns: 


