  | 
  
    DATAKIT API
    V2025.4
    
   
   | 
           
 | 
 
 
 
 
This is the Dtk_NodeConnector Class.
.  
 More...
 | 
| enum   | ReasonCategoryEnum {  
  UnknownCategory = 0, 
PlacementCategory, 
GeneralAssociationCategory, 
VisibilityCategory, 
 
  FirstRefBlockSituationCategory, 
SecondRefBlockSituationCategory, 
ThirdRefBlockSituationCategory
 
 } | 
|   | Reason Category. Global Category of the NodeConnector uesed to gather Reason into families.  More...
  | 
|   | 
| enum   | ReasonLinkEnum {  
  Unknown = 0, 
VerticallyAligned, 
HorizontallyAligned, 
StackedLeft, 
 
  StackedRight, 
StackedAbove, 
StackedBelow, 
PositionallyFixed, 
 
  OrientationallyFixed, 
ForceHidden, 
ForceVisible, 
ForceClipped, 
 
  KeepOnlyFdt, 
FirstRefBlockSituation_Common, 
FirstRefBlockSituation_1, 
FirstRefBlockSituation_2, 
 
  FirstRefBlockSituation_3, 
SecondRefBlockSituation_Common, 
SecondRefBlockSituation_1, 
SecondRefBlockSituation_2, 
 
  SecondRefBlockSituation_3, 
ThirdRefBlockSituation_Common, 
ThirdRefBlockSituation_1, 
ThirdRefBlockSituation_2, 
 
  ThirdRefBlockSituation_3, 
AssociatedGeometry, 
AssociatedFeature, 
SubPMI, 
 
  DefaultAnnotationLink, 
HighlightedGeometry, 
Support, 
AssociatedAxisSystem, 
 
  AssociatedXDirection, 
AssociatedYDirection, 
AssociatedZDirection, 
AssociatedCenterPoint, 
 
  Context
 
 } | 
|   | Reason - Type of the Dtk_NodeConnector -. It's used to filter connectors to same elements.  More...
  | 
|   | 
 | 
| enum   | { _typeID = DTK_TYPE_OBJECT
 } | 
|   | 
| enum   | { _typeID = DTK_TYPE_NODE_CONNECTOR
 } | 
|   | 
This is the Dtk_NodeConnector Class.
. 
- See also
 - Use Dtk_NodeConnectorPtr class to handle it. 
 
 
