This is the Dtk_NodeConnector Class.
.
More...
Data Structures | |
class | SubEntity |
Public Member Functions | |
Dtk_ErrorStatus | AddSubEntities (const Dtk_tab< SubEntity > &inSubEntities) |
Add a set of SubEntities - defined by their IDs and Types - to the SubEntities list. More... | |
Dtk_ErrorStatus | AddSubEntity (const SubEntity &inSubEntity) |
Add a SubEntity - defined by their IDs and Types - to the SubEntities list. More... | |
Dtk_Int32 | CheckAssociatedPathComponentID (const Dtk_MainDocPtr &inMainDocPtr) |
Checks if the Path Component ID exist into Dtk_MainDocPtr. More... | |
Dtk_Int32 | DtkDynamicType (const Dtk_Int32 &inId) |
Retrieves the dynamic entity type. More... | |
virtual int | DtkDynamicType (const int &inId)=0 |
virtual void | dump (FILE *file=stdout) |
type_detk | get_type_detk () const |
Dtk_ID | GetAssociatedComponentID () const |
Returns the Component ID referenced by the connector. More... | |
const Dtk_tab< Dtk_ID > & | GetAssociatedPathComponentID () const |
Returns the Path Component ID referenced by the connector from Root to Target. More... | |
void | GetAssociatedPathComponentID (Dtk_tab< Dtk_ID > &outAssociatedPathComponentID) const |
Dtk_ID | GetNodeId () const |
Returns the Node id referenced by the connector. More... | |
type_detk | GetPointedEntityType () const |
Retrieves the pointed entity Type. More... | |
Dtk_Node::FullType | GetPointingEntityType () const |
Retrieves the pointing entity FullType. Should be the FullType of the Dtk_Node containing the Dtk_NodeConnector. More... | |
Dtk_NodeConnector::ReasonLinkEnum | GetReasonLink (ReasonCategoryEnum &outReasonCategory) const |
Gets the Reason Link of the Dtk_NodeConnector to specify the reason of the connection. More... | |
virtual Dtk_Size_t | GetSize () const |
Dtk_ErrorStatus | GetSubEntities (Dtk_tab< Dtk_ID > &outEntitiesIDs, Dtk_tab< type_detk > &outEntitiesTypes) const |
Retrieves The connected SubEntities - IDs and types -. More... | |
Dtk_ErrorStatus | GetSubEntities (Dtk_tab< SubEntity > &outSubEntities) const |
Retrieves the SubEntities array - defined by their IDs and Types -. More... | |
Dtk_Size_t | GetSubEntitiesNb () const |
Returns the number of the geometric entities. More... | |
void | SetAssociatedComponentID (const Dtk_ID &inComponentID) |
Sets the component ID. More... | |
void | SetAssociatedPathComponentID (const Dtk_tab< Dtk_ID > &inPathComponentID) |
Sets the Path Component ID from Root to Target. More... | |
void | SetNodeId (const Dtk_ID &inNodeId) |
Sets the Node id. More... | |
void | SetPointedEntityType (const type_detk inPointedEntityType) |
Sets the pointed entity Type. More... | |
void | SetPointingEntityType (const Dtk_Node::FullType inPointingEntityType) |
Sets the pointing entity Type. More... | |
void | SetReasonLink (const ReasonLinkEnum inReasonLink) |
Sets the Reason Link of the Dtk_NodeConnector to specify the reason of the connection. More... | |
Dtk_ErrorStatus | SetSubEntities (const Dtk_tab< Dtk_ID > &inEntitiesIDs, const Dtk_tab< type_detk > &inEntitiesTypes) |
Returns the set of Additional Entities defined by their IDs and Types. More... | |
Dtk_ErrorStatus | SetSubEntities (const Dtk_tab< SubEntity > &inSubEntities) |
Sets of SubEntities - defined by their IDs and Types -. More... | |
Static Public Member Functions | |
static Dtk_NodeConnectorPtr | Create () |
Calls default constructor to allocate a new object. More... | |
static Dtk_NodeConnectorPtr | Create (const Dtk_NodeConnector &in) |
Calls copy constructor to allocate a new object. More... | |
static Dtk_NodeConnector * | DtkDynamicCast (Dtk_Object *s) |
Performs a dynamic cast - doesn't need RTTI -. More... | |
static Dtk_string | ReasonCategoryEnumToString (const ReasonCategoryEnum &inEnum) |
static Dtk_string | ReasonLinkEnumToString (const ReasonLinkEnum &inEnum) |
Protected Types | |
enum | { _typeID = DTK_TYPE_OBJECT } |
enum | { _typeID = DTK_TYPE_NODE_CONNECTOR } |
Protected Member Functions | |
void | _Copy (const Dtk_NodeConnector &s) |
void | _Init () |
void | _Reset () |
virtual Dtk_Object * | Clone () |
Dtk_NodeConnector () | |
Default constructor. More... | |
Dtk_NodeConnector (const Dtk_NodeConnector &in) | |
Copy constructor. More... | |
~Dtk_NodeConnector () | |
Destructor. More... | |
Protected Attributes | |
Dtk_Handle * | _Private |
unsigned long | count_ |
This is the Dtk_NodeConnector Class.
.
Reason - Type of the Dtk_NodeConnector -. It's used to filter connectors to same elements.
|
protected |
Default constructor.
|
protected |
Copy constructor.
in | Object to copy from. |
|
protected |
Destructor.
|
protected |
|
protected |
|
protected |
Dtk_ErrorStatus Dtk_NodeConnector::AddSubEntities | ( | const Dtk_tab< SubEntity > & | inSubEntities | ) |
Add a set of SubEntities - defined by their IDs and Types - to the SubEntities list.
inSubEntities | SubEntities array |
Dtk_ErrorStatus Dtk_NodeConnector::AddSubEntity | ( | const SubEntity & | inSubEntity | ) |
Dtk_Int32 Dtk_NodeConnector::CheckAssociatedPathComponentID | ( | const Dtk_MainDocPtr & | inMainDocPtr | ) |
Checks if the Path Component ID exist into Dtk_MainDocPtr.
Returns true if path connector exists else returns false
|
protectedvirtual |
|
static |
Calls default constructor to allocate a new object.
|
static |
Calls copy constructor to allocate a new object.
in | Object to copy from. |
|
static |
Performs a dynamic cast - doesn't need RTTI -.
Retrieves the dynamic entity type.
|
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.
|
virtualinherited |
type_detk Dtk_NodeConnector::get_type_detk | ( | ) | const |
Dtk_ID Dtk_NodeConnector::GetAssociatedComponentID | ( | ) | const |
Returns the Component ID referenced by the connector.
Returns the Path Component ID referenced by the connector from Root to Target.
void Dtk_NodeConnector::GetAssociatedPathComponentID | ( | Dtk_tab< Dtk_ID > & | outAssociatedPathComponentID | ) | const |
Dtk_ID Dtk_NodeConnector::GetNodeId | ( | ) | const |
Returns the Node id referenced by the connector.
type_detk Dtk_NodeConnector::GetPointedEntityType | ( | ) | const |
Retrieves the pointed entity Type.
Dtk_Node::FullType Dtk_NodeConnector::GetPointingEntityType | ( | ) | const |
Retrieves the pointing entity FullType. Should be the FullType of the Dtk_Node containing the Dtk_NodeConnector.
Dtk_NodeConnector::ReasonLinkEnum Dtk_NodeConnector::GetReasonLink | ( | ReasonCategoryEnum & | outReasonCategory | ) | const |
Gets the Reason Link of the Dtk_NodeConnector to specify the reason of the connection.
outReasonCategory | The Reason Category - processed from the ReasonLink - |
|
virtualinherited |
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.
Dtk_ErrorStatus Dtk_NodeConnector::GetSubEntities | ( | Dtk_tab< Dtk_ID > & | outEntitiesIDs, |
Dtk_tab< type_detk > & | outEntitiesTypes | ||
) | const |
Retrieves The connected SubEntities - IDs and types -.
outEntitiesIDs | SubEntities Ids |
outEntitiesTypes | SubEntities types |
Dtk_ErrorStatus Dtk_NodeConnector::GetSubEntities | ( | Dtk_tab< SubEntity > & | outSubEntities | ) | const |
Retrieves the SubEntities array - defined by their IDs and Types -.
outSubEntities | The resulting SubEntities array |
Dtk_Size_t Dtk_NodeConnector::GetSubEntitiesNb | ( | ) | const |
Returns the number of the geometric entities.
|
static |
|
static |
void Dtk_NodeConnector::SetAssociatedComponentID | ( | const Dtk_ID & | inComponentID | ) |
Sets the component ID.
Sets the Path Component ID from Root to Target.
void Dtk_NodeConnector::SetNodeId | ( | const Dtk_ID & | inNodeId | ) |
Sets the Node id.
void Dtk_NodeConnector::SetPointedEntityType | ( | const type_detk | inPointedEntityType | ) |
Sets the pointed entity Type.
inPointedEntityType | The pointed entity Type. |
void Dtk_NodeConnector::SetPointingEntityType | ( | const Dtk_Node::FullType | inPointingEntityType | ) |
Sets the pointing entity Type.
inPointingEntityType | The pointing entity Type. |
void Dtk_NodeConnector::SetReasonLink | ( | const ReasonLinkEnum | inReasonLink | ) |
Sets the Reason Link of the Dtk_NodeConnector to specify the reason of the connection.
inReasonLink | The Reason Link |
Dtk_ErrorStatus Dtk_NodeConnector::SetSubEntities | ( | const Dtk_tab< Dtk_ID > & | inEntitiesIDs, |
const Dtk_tab< type_detk > & | inEntitiesTypes | ||
) |
Returns the set of Additional Entities defined by their IDs and Types.
inEntitiesIDs | SubEntities Ids |
inEntitiesTypes | SubEntities types |
Dtk_ErrorStatus Dtk_NodeConnector::SetSubEntities | ( | const Dtk_tab< SubEntity > & | inSubEntities | ) |
Sets of SubEntities - defined by their IDs and Types -.
inSubEntities | SubEntities array |
|
protected |
|
protectedinherited |