◆ anonymous enum
◆ anonymous enum
◆ ReasonCategoryEnum
Reason Category. Global Category of the NodeConnector uesed to gather Reason into families. 
| Enumerator | 
|---|
| UnknownCategory  |  | 
| PlacementCategory  |  | 
| GeneralAssociationCategory  |  | 
| VisibilityCategory  |  | 
| FirstRefBlockSituationCategory  |  | 
| SecondRefBlockSituationCategory  |  | 
| ThirdRefBlockSituationCategory  |  | 
 
 
◆ ReasonLinkEnum
Reason - Type of the Dtk_NodeConnector -. It's used to filter connectors to same elements. 
| Enumerator | 
|---|
| Unknown  |  | 
| VerticallyAligned  |  | 
| HorizontallyAligned  |  | 
| StackedLeft  |  | 
| StackedRight  |  | 
| StackedAbove  |  | 
| StackedBelow  |  | 
| PositionallyFixed  |  | 
| OrientationallyFixed  |  | 
| ForceHidden  |  | 
| ForceVisible  |  | 
| ForceClipped  |  | 
| KeepOnlyFdt  |  | 
| FirstRefBlockSituation_Common  |  | 
| FirstRefBlockSituation_1  |  | 
| FirstRefBlockSituation_2  |  | 
| FirstRefBlockSituation_3  |  | 
| SecondRefBlockSituation_Common  |  | 
| SecondRefBlockSituation_1  |  | 
| SecondRefBlockSituation_2  |  | 
| SecondRefBlockSituation_3  |  | 
| ThirdRefBlockSituation_Common  |  | 
| ThirdRefBlockSituation_1  |  | 
| ThirdRefBlockSituation_2  |  | 
| ThirdRefBlockSituation_3  |  | 
| AssociatedGeometry  |  | 
| AssociatedFeature  |  | 
| SubPMI  |  | 
| DefaultAnnotationLink  |  | 
| HighlightedGeometry  |  | 
| Support  |  | 
| AssociatedAxisSystem  |  | 
| AssociatedXDirection  |  | 
| AssociatedYDirection  |  | 
| AssociatedZDirection  |  | 
| AssociatedCenterPoint  |  | 
| Context  |  | 
 
 
◆ Dtk_NodeConnector() [1/2]
  
  
      
        
          | Dtk_NodeConnector::Dtk_NodeConnector  | 
          ( | 
           | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
 
◆ Dtk_NodeConnector() [2/2]
Copy constructor. 
- Parameters
 - 
  
  
 
 
 
◆ ~Dtk_NodeConnector()
  
  
      
        
          | Dtk_NodeConnector::~Dtk_NodeConnector  | 
          ( | 
           | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
 
◆ _Copy()
◆ _Init()
  
  
      
        
          | void Dtk_NodeConnector::_Init  | 
          ( | 
           | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
 
◆ _Reset()
  
  
      
        
          | void Dtk_NodeConnector::_Reset  | 
          ( | 
           | ) | 
           | 
         
       
   | 
  
protected   | 
  
 
 
◆ AddSubEntities()
Add a set of SubEntities - defined by their IDs and Types - to the SubEntities list. 
- Parameters
 - 
  
    | inSubEntities | SubEntities array  | 
  
   
- Returns
 - DtkNoError if no error. 
 
 
 
◆ AddSubEntity()
Add a SubEntity - defined by their IDs and Types - to the SubEntities list. 
- Parameters
 - 
  
  
 
- Returns
 - DtkNoError if no error. 
 
 
 
◆ CheckAssociatedPathComponentID()
Checks if the Path Component ID exist into Dtk_MainDocPtr. 
Returns true if path connector exists else returns false 
 
 
◆ Clone()
◆ Create() [1/2]
Calls default constructor to allocate a new object. 
 
 
◆ Create() [2/2]
Calls copy constructor to allocate a new object. 
- Parameters
 - 
  
  
 
 
 
◆ DtkDynamicCast()
Performs a dynamic cast - doesn't need RTTI -. 
 
 
◆ DtkDynamicType() [1/2]
Retrieves the dynamic entity type. 
 
 
◆ DtkDynamicType() [2/2]
  
  
      
        
          | virtual int Dtk_Object::DtkDynamicType  | 
          ( | 
          const int &  | 
          inId | ) | 
           | 
         
       
   | 
  
pure virtualinherited   | 
  
 
Implemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshPolyline, Dtk_MeshSurface, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Constraint, Dtk_ConstraintReference, Dtk_AxisSystem, Dtk_Preview, Dtk_Entity, Dtk_picture, Dtk_OverrideSet, Dtk_OverrideInfo, Dtk_MainDoc, Dtk_Component, Dtk_Node, Dtk_DocElement, Dtk_Log, and Dtk_Properties.
 
 
◆ dump()
  
  
      
        
          | virtual void Dtk_Object::dump  | 
          ( | 
          FILE *  | 
          file = stdout | ) | 
           | 
         
       
   | 
  
virtualinherited   | 
  
 
 
◆ get_type_detk()
      
        
          | type_detk Dtk_NodeConnector::get_type_detk  | 
          ( | 
           | ) | 
           const | 
        
      
 
- Returns
 - The type of the entity type - DTK_TYPE_FDT - 
 
 
 
◆ GetAssociatedComponentID()
      
        
          | Dtk_ID Dtk_NodeConnector::GetAssociatedComponentID  | 
          ( | 
           | ) | 
           const | 
        
      
 
Returns the Component ID referenced by the connector. 
 
 
◆ GetAssociatedPathComponentID() [1/2]
      
        
          | const Dtk_tab<Dtk_ID>& Dtk_NodeConnector::GetAssociatedPathComponentID  | 
          ( | 
           | ) | 
           const | 
        
      
 
Returns the Path Component ID referenced by the connector from Root to Target. 
 
 
◆ GetAssociatedPathComponentID() [2/2]
      
        
          | void Dtk_NodeConnector::GetAssociatedPathComponentID  | 
          ( | 
          Dtk_tab< Dtk_ID > &  | 
          outAssociatedPathComponentID | ) | 
           const | 
        
      
 
 
◆ GetNodeId()
      
        
          | Dtk_ID Dtk_NodeConnector::GetNodeId  | 
          ( | 
           | ) | 
           const | 
        
      
 
Returns the Node id referenced by the connector. 
 
 
◆ GetPointedEntityType()
      
        
          | type_detk Dtk_NodeConnector::GetPointedEntityType  | 
          ( | 
           | ) | 
           const | 
        
      
 
Retrieves the pointed entity Type. 
- Returns
 - The pointed entity Type. 
 
 
 
◆ GetPointingEntityType()
Retrieves the pointing entity FullType. Should be the FullType of the Dtk_Node containing the Dtk_NodeConnector. 
- Returns
 - The pointing entity FullType. 
 
 
 
◆ GetReasonLink()
Gets the Reason Link of the Dtk_NodeConnector to specify the reason of the connection. 
- Parameters
 - 
  
    | outReasonCategory | The Reason Category - processed from the ReasonLink -  | 
  
   
- Returns
 - The Reason Link. 
 
 
 
◆ GetSize()
Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh_face, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Entity, and Dtk_Info.
 
 
◆ GetSubEntities() [1/2]
Retrieves The connected SubEntities - IDs and types -. 
- Parameters
 - 
  
    | outEntitiesIDs | SubEntities Ids  | 
    | outEntitiesTypes | SubEntities types  | 
  
   
- Returns
 - DtkNoError if no error. 
 
 
 
◆ GetSubEntities() [2/2]
Retrieves the SubEntities array - defined by their IDs and Types -. 
- Parameters
 - 
  
    | outSubEntities | The resulting SubEntities array  | 
  
   
- Returns
 - DtkNoError if no error. 
 
 
 
◆ GetSubEntitiesNb()
      
        
          | Dtk_Size_t Dtk_NodeConnector::GetSubEntitiesNb  | 
          ( | 
           | ) | 
           const | 
        
      
 
Returns the number of the geometric entities. 
 
 
◆ ReasonCategoryEnumToString()
 1200         default:                                    
return L
"UnknownCategory";
 
 
 
 
◆ ReasonLinkEnumToString()
 1147           case SubPMI:                    
return L
"SubPMI";
 
 1150         case Support:                   
return L
"Support";
 
 1157         case Context:                   
return L
"Context";
 
 1174         default: 
return L
"Unknown";
 
 
 
 
◆ SetAssociatedComponentID()
      
        
          | void Dtk_NodeConnector::SetAssociatedComponentID  | 
          ( | 
          const Dtk_ID &  | 
          inComponentID | ) | 
           | 
        
      
 
 
◆ SetAssociatedPathComponentID()
      
        
          | void Dtk_NodeConnector::SetAssociatedPathComponentID  | 
          ( | 
          const Dtk_tab< Dtk_ID > &  | 
          inPathComponentID | ) | 
           | 
        
      
 
Sets the Path Component ID from Root to Target. 
 
 
◆ SetNodeId()
      
        
          | void Dtk_NodeConnector::SetNodeId  | 
          ( | 
          const Dtk_ID &  | 
          inNodeId | ) | 
           | 
        
      
 
 
◆ SetPointedEntityType()
      
        
          | void Dtk_NodeConnector::SetPointedEntityType  | 
          ( | 
          const type_detk  | 
          inPointedEntityType | ) | 
           | 
        
      
 
Sets the pointed entity Type. 
- Parameters
 - 
  
    | inPointedEntityType | The pointed entity Type.  | 
  
   
 
 
◆ SetPointingEntityType()
      
        
          | void Dtk_NodeConnector::SetPointingEntityType  | 
          ( | 
          const Dtk_Node::FullType  | 
          inPointingEntityType | ) | 
           | 
        
      
 
Sets the pointing entity Type. 
- Parameters
 - 
  
    | inPointingEntityType | The pointing entity Type.  | 
  
   
 
 
◆ SetReasonLink()
      
        
          | void Dtk_NodeConnector::SetReasonLink  | 
          ( | 
          const ReasonLinkEnum  | 
          inReasonLink | ) | 
           | 
        
      
 
Sets the Reason Link of the Dtk_NodeConnector to specify the reason of the connection. 
- Parameters
 - 
  
    | inReasonLink | The Reason Link  | 
  
   
 
 
◆ SetSubEntities() [1/2]
Returns the set of Additional Entities defined by their IDs and Types. 
- Parameters
 - 
  
    | inEntitiesIDs | SubEntities Ids  | 
    | inEntitiesTypes | SubEntities types  | 
  
   
- Returns
 - DtkNoError if no error. 
 
 
 
◆ SetSubEntities() [2/2]
Sets of SubEntities - defined by their IDs and Types -. 
- Parameters
 - 
  
    | inSubEntities | SubEntities array  | 
  
   
- Returns
 - DtkNoError if no error. 
 
 
 
◆ _Private
  
  
      
        
          | Dtk_Handle* Dtk_NodeConnector::_Private | 
         
       
   | 
  
protected   | 
  
 
 
◆ count_
  
  
      
        
          | unsigned long Dtk_Object::count_ | 
         
       
   | 
  
protectedinherited   | 
  
 
 
 
 
@ KeepOnlyFdt
Definition: dtk_maindoc.hpp:1089
 
@ Support
Definition: dtk_maindoc.hpp:1118
 
@ DTK_TYPE_NODE_CONNECTOR
Definition: define.h:485
 
@ VerticallyAligned
Definition: dtk_maindoc.hpp:1078
 
@ ThirdRefBlockSituation_1
Definition: dtk_maindoc.hpp:1108
 
@ StackedBelow
Definition: dtk_maindoc.hpp:1083
 
@ ForceHidden
Definition: dtk_maindoc.hpp:1086
 
@ ThirdRefBlockSituation_Common
Definition: dtk_maindoc.hpp:1107
 
@ AssociatedYDirection
Definition: dtk_maindoc.hpp:1121
 
@ FirstRefBlockSituation_3
Definition: dtk_maindoc.hpp:1096
 
@ AssociatedAxisSystem
Definition: dtk_maindoc.hpp:1119
 
@ StackedAbove
Definition: dtk_maindoc.hpp:1082
 
@ PlacementCategory
Definition: dtk_maindoc.hpp:1182
 
@ SecondRefBlockSituation_2
Definition: dtk_maindoc.hpp:1102
 
@ SecondRefBlockSituationCategory
Definition: dtk_maindoc.hpp:1187
 
@ DTK_TYPE_OBJECT
Definition: define.h:466
 
@ ThirdRefBlockSituation_3
Definition: dtk_maindoc.hpp:1110
 
@ AssociatedGeometry
Definition: dtk_maindoc.hpp:1113
 
@ Unknown
Definition: dtk_maindoc.hpp:1076
 
@ AssociatedCenterPoint
Definition: dtk_maindoc.hpp:1123
 
@ StackedRight
Definition: dtk_maindoc.hpp:1081
 
@ ThirdRefBlockSituation_2
Definition: dtk_maindoc.hpp:1109
 
@ Context
Definition: dtk_maindoc.hpp:1125
 
@ ForceClipped
Definition: dtk_maindoc.hpp:1088
 
@ HorizontallyAligned
Definition: dtk_maindoc.hpp:1079
 
@ FirstRefBlockSituationCategory
Definition: dtk_maindoc.hpp:1186
 
@ ThirdRefBlockSituationCategory
Definition: dtk_maindoc.hpp:1188
 
Dtk_NodeConnector()
Default constructor.
 
@ ForceVisible
Definition: dtk_maindoc.hpp:1087
 
@ PositionallyFixed
Definition: dtk_maindoc.hpp:1084
 
@ HighlightedGeometry
Definition: dtk_maindoc.hpp:1117
 
@ _typeID
Definition: dtk_object.hpp:10
 
@ VisibilityCategory
Definition: dtk_maindoc.hpp:1184
 
@ DefaultAnnotationLink
Definition: dtk_maindoc.hpp:1116
 
@ SecondRefBlockSituation_Common
Definition: dtk_maindoc.hpp:1100
 
@ SecondRefBlockSituation_3
Definition: dtk_maindoc.hpp:1103
 
@ GeneralAssociationCategory
Definition: dtk_maindoc.hpp:1183
 
@ FirstRefBlockSituation_Common
Definition: dtk_maindoc.hpp:1093
 
@ FirstRefBlockSituation_1
Definition: dtk_maindoc.hpp:1094
 
@ UnknownCategory
Definition: dtk_maindoc.hpp:1181
 
@ AssociatedZDirection
Definition: dtk_maindoc.hpp:1122
 
@ StackedLeft
Definition: dtk_maindoc.hpp:1080
 
@ _typeID
Definition: dtk_maindoc.hpp:1227
 
@ AssociatedXDirection
Definition: dtk_maindoc.hpp:1120
 
@ OrientationallyFixed
Definition: dtk_maindoc.hpp:1085
 
@ SecondRefBlockSituation_1
Definition: dtk_maindoc.hpp:1101
 
@ FirstRefBlockSituation_2
Definition: dtk_maindoc.hpp:1095
 
@ SubPMI
Definition: dtk_maindoc.hpp:1115
 
@ AssociatedFeature
Definition: dtk_maindoc.hpp:1114